Class FileSystemElement

Summary

abstract
File
Package hierarchy IO\Filesystem
Class hierarchy \FileSystemElement

package
IO
subpackage
Filesystem
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Nicolas Duhamel akhenathon2@gmail.com
version
PHPBoost 6.0 - last update: 2018 11 07
since
PHPBoost 2.0 - 2008 07 06
contributor
Loic ROUCHON horn@phpboost.com
contributor
Julien BRISWALTER j1.seth@phpboost.com
contributor
Arnaud GENET elenwii@phpboost.com
contributor
ph-7 me@ph7.me

This class represents any file system element.

Methods

exists()

exists() : boolean

Allows you to know if the file system element exists.

Returns

boolean —

True if the file exists, else, false.

Inherited from \FileSystemElement

Tags

None found

get_path()

get_path() : string

Returns the element full path.

Returns

string —

The element full path.

Inherited from \FileSystemElement

Tags

None found

get_path_from_root()

get_path_from_root() : string

Returns the element path from the phpboost root.

Returns

string —

The element from the phpboost root.

Inherited from \FileSystemElement

Tags

None found

get_name()

get_name() : string

Returns the element name.

Returns

string —

The element name.

Inherited from \FileSystemElement

Tags

None found

is_writable()

is_writable(boolean $force_chmod = false) : true

Returns true if the file or the folder is writable.

Parameters

boolean

$force_chmod

If true, then, chmod will be forced to 777 if not writable.

Returns

true —

if the file or the folder is writable.

Inherited from \FileSystemElement

Tags

None found

change_chmod()

change_chmod(integer $chmod) : true

Changes the chmod of the element.

Parameters

integer

$chmod

The new chmod of the file. Put a 0 at the begening of the number to indicate to the PHP parser that it's an octal value.

Returns

true —

if the chmod has been successfully changed.

Inherited from \FileSystemElement

Tags

None found

delete()

delete()

abstract

Inherited from \FileSystemElement

Tags

None found

__construct()

__construct(string $path)

Builds a FileSystemElement object from the path of the element.

Parameters

string

$path

Path of the element

Inherited from \FileSystemElement

Tags

None found

Properties

$path

$path : string

string — Path of the file system element

Tags

None found