Class: Text_PathNavigator

Source Location: /Text_PathNavigator-0.1.0dev1/PathNavigator.php

Class Overview

The Text_PathNavigator class provides convenient access to "/path/sub/strings".

Author(s):

Denny Shimkoski <denny at bytebrite.com>

Copyright:

2006 Denny Shimkoski

Inherited Variables

Inherited Methods

Class Details

[line 48]
The Text_PathNavigator class provides convenient access to "/path/sub/strings".

These strings can be accessed in various ways:

by numeric index (e.g., index 1 of /pages/staff.html returns "staff.html")
by variable name (e.g., index "id" of /pages/id/1 returns 1)
using the slice() method
using the toArray() method
in PHP 5, using the getIterator() method

When retrieving values by variable name, it is assumed that the entry following the first occurence of the given string is the value to be assigned.

Example 1.

 require_once 'Text/PathNavigator.php';

 $p = new Text_PathNavigator('/the/golden/path', '/');
 echo $p->get(2);          // prints 'path'
 echo $p->get('golden');   // prints 'path'
 echo $p->slice(1);        // prints 'golden/path'
 echo $p->slice(-2, 1);    // prints 'golden'
 echo $p->slice(-1);       // prints 'path'

Author: Denny Shimkoski <denny@bytebrite.com>
Copyright: 2006 Denny Shimkoski
Link: http://pear.php.net/package/Text_PathNavigator
License: MIT

[ Top ]

Class Variables

$path =

[line 53]

Type:

string

[ Top ]

$slash =

[line 57]

Type:

string

[ Top ]

$vars =

[line 63]

Path after explode()

Type:

array

[ Top ]

Method Detail

Text_PathNavigator (Constructor) [line 72]

Text_PathNavigator Text_PathNavigator(
$path
$path, [$slash
$slash = DIRECTORY_SEPARATOR])

Constructor

Parameters:

$path	`$path`	—	array (e.g., array('test'=>'ok', 2, 3)) or string (e.g., '/test/ok/2/3')
$slash	`$slash`	—

[ Top ]

get [line 117]

null|false|string get(
string
$key)

Returns substrings by index or variable name

If $key appears to be a numeric index, attempts to return the corresponding substring (i.e., get(1) returns "val" from "/key/val"). Otherwise, searches path for a substring that matches $key and attempts to return the following entry. If the following entry is non-existent, null is returned. Returns false as a last resort.

Access: public

Parameters:

string $key — the numeric index or variable name

[ Top ]

getIterator [line 136]

null|object getIterator(
[int
$offset = 0])

Returns an ArrayIterator, starting at offset (PHP 5 only)

Access: public

Parameters:

int $offset — the starting position

[ Top ]

load [line 83]

false|array load(

$path)

Loads a new path into the object

Access: public

Parameters:

$path —

[ Top ]

slice [line 176]

false|string slice(
integer
$offset, [integer
$length = null])

Returns a slice from the path (see PHP's slice function for details)

Access: public

Parameters:

integer	`$offset`	—
integer	`$length`	—

[ Top ]

toArray [line 155]

false|array toArray(
[int
$offset = 0])

Returns path as an associative array, starting at offset

Maps '/a/hello/b/world' to array('a' => 'hello', 'b' => 'world').

Access: public

Parameters:

int $offset — the starting position

[ Top ]