Класс Folder

__construct()source 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 для игнорирования

_findRecursive()source protected

_findRecursive( string $pattern , boolean $sort false )

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

Параметры

string $pattern

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

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

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

Возвращает

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

addPathElement()source public static

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

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

Параметры

string $path

Путь

string|array $element

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

Возвращает

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

cd()source public

cd( string $path )

Изменить директорию на $path.

Параметры

строка $path

Путь к директории, на которую нужно перейти

Возвращает

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

chmod()source public

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

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

Параметры

строка $path

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

целое число/логическое значение $mode необязательно false

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

логическое значение $recursive необязательно true

Изменить права доступа рекурсивно, установите в значение false, чтобы изменить права доступа только текущего каталога.

массив $exceptions необязательно []

Массив файлов и каталогов, которые нужно пропустить.

Возвращает

логическое значение
Успешно.

copy()source public

copy( array|string $options )

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

Параметры

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

Параметры

массив/строка $options

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

Возвращает

логическое значение
Успешно.

correctSlashFor()source public static

correctSlashFor( string $path )

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

Параметры

строка $path

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

Возвращает

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

create()source public

create( string $pathname , integer|boolean $mode false )

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

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

Параметры

строка $pathname

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

целое число/логическое значение $mode необязательно false

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

Возвращает

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

delete()source public

delete( string|null $path null )

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

Параметры

строка/null $path необязательно null

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

Возвращает

логическое значение
Успешно

dirsize()source public

dirsize( )

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

Возвращает

целое число
Размер в байтах текущего каталога

errors()source public

errors( boolean $reset true )

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

Параметры

логическое значение $reset необязательно true

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

Возвращает

массив

find()source public

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

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

Параметры

строка $regexpPattern необязательно '.*'

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

логическое значение $sort необязательно false

Нужно ли сортировать результаты.

Возвращает

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

findRecursive()source public

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

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

Параметры

строка $pattern необязательно '.*'

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

логическое значение $sort необязательно false

Нужно ли сортировать результаты.

Возвращает

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

inCakePath()source public

inCakePath( string $path '' )

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

Устаревшее

3.2.12 Этот метод будет удален в версии 4.0.0. Используйте вместо него inPath().

Параметры

строка $path необязательно ''

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

Возвращает

логическое значение

inPath()source public

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

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

Параметры

строка $path необязательно ''

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

логическое значение $reverse необязательно false

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

Возвращает

логическое значение

isAbsolute()source public static

isAbsolute( string $path )

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

Параметры

строка $path

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

Возвращает

логическое значение
true, если путь является абсолютным.

isRegisteredStreamWrapper()source public static

isRegisteredStreamWrapper( string $path )

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

Параметры

строка $path

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

Возвращает

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

isSlashTerm()source public static

isSlashTerm( string $path )

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

Параметры

строка $path

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

Возвращает

логическое значение
true, если путь заканчивается слешем, иначе false

isWindowsPath()source public static

isWindowsPath( string $path )

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

Параметры

строка $path

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

Возвращает

логическое значение
true, если путь Windows, иначе false

messages()source public

messages( boolean $reset true )

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

Параметры

логическое значение $reset необязательно true

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

Возвращает

массив

move()source public

move( array|string $options )

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

Параметры

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

Параметры

массив|строка $options

(to, from, chmod, skip, scheme)

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

boolean
Успех

normalizePath()source public static

normalizePath( string $path )

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

Параметры

строка $path

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

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

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

pwd()source public

pwd( )

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

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

строка
Текущий путь

read()source public

read( string|boolean $sort self::SORT_NAME , array|boolean $exceptions false , boolean $fullPath false )

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

Параметры

строка|логическое значение $sort необязательно self::SORT_NAME

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

массив|логическое значение $exceptions необязательно false

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

логическое значение $fullPath необязательно false

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

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

массив
Содержимое текущей директории в виде массива, пустой массив при неудаче

realpath()source public

realpath( string $path )

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

Параметры

строка $path

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

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

строка
Разрешенный путь

slashTerm()source public static

slashTerm( string $path )

Возвращает $path с добавленным завершающим слэшем (исправлено для Windows или других ОС).

Параметры

строка $path

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

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

строка
Путь с завершающим слэшем

subdirectories()source public

subdirectories( string|null $path null , boolean $fullPath true )

Возвращает массив подкаталогов для предоставленного или текущего пути.

Параметры

строка|null $path необязательно null

Путь к директории для получения подкаталогов.

логическое значение $fullPath необязательно true

Возвращать полный путь или только имя директории.

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

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

tree()source public

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

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

Параметры

строка|null $path необязательно null

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

массив|логическое значение $exceptions необязательно false

Массив файлов/каталогов для исключения или boolean true, чтобы не брать файлы/каталоги с точкой

строка|null $type необязательно null

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

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

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

[]

[
    self::SORT_NAME => 'getPathname',
    self::SORT_TIME => 'getCTime'
]

[]

0755

null

false