Класс Folder

__construct()source public

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

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

Параметры

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

Путь к папке

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

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

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

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

_findRecursive()source protected

_findRecursive( string $pattern , boolean $sort = false )

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

Параметры

string $pattern

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

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

Сортировать результаты.

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

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

addPathElement()source public static

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

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

Параметры

строка $path

Путь

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

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

Возвращает

строку
Объединённый путь

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 deprecated

inCakePath( string $path = '' )

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

Устарело

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

Параметры

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

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

Возвращает

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

inPath()source public

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

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

Параметры

строка $path

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

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

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

Возвращает

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

Исключения

InvalidArgumentException
Когда переданный аргумент $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

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

Возвращает

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

messages()source public

messages( boolean $reset = true )

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

Параметры

boolean $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
Успех

normalizeFullPath()source public static

normalizeFullPath( string $path )

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

Параметры

строка $path

Путь для преобразования

Возвращает

строка
Путь с правильным набором слешей ("\" или "/")

normalizePath()source public static deprecated

normalizePath( string $path )

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

Устаревшее

3.7.0 Этот метод будет удален в 4.0.0. Используйте correctSlashFor() вместо него.

Параметры

строка $path

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

Возвращает

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

pwd()source public

pwd( )

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

Возвращает

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

read()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

realpath()source public

realpath( string $path )

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

Параметры

строка $path

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

Возвращает

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

slashTerm()source public static

slashTerm( string $path )

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

Параметры

строка $path

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

Возвращает

строка
Путь с окончательным слэшем

subdirectories()source public

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

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

Параметры

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

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

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

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

Возвращает

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

tree()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

[]

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

[]

0755

false