Class: DirectoryObject

Source Location: /framework/DirectoryObject.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --FileSystemObject
         |
         --DirectoryObject

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

Author(s):

dr.Pavka

Variables

Methods

Inherited Constants

Class: FileSystemObject

FileSystemObject::IS_FILE
FileSystemObject::IS_FOLDER
FileSystemObject::IS_IMAGE
FileSystemObject::IS_ZIP
FileSystemObject::TABLE_NAME

Class: Object

Object::CONFIG_DIR
Object::CONFIG_FILE

Inherited Variables

Inherited Methods

Class: FileSystemObject

FileSystemObject::__construct(): Конструктор класса
FileSystemObject::asArray(): Возвращает объект в виде массива Если он не открыт, возвращается информация о самом объекте - иначе, о всех вложенных объектах
FileSystemObject::delete(): Удаление из БД записи о файле
FileSystemObject::getData(): Возвращает данные присоединенные к файлу
FileSystemObject::getPath(): Возвращает путь
FileSystemObject::getTypeInfo(): Статический метод возвращающий тип файла
FileSystemObject::loadData(): Загружает мета описание данных о объекте из БД
FileSystemObject::rename(): Переименование файла/папки
FileSystemObject::setData(): Устанавливает данные

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 24]
Класс предназначенный для обработки набора FileObject

Tags:

author:

dr.Pavka

[ Top ]

Class Variables

$dirHandle = null

[line 31]

Directory handle

Tags:

access:

private

Type:

resource

[ Top ]

$files = array()

[line 39]

Массив файлов

Tags:

access:

private

Type:

array

[ Top ]

$iterator = 0

[line 47]

Текущий ключ

Tags:

access:

private

Type:

int

[ Top ]

Class Methods

static method loadFrom [line 67]

static DirectoryObject loadFrom(
string
$path)

Статический метод загрузки возвращающий self

Tags:

access:

public

Parameters:

string

$path

путь к файлу

[ Top ]

constructor __construct [line 54]

void __construct(
)

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

Tags:

access:

public

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

[ Top ]

destructor __destruct [line 86]

void __destruct(
)

Деструктор закрывает открытый ресурс

Tags:

access:

public

[ Top ]

method asArray [line 224]

array asArray(
)

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

Tags:

access:

public

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

[ Top ]

method create [line 125]

boolean create(
array
$data)

Создание папки

Tags:

access:

public

Parameters:

array

$data

данные папки

[ Top ]

method current [line 190]

mixed current(
)

Возвращает текущий объект

Tags:

access:

public

[ Top ]

method delete [line 155]

boolean delete(
)

Удаление папки

Tags:

access:

public

Overrides FileSystemObject::delete() (Удаление из БД записи о файле)

[ Top ]

method key [line 201]

int key(
)

Возворащает ключ текущего объекта

Tags:

access:

public

[ Top ]

method next [line 168]

type next(
)

Переходит к следующему объекту

Tags:

access:

public

[ Top ]

method open [line 99]

void open(
)

Открывает директорию

Tags:

access:

public

[ Top ]

method rewind [line 179]

void rewind(
)

Перемещается на первый єлемент

Tags:

access:

public

[ Top ]

method sortFileNames [line 246]

int sortFileNames(

$current, 
$next)

Сортировка содержимого папки по алфавиту

Tags:

access:

private

Parameters:

	$current
	$next

[ Top ]

method valid [line 212]

boolean valid(
)

Проверяет существует ли текущий елемент

Tags:

access:

public

[ Top ]

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