Docs For Class jSignificantUrlsCompiler

Description

Implements interfaces:

jISimpleCompiler

Compiler for significant url engine

Located in /plugins/urls/significant/jSignificantUrlsCompiler.class.php (line 52)

Variable Summary

mixed $checkHttps

mixed $createUrlContent

mixed $createUrlInfos

mixed $defaultUrl

mixed $entryPoints

mixed $modulesPath

mixed $modulesRepositories

mixed $parseInfos

mixed $requestType

mixed $typeparam

Method Summary

void appendUrlInfo (significantUrlInfoParsing $u, string $path, $secondaryAction)

void compile ( $aSelector)

string extractDynamicParams (simpleXmlElement $url, string $regexppath, significantUrlInfoParsing $u)

void getEntryPointConfig ( $entrypoint)

void newHandler (significantUrlInfoParsing $u, simpleXmlElement $url, [ $pathinfo = ''])

void readInclude (simpleXmlElement $url, significantUrlInfoParsing $uInfo)

void readProjectXml ()

void retrieveModulePaths (string $configFile)

Variables

mixed $checkHttps = true (line 59)

access: protected

mixed $createUrlContent (line 58)

access: protected

mixed $createUrlInfos (line 57)

access: protected

mixed $defaultUrl (line 55)

access: protected

mixed $entryPoints = array() (line 328)

list all entry points and their config

access: protected

mixed $modulesPath = array() (line 338)

list all modules path

access: protected

mixed $modulesRepositories = array() (line 333)

list all modules repository

access: protected

mixed $parseInfos (line 56)

access: protected

mixed $requestType (line 54)

access: protected

mixed $typeparam = array('string'=>'([^\/]+)','char'=>'([^\/])', 'letter'=>'(\w)',
'number'=>'(\d+)', 'int'=>'(\d+)', 'integer'=>'(\d+)', 'digit'=>'(\d)',
'date'=>'([0-2]\d{3}\-(?:0[1-9]|1[0-2])\-(?:[0-2][1-9]|3[0-1]))',
'year'=>'([0-2]\d{3})', 'month'=>'(0[1-9]|1[0-2])', 'day'=>'([0-2][1-9]|[1-2]0|3[0-1])',
'path'=>'(.*)', 'locale'=>'(\w{2,3}(?:(?:\-|_)\w{2,3})?)', 'lang'=>'(\w{2,3})'
) (line 61)

access: protected

Methods

appendUrlInfo (line 489)

register the given url informations

access: protected

void appendUrlInfo (significantUrlInfoParsing $u, string $path, $secondaryAction)

significantUrlInfoParsing $u
string $path
$secondaryAction

compile (line 71)

access: public

void compile ( $aSelector)

$aSelector

Implementation of:

jISimpleCompiler::compile(): parse the given file, and store the result in a cache file

extractDynamicParams (line 424)

extract all dynamic parts of a pathinfo, and read <param> elements

return: the correponding regular expression
access: protected

string extractDynamicParams (simpleXmlElement $url, string $regexppath, significantUrlInfoParsing $u)

simpleXmlElement $url: the url element
string $regexppath: the path info
significantUrlInfoParsing $u

getEntryPointConfig (line 318)

access: protected

void getEntryPointConfig ( $entrypoint)

$entrypoint

newHandler (line 380)

access: protected

void newHandler (significantUrlInfoParsing $u, simpleXmlElement $url, [ $pathinfo = ''])

significantUrlInfoParsing $u
simpleXmlElement $url
$pathinfo

readInclude (line 509)

access: protected

void readInclude (simpleXmlElement $url, significantUrlInfoParsing $uInfo)

simpleXmlElement $url
significantUrlInfoParsing $uInfo

readProjectXml (line 307)

access: protected

void readProjectXml ()

retrieveModulePaths (line 347)

since urls.xml declare all entrypoints, current entry point does not have access to all modules, so doesn't know all their paths.

this method retrieve all module paths declared in the configuration of an entry point or the global configuration

access: protected

void retrieveModulePaths (string $configFile)

string $configFile: the config file name