Класс 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 )

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

Параметры

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

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 )

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

Параметры

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

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

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

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

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

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

Возвращает

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

realpath()source public

realpath( string $path )

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

Параметры

строка $path

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

Возвращает

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

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