energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: FileSystemObject

Source Location: /framework/FileSystemObject.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --FileSystemObject

Абстрактный класс - модель объекта файловой системы


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Child classes:

DirectoryObject
Класс предназначенный для обработки набора FileObject
FileObject
Класс - модель файла

Inherited Constants

Inherited Variables

Inherited Methods

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
Абстрактный класс - модель объекта файловой системы



Tags:

author:   dr.Pavka
abstract:  


[ Top ]


Class Variables

$data =  null

[line 71]

Данные присоединенные к файлу



Tags:

access:   private

Type:   mixed


[ Top ]

$id =  false

[line 80]

Идентификатор записи, хранящей данные о папке в БД Может быть пустым



Tags:

access:   private

Type:   mixed


[ Top ]

$name =

[line 63]

Имя папки Если существует описание в БД - берется из нее, если нет. то из $this->path



Tags:

access:   private

Type:   string


[ Top ]

$path =

[line 55]

Полный путь к файлу



Tags:

access:   private

Type:   string


[ Top ]



Class Methods


static method getTypeInfo [line 169]

static string getTypeInfo( string $path)

Статический метод возвращающий тип файла



Tags:

access:   public


Parameters:

string   $path   path путь к файлу

[ Top ]

constructor __construct [line 87]

void __construct( )

Конструктор класса



Tags:

access:   public


Overridden in child classes as:

DirectoryObject::__construct()
Конструктор класса
FileObject::__construct()
Конструктор класса

Overrides DBWorker::__construct() (Конструктор класса.)

[ Top ]

method asArray [line 99]

array asArray( )

Возвращает объект в виде массива Если он не открыт, возвращается информация о самом объекте - иначе, о всех вложенных объектах



Tags:

access:   public


Overridden in child classes as:

DirectoryObject::asArray()
Возвращает объект в виде массива Если он не открыт, возвращается информация о самом объексте - иначе, о всех вложенных объектах

[ Top ]

method delete [line 199]

void delete( )

Удаление из БД записи о файле



Tags:

access:   public


Overridden in child classes as:

DirectoryObject::delete()
Удаление папки
FileObject::delete()
Удаление файла

[ Top ]

method getData [line 136]

mixed getData( )

Возвращает данные присоединенные к файлу



Tags:

access:   public


[ Top ]

method getPath [line 157]

string getPath( )

Возвращает путь



Tags:

access:   public


[ Top ]

method loadData [line 117]

void loadData( $path)

Загружает мета описание данных о объекте из БД



Tags:

access:   protected


Parameters:

   $path  

[ Top ]

method rename [line 210]

bool rename( $name)

Переименование файла/папки



Tags:

access:   public


Parameters:

   $name  

[ Top ]

method setData [line 146]

void setData( $data)

Устанавливает данные



Tags:

access:   public


Parameters:

   $data  

[ Top ]


Class Constants

IS_FILE =  2

[line 38]

Файл


[ Top ]

IS_FOLDER =  0

[line 28]

Файл является папкой


[ Top ]

IS_IMAGE =  1

[line 33]

Файл - изображение


[ Top ]

IS_ZIP =  3

[line 42]

Zip файл


[ Top ]

TABLE_NAME =  'share_uploads'

[line 48]

Имя таблицы в которой хранится мета описания папки


[ Top ]


В создании документации нам помог: phpDocumentor