1. class
  2. SilverStripe
  3. \
  4. Assets
  5. \
  6. Filesystem

Filesystem

class Filesystem

A collection of static methods for manipulating the filesystem.

Traits

Configurable
Provides extensions to this object to integrate it with standard config API methods.

Config options

file_create_mask integer
folder_create_mask integer

Methods

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

from Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from Configurable
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from Configurable
static 
makeFolder(String $folder)

Create a folder on the filesystem, recursively.

static 
removeFolder(String $folder, Boolean $contentsOnly = false)

Remove a directory and all subdirectories and files.

static boolean
remove_folder_if_empty(string $folder, boolean $recursive = true)

Remove a directory, but only if it is empty.

fixfiles() deprecated

Cleanup function to reset all the Filename fields. Visit File/fixfiles to call.

static string
folderModTime(string $folder, array $extensionList = null)

Return the most recent modification time of anything in the folder.

static Boolean
isAbsolute(String $filename)

Returns true if the given filename is an absolute file reference.

Details

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 43
static makeFolder(String $folder)

Create a folder on the filesystem, recursively.

Uses {@link Filesystem::$folder_create_mask} to set filesystem permissions. Use {@link Folder::findOrMake()} to create a {@link Folder} database record automatically.

Parameters

String $folder Absolute folder path

at line 60
static removeFolder(String $folder, Boolean $contentsOnly = false)

Remove a directory and all subdirectories and files.

Parameters

String $folder Absolute folder path
Boolean $contentsOnly If this is true then the contents of the folder will be removed but not the folder itself

at line 89
static boolean remove_folder_if_empty(string $folder, boolean $recursive = true)

Remove a directory, but only if it is empty.

Parameters

string $folder Absolute folder path
boolean $recursive Remove contained empty folders before attempting to remove this one

Return Value

boolean True on success, false on failure.

at line 115
fixfiles() deprecated

deprecated 5.0

Cleanup function to reset all the Filename fields. Visit File/fixfiles to call.

at line 138
static string folderModTime(string $folder, array $extensionList = null)

Return the most recent modification time of anything in the folder.

Parameters

string $folder The folder, relative to the site root
array $extensionList An option array of file extensions to limit the search to

Return Value

string Same as filemtime() format.

at line 176
static Boolean isAbsolute(String $filename)

Returns true if the given filename is an absolute file reference.

Works on Linux and Windows.

Parameters

String $filename Absolute or relative filename, with or without path.

Return Value

Boolean