TYPO3\CMS\Core\Resource\LocalPath Class Reference

Public Member Functions
	__construct (string $value, int $type)
string	getRaw ()
string null	getRelative ()
string	getAbsolute ()
	isAbsolute ()
	isRelative ()

Public Attributes
const	TYPE_ABSOLUTE = 1
const	TYPE_RELATIVE = 2

Protected Attributes
string	$raw
string	$relative = null
string	$absolute
int	$type

Detailed Description

Model representing an absolute or relative path in the local file system

Definition at line 27 of file LocalPath.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Resource\LocalPath::__construct	(	string	$value,
		int	$type
	)

Definition at line 37 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\$type, TYPO3\CMS\Core\Utility\PathUtility\getCanonicalPath(), and TYPO3\CMS\Core\Core\Environment\getPublicPath().

Member Function Documentation

getAbsolute()

string TYPO3\CMS\Core\Resource\LocalPath::getAbsolute

(

)

Returns

‪string (calculated) absolute path

Definition at line 81 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\$absolute.

getRaw()

string TYPO3\CMS\Core\Resource\LocalPath::getRaw

(

)

Returns

‪string normalized path as provided

Definition at line 65 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\$raw.

getRelative()

string null TYPO3\CMS\Core\Resource\LocalPath::getRelative

(

)

Returns

‪string|null (calculated) relative path to public path - null if outside public path

Definition at line 73 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\$relative.

isAbsolute()

TYPO3\CMS\Core\Resource\LocalPath::isAbsolute

(

)

Definition at line 86 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\TYPE_ABSOLUTE.

isRelative()

TYPO3\CMS\Core\Resource\LocalPath::isRelative

(

)

Definition at line 91 of file LocalPath.php.

References TYPO3\CMS\Core\Resource\LocalPath\TYPE_RELATIVE.

Member Data Documentation

$absolute

string TYPO3\CMS\Core\Resource\LocalPath::$absolute

protected

Definition at line 34 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\getAbsolute().

$raw

string TYPO3\CMS\Core\Resource\LocalPath::$raw

protected

Definition at line 32 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\getRaw().

$relative

string TYPO3\CMS\Core\Resource\LocalPath::$relative = null

protected

Definition at line 33 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\getRelative().

$type

int TYPO3\CMS\Core\Resource\LocalPath::$type

protected

Definition at line 35 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\__construct().

TYPE_ABSOLUTE

const TYPO3\CMS\Core\Resource\LocalPath::TYPE_ABSOLUTE = 1

Definition at line 29 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\isAbsolute().

TYPE_RELATIVE

const TYPO3\CMS\Core\Resource\LocalPath::TYPE_RELATIVE = 2

Definition at line 30 of file LocalPath.php.

Referenced by TYPO3\CMS\Core\Resource\LocalPath\isRelative(), and TYPO3\CMS\Core\Tests\Unit\Resource\StorageRepositoryTest\storageDetectionDataProvider().