util/PathTokenizer.php
inherited
Classes
A Path tokenizer takes a path and returns the components that make up
that path.
The path can use path separators of either ':' or ';' and file separators
of either '/' or '\'.
- Author
- Hans Lellelid
- Author
- Conor MacNeill (Ant)
- Author
- Jeff Tulley
- Package
- phing.util
\PathTokenizer
A Path tokenizer takes a path and returns the components that make up
that path.
The path can use path separators of either ':' or ';' and file separators
of either '/' or '\'.
- Author
- Hans Lellelid
- Author
- Conor MacNeill (Ant)
- Author
- Jeff Tulley
Properties
boolean
$dosStyleFilesystem= ''
Flag to indicate whether or not we are running on a platform with a
DOS style filesystem
- Type
- boolean
string
$lookahead= ''
A string which stores any path components which have been read ahead
due to DOS filesystem compensation.
- Type
- string
$tokens= 'array()'
A array of tokens, created by preg_split().
array()Details- Type
- n/a
Methods
__construct(
\path $path
)
:
voidConstructs a path tokenizer for the specified path.
| Name | Type | Description |
|---|---|---|
| $path | \path | The path to tokenize. Must not be |
contains(
string $path
)
:
booleanNon StringTokenizer function, that indicates whether the specified path is contained in loaded tokens.
We can do this easily because in PHP implimentation we're using arrays.
| Name | Type | Description |
|---|---|---|
| $path | string | path to search for. |
| Type | Description |
|---|---|
| boolean |
hasMoreTokens(
)
:
\<code>true</code>Tests if there are more path elements available from this tokenizer's
path. If this method returns
true, then a subsequent call
to nextToken will successfully return a token.
| Type | Description |
|---|---|
| \<code>true</code> | if and only if there is at least one token in the string after the current position; <code>false</code> otherwise. |
nextToken(
)
:
\theReturns the next path element from this tokenizer.
| Type | Description |
|---|---|
| \the | next path element from this tokenizer. |
| Exception | Description |
|---|---|
| \Exception | if there are no more elements in this tokenizer's path. |