Класс 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, если директория находится в заданном пути 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

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

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

логическое
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 — рекурсивно)

Параметры

array|string $options

(to, from, chmod, skip, scheme)

Возвращает

boolean
Успех

normalizePath()source public static

normalizePath( string $path )

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

Параметры

string $path

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

Возвращает

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

pwd()source public

pwd( )

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

Возвращает

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

read()source public

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

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

Параметры

string|boolean $sort optional self::SORT_NAME

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

array|boolean $exceptions optional false

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

boolean $fullPath optional false

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

Возвращает

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

realpath()source public

realpath( string $path )

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

Параметры

string $path

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

Возвращает

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

slashTerm()source public static

slashTerm( string $path )

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

Параметры

string $path

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

Возвращает

string
Путь с конечным слешем

subdirectories()source public

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

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

Параметры

string|null $path optional null

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

boolean $fullPath optional true

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

Возвращает

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

tree()source public

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

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

Параметры

string|null $path optional null

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

array|boolean $exceptions optional false

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

string|null $type optional null

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

Возвращает

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

[]

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

[]

0755

null

false