Elgg  Version 3.0
Static Public Member Functions | List of all members
Elgg\Filesystem\Directory\Local Class Reference

Namespace for generating local filesystems. More...

Static Public Member Functions

static fromPath ($path)
 Shorthand for generating a new local filesystem. More...
 
static projectRoot ()
 Get the root composer install directory. More...
 
static elggRoot ()
 Get the Elgg root directory. More...
 

Detailed Description

Namespace for generating local filesystems.

Since
1.10.0

Definition at line 14 of file Local.php.

Member Function Documentation

static Elgg\Filesystem\Directory\Local::elggRoot ( )
static

Get the Elgg root directory.

Note
This is not the same as the project root! See projectRoot().
Returns
Directory

Definition at line 53 of file Local.php.

static Elgg\Filesystem\Directory\Local::fromPath (   $path)
static

Shorthand for generating a new local filesystem.

Parameters
string$pathAbsolute path to directory on local filesystem.
Returns
Directory

Definition at line 23 of file Local.php.

static Elgg\Filesystem\Directory\Local::projectRoot ( )
static

Get the root composer install directory.

Note
This is not the same as the Elgg root! In the Elgg 1.x series, Elgg was always at the install root, but as of 2.0, Elgg can be installed as a composer dependency, so you cannot assume that it is at the root anymore.
Returns
Directory

Definition at line 36 of file Local.php.


The documentation for this class was generated from the following file: