ResourceLoaderFilePath Class Reference

An object to represent a path to a JavaScript/CSS file, along with a remote and local base path, for use with ResourceLoaderFileModule. More...

Public Member Functions
	__construct ( $path, $localBasePath='', $remoteBasePath='')
	getLocalBasePath ()
	getLocalPath ()
	getPath ()
	getRemoteBasePath ()
	getRemotePath ()

Protected Attributes
string	$localBasePath
	Local base path.
string	$path
	Path to the file.
string	$remoteBasePath
	Remote base path.

Detailed Description

An object to represent a path to a JavaScript/CSS file, along with a remote and local base path, for use with ResourceLoaderFileModule.

Since

1.17

Definition at line 28 of file ResourceLoaderFilePath.php.

Constructor & Destructor Documentation

__construct()

ResourceLoaderFilePath::__construct	(		$path,
			$localBasePath = '',
			$remoteBasePath = ''
	)

Parameters

string	$path	Relative path to the file, no leading slash.
string	$localBasePath	Base path to prepend when generating a local path.
string	$remoteBasePath	Base path to prepend when generating a remote path. Should not have a trailing slash unless at web document root.

Definition at line 44 of file ResourceLoaderFilePath.php.

References $localBasePath, $path, and $remoteBasePath.

Member Function Documentation

getLocalBasePath()

ResourceLoaderFilePath::getLocalBasePath

(

)

Returns

string

Definition at line 72 of file ResourceLoaderFilePath.php.

References $localBasePath.

getLocalPath()

ResourceLoaderFilePath::getLocalPath

(

)

Returns

string

Definition at line 51 of file ResourceLoaderFilePath.php.

getPath()

ResourceLoaderFilePath::getPath

(

)

Returns

string

Definition at line 82 of file ResourceLoaderFilePath.php.

References $path.

getRemoteBasePath()

ResourceLoaderFilePath::getRemoteBasePath

(

)

Returns

string

Definition at line 77 of file ResourceLoaderFilePath.php.

References $remoteBasePath.

getRemotePath()

ResourceLoaderFilePath::getRemotePath

(

)

Returns

string

Definition at line 58 of file ResourceLoaderFilePath.php.

References $path.

Member Data Documentation

$localBasePath

string ResourceLoaderFilePath::$localBasePath

protected

Local base path.

Definition at line 30 of file ResourceLoaderFilePath.php.

Referenced by __construct(), and getLocalBasePath().

$path

string ResourceLoaderFilePath::$path

protected

Path to the file.

Definition at line 36 of file ResourceLoaderFilePath.php.

Referenced by __construct(), getPath(), and getRemotePath().

$remoteBasePath

string ResourceLoaderFilePath::$remoteBasePath

protected

Remote base path.

Definition at line 33 of file ResourceLoaderFilePath.php.

Referenced by __construct(), and getRemoteBasePath().

---

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

• includes/resourceloader/ResourceLoaderFilePath.php