[Horde_Routes] element index

Package indexes

All elements
a b c d e f g h l m p r s t u _
_
top
Variable $_collectionName
Collection name if this is a RESTful route
Variable $_createdGens
Have generation hashes been created for all connected routes?
Variable $_createdRegs
Have regular expressions been created for all connected routes?
Variable $_gendict
Generation hashes created for all connected routes
Variable $_keysortTmp
Temporary variable used to pass array of keys into _keysort() callback
Variable $_memberName
Member name if this is a RESTful route
Variable $_parentResource
Name of the parent resource, if this is a RESTful route & has a parent
Variable $_prior
Last path part used by buildNextReg()
Variable $_regPrefix
Regular expression generated to match after the prefix
Variable $_reqRegs
Requirements formatted as regexps suitable for preg_match()
Variable $_routeBackwards
Reverse of $routeList
Variable $_routeList
Route path split by '/'
Variable $_splitChars
Characters that split the parts of a URL
Method _arrayUnion
Create a union of two arrays.
Method _cmp
Equivalent of Python's cmp() function.
Method _createGens
Create the generation hashes (arrays) for route lookups
Method _defaults
Creates a default array of strings
Method _keycmp
Compare two Horde_Route_Routes objects by their keys against the instance variable $keysortTmp. Used by _keysort().
Method _keysort
Sort an array of Horde_Routes_Routes to using _keycmp() for the comparision to order them ideally for matching.
Method _match
Internal Route matcher
Method _minKeys
Utility function to walk the route backwards
Method _pathKeys
Utility method to walk the route, and pull out the valid dynamic/wildcard keys
Method _requirementsFor
Returns a new dict to be used for all route creation as the route options.
Method _stripSlashes
Trims slashes from the beginning or end of a part/URL.
Method _swap
Swap the keys and values in the dict, and uppercase the values from the dict during the swap.
Method __construct
Constructor
Method __construct
Constructor.
Method __construct
Initialize a route, with a given routepath for matching/generation
a
top
Variable $absolute
Is this an absolute path? (Mapper will not prepend SCRIPT_NAME)
Variable $alwaysScan
Call controllerScan callback before every route match?
Variable $appendSlash
Append trailing slash ('/') to generated routes?
Method arraySubtract
Method articleFilter
Method assertRestfulRoutes
Page AllTests.php
AllTests.php in AllTests.php
b
top
Method buildNextReg
Recursively build a regexp given a path, and a controller list.
c
top
Variable $conditions
Array of keyword args for special conditions (method, subDomain, function)
Variable $controllerScan
Callback function used to get array of controller names
Method connect
Create and connect a new Route to the Mapper.
Method controllerScan
Scan a directory for PHP files and use them as controllers. Used as the default scanner callback for Horde_Routes_Mapper. See the constructor of that class for more information.
Method createRegs
Creates the regexes for all connected routes
Page content.php
content.php in content.php
d
top
Variable $debug
Collect debug information during route match?
Variable $decodeErrors
What to do on decoding errors? 'ignore' or 'replace'
Variable $decodeErrors
What to do on decoding errors? 'ignore' or 'replace'
Variable $defaults
Default keyword arguments for this route
Variable $directory
Path to controller directory passed to controllerScan function
Variable $domainMatch
Partial regexp used to match domain part of the end of URLs to match
e
top
Variable $encoding
Encoding of routes URLs (not yet supported)
Variable $encoding
Encoding of this route (not yet supported)
Variable $environ
Filtered request environment with keys like SCRIPT_NAME
Variable $explicit
Disable route memory and implicit defaults?
Variable $explicit
Does this route use explicit mode (no implicit defaults)?
Page Exception.php
Exception.php in Exception.php
f
top
Variable $filter
Filter function to operate on arguments before generation
g
top
Method generate
Generate a URL from ourself given a set of keyword arguments
Method generate
Generates the URL from a given set of keywords Returns the URL text, or null if no URL could be generated.
Class GenerationTest
GenerationTest in GenerationTest.php
Page GenerationTest.php
GenerationTest.php in GenerationTest.php
h
top
Variable $hardCoded
Default keywords that don't exist in the path; can't be changed by an incomng URL.
Class Horde_Routes_AllTests
Horde_Routes_AllTests in AllTests.php
Class Horde_Routes_Exception
Horde_Routes_Exception in Exception.php
Exception class for the Horde_Routes package. All exceptions thrown from the package will be of this type.
Class Horde_Routes_Mapper
Horde_Routes_Mapper in Mapper.php
The mapper class handles URL generation and recognition for web applications
Class Horde_Routes_Route
Horde_Routes_Route in Route.php
The Route object holds a route recognition and generation routine.
Class Horde_Routes_TestHelper
Horde_Routes_TestHelper in TestHelper.php
Class Horde_Routes_Utils
Horde_Routes_Utils in Utils.php
Utility functions for use in templates and controllers
l
top
Method longestFirst
Callback used by usort() in controllerScan() to sort controller names by the longest first.
m
top
Variable $mapper
Variable $mapperDict
Match data from last match; implements for urlFor() route memory
Variable $matchList
Array of connected routes
Variable $maxKeys
Array of all connected routes, indexed by the serialized array of all keys that each route could utilize.
Variable $maxKeys
Maximum keys that this route could utilize.
Variable $minKeys
Minimum keys required to generate this route
Variable $minKeys
Array of all connected routes, indexed by the serialized array of the minimum keys that each route needs.
Method main
Method makeRegexp
Create the regular expression for matching.
Method match
Match a URL against one of the routes contained.
Method match
Match a url to our regexp.
Page Mapper.php
Mapper.php in Mapper.php
p
top
Variable $prefix
Prefix to strip during matching and to append during generation
Constant PHPUnit_MAIN_METHOD
PHPUnit_MAIN_METHOD in AllTests.php
Horde Routes package
Method printer
UtilTest::printer() in UtilTest.php
r
top
Variable $redirect
Callback function used for redirectTo()
Variable $regexp
Regular expression for matching this route
Variable $reqs
Requirements for this route
Variable $routeNames
Array of connected named routes, indexed by name
Variable $routePath
The path for this route, such as ':controller/:action/:id'
Class RecognitionTest
RecognitionTest in RecognitionTest.php
Method redirectTo
Issues a redirect based on the arguments.
Method resource
Generate routes for a controller resource
Method routematch
Match a URL against one of the routes contained.
Page Route.php
Route.php in Route.php
Page RecognitionTest.php
RecognitionTest.php in RecognitionTest.php
s
top
Variable $static
Is this a static route?
Variable $subDomains
Use sub-domain support?
Variable $subDomainsIgnore
Array of sub-domains to ignore if using sub-domain support
Method setUp
UtilWithExplicitTest::setUp() in UtilWithExplicitTest.php
Method setUp
UtilTest::setUp() in UtilTest.php
Method suite
t
top
Page TestHelper.php
TestHelper.php in TestHelper.php
Method testAllStatic
RecognitionTest::testAllStatic() in RecognitionTest.php
Method testAllStaticNoReqs
Method testAppendSlash
Method testAutoControllerScan
Method testBackwards
GenerationTest::testBackwards() in GenerationTest.php
Method testBackwardsWithSplits
Method testBasicDynamic
Method testBasicDynamic
Method testBasicDynamicBackwards
Method testBigMultiroute
Method testBigMultirouteWithSplits
Method testBothRequirementAndOptional
Method testController
RecognitionTest::testController() in RecognitionTest.php
Method testController
GenerationTest::testController() in GenerationTest.php
Method testControllerScan
Method testControllerWithStatic
Method testDefaultRoute
Method testDisablingUnicode
Method testDynamicAndControllerWithStringAndDefaultBackwards
Method testDynamicWithDefault
Method testDynamicWithDefault
Method testDynamicWithDefaultAndRegexpCondition
Method testDynamicWithDefaultAndStringConditionBackwards
Method testDynamicWithDefaultBackwards
Method testDynamicWithFalseEquivs
Some of these assertions are invalidated in PHP, it passes in Python because
Method testDynamicWithFalseEquivsAndSplits
Method testDynamicWithMultipleAndPrefix
Method testDynamicWithPath
Method testDynamicWithPrefix
Method testDynamicWithRegexpAndDefault
Method testDynamicWithRegExpCondition
Method testDynamicWithRegexpCondition
Method testDynamicWithRegexpDefaultsAndGaps
Method testDynamicWithRegexpDefaultsAndGapsAndSplits
Method testDynamicWithRegexpGapsControllers
Method testDynamicWithStringCondition
Method testDynamicWithStringConditionBackwards
Method testDynamicWithTrailingDynamicDefaults
Method testDynamicWithTrailingNonKeywordStrings
Method testDynamicWithTrailingStrings
Method testDynamicWithUnderscoreParts
Method testDynamicWithUnderscores
Method testExtras
GenerationTest::testExtras() in GenerationTest.php
Method testExtrasWithSplits
Method testMatchDebug
RecognitionTest::testMatchDebug() in RecognitionTest.php
Method testMultiroute
RecognitionTest::testMultiroute() in RecognitionTest.php
Method testMultiroute
GenerationTest::testMultiroute() in GenerationTest.php
Method testMultirouteWithSplits
Method testMultirouteWithSplits
Method testNoExtras
GenerationTest::testNoExtras() in GenerationTest.php
Method testNoExtrasWithSplits
Method testNoNamedPath
Method testNoNamedPathWithScript
Method testNoRegMake
RecognitionTest::testNoRegMake() in RecognitionTest.php
Method testOtherSpecialChars
Method testPath
RecognitionTest::testPath() in RecognitionTest.php
Method testPath
GenerationTest::testPath() in GenerationTest.php
Method testPathBackwards
Method testPathBackwards
Method testPathBackwardsWithController
Method testPathBackwardsWithControllerAndSplits
Method testPathWithDynamicAndDefault
Method testPathWithDynamicAndDefaultBackwards
Method testRedirectTo
Method testRegexpCharEscaping
Method testResources
GenerationTest::testResources() in GenerationTest.php
Method testResourcesWithCollectionAction
Method testResourcesWithMemberAction
Method testResourcesWithNamePrefix
Method testResourcesWithNewAction
Method testResourcesWithPathPrefix
Method testRouteFilter
Method testRoutematch
RecognitionTest::testRoutematch() in RecognitionTest.php
Method testRoutematchDebug
Method testRouteWithEndExtension
Method testRouteWithFixnumDefault
Method testRouteWithFixnumDefaultWithSplits
Method testRouteWithOddLeftovers
Method testSetToNilForgets
Method testSplitsPackedWithRegexps
Method testSplitsWithDashes
Method testSplitsWithExtension
Method testSplitsWithSlashes
Method testSplitsWithSlashesAndDefault
Method testStandardRoute
Method testStandardRoute
Method testStandardRouteWithGaps
Method testStandardRouteWithGapsAndDomains
Method testStandardWithDomains
Method testStatic
GenerationTest::testStatic() in GenerationTest.php
Method testStaticRoute
Method testStaticRouteWithScript
Method testSubdomains
Method testSubdomainsWithExceptions
Method testSubdomainsWithNamedRoutes
Method testSubdomainsWithPorts
Method testTheSmallestRoute
Method testTypical
GenerationTest::testTypical() in GenerationTest.php
Method testUnicode
GenerationTest::testUnicode() in GenerationTest.php
Method testUnicode
RecognitionTest::testUnicode() in RecognitionTest.php
Method testUnicodeStatic
Method testUppercaseRecognition
Method testUrlFor
UtilWithExplicitTest::testUrlFor() in UtilWithExplicitTest.php
Method testUrlForSelf
Method testUrlForWithDefaults
Method testUrlForWithDefaults
Method testUrlForWithDefaultsAndQualified
Method testUrlForWithDefaultsAndQualified
Method testUrlForWithMoreDefaults
Method testUrlForWithMoreDefaults
Method testUrlWithEnviron
Method testUrlWithEnvironAndAbsolute
Method testUrlWithEnvironEmpty
Method testUrlWithNoActionSpecified
Method testUrlWithPrefix
Method testUrlWithPrefixDeeper
Method testWithHttpEnviron
Method testWithResourceRouteNames
Method testWithRouteNames
Method testWithRouteNames
UtilWithExplicitTest::testWithRouteNames() in UtilWithExplicitTest.php
Method testWithRouteNamesAndDefaults
Method testWithRouteNamesAndDefaults
Method testWithSslEnviron
u
top
Variable $urlCache
Cache of URLs used in generate()
Variable $utils
Utility functions like urlFor() and redirectTo() for this Mapper
Page Utils.php
Utils.php in Utils.php
Page users.php
users.php in users.php
Page users.php
users.php in users.php
Page UtilTest.php
UtilTest.php in UtilTest.php
Page UtilWithExplicitTest.php
UtilWithExplicitTest.php in UtilWithExplicitTest.php
Method updateMapper
Update a Mapper instance with a new $environ. If PATH_INFO is present, try to match it and update mapperDict.
Method urlFor
Generates a URL.
Method urlQuote
Quote a string containing a URL in a given encoding.
Class UtilTest
UtilTest in UtilTest.php
Class UtilWithExplicitTest
UtilWithExplicitTest in UtilWithExplicitTest.php
a b c d e f g h l m p r s t u _