PHPBoost Framework A.P.I.

Folder

Package: IO\Filesystem Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Nicolas Duhamel akhenathon2@gmail.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 2.0 - 2008 07 06 Contributor: Loic ROUCHON horn@phpboost.com Contributor: Benoit SAUTEL ben.popeye@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: io/filesystem/Folder.class.php

This class allows you to handle very easily a folder on the server.

FileSystemElement

Folder

Methods summary
`public`	# `__construct( string $path )` Builds a Folder object. Builds a Folder object. Parameters `$path` Path of the folder. Overrides `FileSystemElement::__construct()`
`public boolean`	# `create( )` Returns true if the folder exists after this call, else, false Returns true if the folder exists after this call, else, false Returns boolean true if the folder exists after this call, else, false
`public File[]`	# `get_files( string $regex = '', boolean $regex_exclude_files = false )` Lists the files contained in this folder. Lists the files contained in this folder. Parameters `$regex` PREG which describes the pattern the files you want to list must match. If you want all of them, don't use this parameter. `$regex_exclude_files` true if the regex to exclude files Returns `File[]` The files list.
`public Folder[]`	# `get_folders( string $regex = '' )` Lists the folders contained in this folder. Lists the folders contained in this folder. Parameters `$regex` PREG which describes the pattern the folders you want to list must match. If you want all of them, don't use this parameter. Returns `Folder[]` The folders list.
`public Folder`	# `get_first_folder( )` Returns the first folder present in this folder Returns the first folder present in this folder Returns `Folder` The first folder of this folder or null if it doesn't contain any folder.
`public FileSystemElement[]`	# `get_all_content( )` Returns all the file system elements contained by the folder. Returns all the file system elements contained by the folder. Returns `FileSystemElement[]` The list of the file system element contained in this folder.
`public True`	# `delete( )` Deletes the folder and all what it contains. Deletes the folder and all what it contains. Returns True if deleted successfully.
`public integer`	# `get_last_modification_date( )` Returns the date of the last modification of the folder. Returns the date of the last modification of the folder. Returns integer The UNIX timestamp corresponding to the last modification date.

Methods inherited from FileSystemElement
`change_chmod(), exists(), get_name(), get_path(), get_path_from_root(), is_writable()`

Properties inherited from FileSystemElement
`$path`

Parameters

Overrides

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns