Location Class Reference

Inheritance diagram for Location:

Public Member Functions
	rule ($mask, $path, $version=null, $format=null)
	Add a rule. More...
	rewrite ($url)
	Rewrite a location according to the rules. More...
Public Member Functions inherited from Component
	__construct ($fred, $config=null)
	__destruct ()
	clientConfig ()
	Public configuration. More...
	config ($key, $default=null)
	Retrieve a config value. More...
	ping ()
	Ping function. More...
	filemtime ($filename)
	Filemtime with session cache. More...
	component ($name)
	Get a component (local or default). More...
	components (... $names)
	Get multiple components in an array. More...
Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...
	constants ($prefix=null)
	Return all constants. More...
	get ($key)
	Get one or more properties. More...
	set ($key, $value=null)
	Set one or more properties. More...
	__get ($key)
	__set ($key, $value)

Data Fields
	$rules = []
	Location rules (key = mask, value = array with path, version, and format - all optional). More...
	$version = null
	Default version (empty = FRED™ version). More...
	$format = '[full]?v=[version]'
	Default version format ([full] or [base] and [ext], and [version] are replaced). More...
Data Fields inherited from Component
	$filemtimeTtl = 0
Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...
const	READABLE = 1
	Property is readable. More...
const	WRITEABLE = 2
	Property is writeable. More...
const	READWRITE = 3
	Property is readable and writeable. More...

Protected Member Functions
	init ()
Protected Member Functions inherited from Component
	init ()
	done ()
	getSession ()
Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...
	configure ($config)
	Configure the object. More...
	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...
	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Additional Inherited Members
Protected Attributes inherited from Component
	$_fred = null
	$_config = null
	$_name = null
	$_components = []
	Local components (key = component name, value = component). More...
	$_session = null
Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

Detailed Description

Definition at line 5 of file Location.php.

Member Function Documentation

init()

init ( )

protected

Definition at line 11 of file Location.php.

rewrite()

rewrite

(

$url

)

Rewrite a location according to the rules.

Parameters

string

$url

Base/default location.

Returns

string Rewritten location.

Definition at line 30 of file Location.php.

rule()

rule	(		$mask,
			$path,
			$version = null,
			$format = null
	)

Add a rule.

Parameters

string	$mask	Location mask (case insensitive prefix or regex) for locations that should follow this rule.
string	$path	Path for this type (replaces the last capturing group of the mask, or complete match if no group).
string	$version	Default version for this type.
string	$format	Filename format ([full] or [base] and [ext], and [version] are replaced).

Definition at line 22 of file Location.php.

Field Documentation

$format

$format = '[full]?v=[version]'

Default version format ([full] or [base] and [ext], and [version] are replaced).

Definition at line 9 of file Location.php.

$rules

$rules = []

Location rules (key = mask, value = array with path, version, and format - all optional).

Definition at line 7 of file Location.php.

$version

$version = null

Default version (empty = FRED™ version).

Definition at line 8 of file Location.php.

---

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

• /var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Location.php