Класс Folder

__constructsource public

__construct( string|null $path null , boolean $create false , integer|boolean $mode false )

Конструктор.

Параметры

string|null $path необязательно null

Путь к папке

boolean $create необязательно false

Создать папку, если она не найдена

integer|boolean $mode необязательно false

Режим (CHMOD) для применения к созданной папке, false — игнорировать

_findRecursivesource protected

_findRecursive( string $pattern , boolean $sort false )

Вспомогательная функция для findRecursive.

Параметры

string $pattern

Шаблон для сопоставления

boolean $sort необязательно false

Требуется ли сортировка результатов.

Возвращаемое значение

array
Файлы, соответствующие шаблону

addPathElementsource public static

addPathElement( string $path , string|array $element )

Возвращает $path с добавленным $element, с правильным слешем между ними.

Параметры

string $path

Путь

string|array $element

Элемент для добавления в конец пути

Возвращаемое значение

string
Объединённый путь

cdsource public

cd( string $path )

Изменить текущую папку на $path.

Параметры

string $path

Путь к каталогу, на который необходимо перейти

Возвращаемое значение

string
Новый путь. Возвращает false при ошибке

chmodsource public

chmod( string $path , integer|boolean $mode false , boolean $recursive true , array $exceptions [] )

Рекурсивно изменить режим каталога. Это включает изменение режима и для файлов.

Параметры

string $path

Путь для изменения режима.

integer|boolean $mode необязательно false

Восьмеричное значение, например, 0755.

boolean $recursive необязательно true

Рекурсивно изменить режим, установить в false, чтобы изменить только текущую папку.

array $exceptions необязательно []

Массив файлов, папок для пропуска.

Возвращаемое значение

boolean
Успех.

copysource public

copy( array|string $options )

Рекурсивное копирование каталога.

Параметры

• to Каталог для копирования.
• from Каталог для копирования, это вызовет cd(), изменив результаты pwd().
• mode Режим копирования файлов/каталогов в виде целого числа, например, 0775.
• skip Файлы/каталоги для пропуска.
• scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIP
• recursive Требуется ли рекурсивное копирование (по умолчанию: true — рекурсивно)

Параметры

array|string $options

Либо массив параметров (см. выше), либо строка назначения каталога.

Возвращаемое значение

boolean
Успех.

correctSlashForsource public static

correctSlashFor( string $path )

Возвращает правильный набор слешей для данного $path. (\ для путей Windows и / для других путей.)

Параметры

string $path

Путь для проверки

Возвращаемое значение

string
Набор слешей ("\\" или "/")

createsource public

create( string $pathname , integer $mode false )

Рекурсивно создать структуру каталогов.

Может использоваться для создания глубоких структур путей, таких как /foo/bar/baz/shoe/horn

Параметры

string $pathname

Структура каталога для создания. Абсолютный или относительный путь. Если путь является относительным и существует в cwd процесса, он не будет создан. В противном случае относительные пути будут добавлены к текущему pwd().

integer $mode необязательно false

восьмеричное значение 0755

Возвращаемое значение

boolean
Возвращает TRUE при успехе, FALSE при ошибке

deletesource public

delete( string|null $path null )

Рекурсивно удалить каталоги, если система позволяет.

Параметры

string|null $path необязательно null

Путь к каталогу для удаления

Возвращаемое значение

boolean
Успех

dirsizesource public

dirsize( )

Возвращает размер в байтах этой папки и её содержимого.

Возвращаемое значение

integer
Размер в байтах текущей папки

errorssource public

errors( boolean $reset true )

Получить ошибку последнего метода

Параметры

boolean $reset необязательно true

Сбросить стек ошибок после чтения

Возвращаемое значение

array
массив

findsource public

find( string $regexpPattern '.*' , boolean $sort false )

Возвращает массив всех соответствующих файлов в текущем каталоге.

Параметры

string $regexpPattern необязательно '.*'

Шаблон preg_match (По умолчанию: .*)

boolean $sort необязательно false

Требуется ли сортировка результатов.

Возвращаемое значение

array
Файлы, соответствующие заданному шаблону

findRecursivesource public

findRecursive( string $pattern '.*' , boolean $sort false )

Возвращает массив всех соответствующих файлов в текущем и нижестоящих каталогах.

Параметры

string $pattern необязательно '.*'

Шаблон preg_match (По умолчанию: .*)

boolean $sort необязательно false

Требуется ли сортировка результатов.

Возвращаемое значение

array
Файлы, соответствующие шаблону $pattern

inCakePathsource public

inCakePath( string $path '' )

Возвращает true, если файл находится в заданном CakePath.

Параметры

string $path необязательно ''

Путь для проверки.

Возвращаемое значение

boolean
bool

inPathsource public

inPath( string $path '' , boolean $reverse false )

Возвращает true, если файл находится в заданном пути.

Параметры

string $path необязательно ''

Путь для проверки, что текущий pwd() находится внутри него.

boolean $reverse необязательно false

Инвертировать поиск, проверить, что pwd() находится внутри $path.

Возвращаемое значение

boolean
bool

isAbsolutesource public static

isAbsolute( string $path )

Возвращает true, если заданный $path — абсолютный путь.

Параметры

string $path

Путь для проверки

Возвращаемое значение

boolean
true, если путь абсолютный.

isRegisteredStreamWrappersource public static

isRegisteredStreamWrapper( string $path )

Возвращает true, если заданный $path — зарегистрированный обработчик потоков.

Параметры

string $path

Путь для проверки

Возвращаемое значение

boolean
True, если путь зарегистрированный обработчик потоков.

isSlashTermsource public static

isSlashTerm( string $path )

Возвращает true, если заданный $path оканчивается на слэш (т.е. заканчивается слэшем).

Параметры

string $path

Путь для проверки

Возвращаемое значение

boolean
true, если путь оканчивается на слэш, иначе false

isWindowsPathsource public static

isWindowsPath( string $path )

Возвращает true, если заданный $path — путь Windows.

Параметры

string $path

Путь для проверки

Возвращаемое значение

boolean
true, если путь Windows, иначе false

messagessource public

messages( boolean $reset true )

Получить сообщения из последнего метода.

Параметры

boolean $reset необязательно true

Сбросить стек сообщений после чтения

Возвращаемое значение

array
array

movesource public

move( array|string $options )

Рекурсивное перемещение каталога.

Параметры

• to Каталог для перемещения.
• from Каталог, откуда перемещать, вызовет cd(), изменяя результат pwd().
• chmod Режим, с которым перемещаются файлы/каталоги.
• skip Файлы/каталоги для пропуска.
• scheme Folder::MERGE, Folder::OVERWRITE, Folder::SKIP
• recursive Рекурсивное перемещение или нет (по умолчанию: true - рекурсивно)

Параметры

array|string $options

(to, from, chmod, skip, scheme)

Возвращаемое значение

boolean
Успех

normalizePathsource public static

normalizePath( string $path )

Возвращает правильный набор слэшей для заданного $path. (\\ для путей Windows и / для других путей.)

Параметры

string $path

Путь для проверки

Возвращаемое значение

string
Набор слэшей ("\\" или "/")

pwdsource public

pwd( )

Возвращает текущий путь.

Возвращает

string
Текущий путь

readsource public

read( boolean $sort true , array|boolean $exceptions false , boolean $fullPath false )

Возвращает массив содержимого текущей директории. Возвращаемый массив содержит два массива: один для директорий и один для файлов.

Параметры

boolean $sort необязательно true

Определяет, нужно ли сортировать результаты. Установите это и свойство sort в false, чтобы получить несортированные результаты.

array|boolean $exceptions необязательно false

Массив или boolean true не будут извлекать файлы и папки с точками.

boolean $fullPath необязательно false

True возвращает полный путь.

Возвращает

array
Массив содержимого текущей директории, пустой массив при ошибке

realpathsource public

realpath( string $path )

Получает реальный путь (учитывая "..", и т.п.)

Параметры

string $path

Путь для разрешения

Возвращает

string
Разрешенный путь

slashTermsource public static

slashTerm( string $path )

Возвращает $path с добавленной заключительной косой чертой (исправлено для Windows и других ОС).

Параметры

string $path

Путь для проверки

Возвращает

string
Путь с заключительной косой чертой

treesource public

tree( string|null $path null , array|boolean $exceptions false , string|null $type null )

Возвращает массив вложенных директорий и файлов в каждой директории.

Параметры

string|null $path необязательно null

путь к директории для построения дерева

array|boolean $exceptions необязательно false

Массив исключаемых файлов/папок или boolean true для исключения файлов и папок с точками.

string|null $type необязательно null

либо 'file', либо 'dir'. Null возвращает и файлы, и директории

Возвращает

array
Массив вложенных директорий и файлов в каждой директории

[]

[]

0755

null

false