PHP Class PathFinder_Location, atk4

Inheritance: extends AbstractModel
Show file Open project: atk4/atk4 Class Usage Examples

Public Properties

Property Type Description
$auto_track_element
$base_path All location would have a base_path defined.
$base_url Locations could have a URL defined, if location is exposed on-line.
$contents contains list of 'type'=>'subdir' which lists all the resources which can be found in this directory.
$is_cdn

Public Methods

Method Description
addRelativeLocation ( string $relative_path, array $contents = [] ) Adds a new location object which is relative to $this location.
defineContents ( array $contents )
getPath ( $file_path = null ) Returns how this location or file can be accessed through filesystem.
getURL ( $file_path = null ) Returns how this location or file can be accessed through web base url + relative path + file_path.
locate ( $type, $filename, $return = 'relative' )
setBasePath ( $path ) Set a new BasePath.
setBaseURL ( $url ) Set a new BaseURL.
setCDN ( $url )
setParent ( Pathfinder_Location $parent ) OBSOLETE - Compatiblity

Method Details

addRelativeLocation() public method

Adds a new location object which is relative to $this location.
public addRelativeLocation ( string $relative_path, array $contents = [] )
$relative_path string
$contents array

defineContents() public method

public defineContents ( array $contents )
$contents array

getPath() public method

Returns how this location or file can be accessed through filesystem.
public getPath ( $file_path = null )

getURL() public method

Returns how this location or file can be accessed through web base url + relative path + file_path.
public getURL ( $file_path = null )

locate() public method

public locate ( $type, $filename, $return = 'relative' )

setBasePath() public method

something like /home/web/public_html
public setBasePath ( $path )

setBaseURL() public method

something like /my/app
public setBaseURL ( $url )

setCDN() public method

public setCDN ( $url )

setParent() public method

OBSOLETE - Compatiblity
public setParent ( Pathfinder_Location $parent )
$parent Pathfinder_Location

Property Details

$auto_track_element public property

public $auto_track_element

$base_path public property

All location would have a base_path defined.
public $base_path

$base_url public property

Locations could have a URL defined, if location is exposed on-line.
public $base_url

$contents public property

contains list of 'type'=>'subdir' which lists all the resources which can be found in this directory.
public $contents

$is_cdn public property

public $is_cdn