apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Net_URL_Mapper_Path

Source Location: /Net_URL_Mapper-0.9.1/Mapper/Path.php

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 49]


[ Top ]


Class Variables

$alias =

[line 59]

  • Access: protected

Type:   mixed


[ Top ]

$defaults = array()

[line 61]

  • Access: protected

Type:   mixed


[ Top ]

$fixed =  true

[line 67]

  • Access: protected

Type:   mixed


[ Top ]

$format =

[line 64]

  • Access: protected

Type:   mixed


[ Top ]

$maxKeys =

[line 66]

  • Access: protected

Type:   mixed


[ Top ]

$minKeys =

[line 65]

  • Access: protected

Type:   mixed


[ Top ]

$parts = array()

[line 62]

  • Access: protected

Type:   mixed


[ Top ]

$required =

[line 68]

  • Access: protected

Type:   mixed


[ Top ]

$rule =

[line 63]

  • Access: protected

Type:   mixed


[ Top ]

$rules = array()

[line 60]

  • Access: protected

Type:   mixed


[ Top ]

$token =

[line 53]

  • Access: public

Type:   mixed


[ Top ]

$value =

[line 54]

  • Access: public

Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 70]

Net_URL_Mapper_Path __construct( [ $path = ''], [ $defaults = array()], [ $rules = array()])

  • Access: public

Parameters:

   $path   — 
   $defaults   — 
   $rules   — 

[ Top ]

addPart   [line 197]

void addPart( $part)

  • Access: protected

Parameters:

   $part   — 

[ Top ]

createPart   [line 216]

void createPart( $type, $content, $path)

  • Access: public

Parameters:

   $type   — 
   $content   — 
   $path   — 

[ Top ]

generate   [line 252]

void generate( [ $values = array()], [ $qstring = array()], [ $anchor = ''])

  • Access: public

Parameters:

   $values   — 
   $qstring   — 
   $anchor   — 

[ Top ]

getAlias   [line 118]

null|string getAlias( )

Get the path alias

Path aliases can be used instead of full path

  • Access: public

[ Top ]

getDefaults   [line 138]

null|array getDefaults( )

Get the path parts default values
  • Access: public

[ Top ]

getFormat   [line 185]

void getFormat( )

  • Access: public

[ Top ]

getMaxKeys   [line 287]

void getMaxKeys( )

  • Access: public

[ Top ]

getPath   [line 103]

void getPath( )

  • Access: public

[ Top ]

getRequired   [line 273]

void getRequired( )

  • Access: public

[ Top ]

getRule   [line 173]

string getRule( )

Returns the regular expression used to match this path
  • Return: PERL Regular expression
  • Access: public

[ Top ]

hasKey   [line 237]

void hasKey( string $partName, [mixed $value = null])

Checks whether the path contains the given part by name If value parameter is given, the part also checks if the given value conforms to the part rule.
  • Access: public

Parameters:

string   $partName   —  Part name
mixed   $value   —  The value to check against

[ Top ]

parsePath   [line 108]

void parsePath( )

  • Access: protected

[ Top ]

setAlias   [line 128]

void setAlias( string $alias)

Set the path name
  • See: getAlias()
  • Access: public

Parameters:

string   $alias   —  Set the path name

[ Top ]

setDefaults   [line 147]

void setDefaults( array $defaults)

Set the path parts default values
  • Access: public

Parameters:

array   $defaults   —  Associative array with format partname => value

[ Top ]

setRules   [line 160]

void setRules( array $rules)

Set the path parts default values
  • Access: public

Parameters:

array   $rules   —  Associative array with format partname => value

[ Top ]

yybegin   [line 318]

void yybegin( $state)


Parameters:

   $state   — 

[ Top ]

yylex   [line 302]

void yylex( )


[ Top ]

yylex1   [line 325]

void yylex1( )


[ Top ]

yypopstate   [line 313]

void yypopstate( )


[ Top ]

yypushstate   [line 307]

void yypushstate( $state)


Parameters:

   $state   — 

[ Top ]

yy_r1_1   [line 413]

void yy_r1_1( $yy_subpatterns)


Parameters:

   $yy_subpatterns   — 

[ Top ]

yy_r1_3   [line 420]

void yy_r1_3( $yy_subpatterns)


Parameters:

   $yy_subpatterns   — 

[ Top ]

yy_r1_5   [line 427]

void yy_r1_5( $yy_subpatterns)


Parameters:

   $yy_subpatterns   — 

[ Top ]

yy_r1_7   [line 434]

void yy_r1_7( $yy_subpatterns)


Parameters:

   $yy_subpatterns   — 

[ Top ]

yy_r1_9   [line 441]

void yy_r1_9( $yy_subpatterns)


Parameters:

   $yy_subpatterns   — 

[ Top ]

__sleep   [line 95]

array __sleep( )

Called when the object is serialized Make sure we do not store too much info when the object is serialized and call the regular expressions generator functions so that they will not need to be generated again on wakeup.
  • Return: Name of properties to store when serialized
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:41:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.