ProviderSearchResults
in package
implements
ArrayAccess, Iterator, Countable
Table of Contents
Interfaces
- ArrayAccess
- Iterator
- Countable
Properties
Methods
- count() : int
- Count elements of in ProviderSearchResults object
- current() : ProviderResult
- Return the current element
- getError() : string
- Get error message
- getWarning() : string
- Get warning message
- key() : int
- Return the key of the current element
- next() : void
- Move forward to next element
- offsetExists() : bool
- Whether or not an offset exists.
- offsetGet() : ProviderResult
- Offset to retrieve.
- offsetSet() : void
- Assign a value to the specified offset
- offsetUnset() : void
- Unset an offset.
- rewind() : void
- Rewind the Iterator to the first element
- setError() : void
- Set error message
- setWarning() : void
- Set warning message
- valid() : bool
- Checks if current position is valid
Properties
$total
public
mixed
$total
= 0
$error
private
mixed
$error
= ""
$position
private
mixed
$position
= 0
$results
private
mixed
$results
= array()
$warning
private
mixed
$warning
= ""
Methods
count()
Count elements of in ProviderSearchResults object
public
count() : int
Return values
int —Returns the number of ProviderResult elements
current()
Return the current element
public
current() : ProviderResult
Return values
ProviderResultgetError()
Get error message
public
getError() : string
Return values
stringgetWarning()
Get warning message
public
getWarning() : string
Return values
stringkey()
Return the key of the current element
public
key() : int
Return values
intnext()
Move forward to next element
public
next() : void
offsetExists()
Whether or not an offset exists.
public
offsetExists(mixed $offset) : bool
This method is executed when using isset() or empty().
Parameters
- $offset : mixed
-
An offset to check for
Return values
booloffsetGet()
Offset to retrieve.
public
offsetGet(mixed $offset) : ProviderResult
This method is executed when checking if offset is empty().
Parameters
- $offset : mixed
-
The offset to retrieve
Return values
ProviderResultoffsetSet()
Assign a value to the specified offset
public
offsetSet(int $offset, ProviderResult $value) : void
Parameters
- $offset : int
-
The offset to assign the value to
- $value : ProviderResult
-
The value to set
offsetUnset()
Unset an offset.
public
offsetUnset(mixed $offset) : void
This method will not be called when type-casting to (unset).
Parameters
- $offset : mixed
-
The offset to unset
rewind()
Rewind the Iterator to the first element
public
rewind() : void
setError()
Set error message
public
setError(string $message) : void
Parameters
- $message : string
setWarning()
Set warning message
public
setWarning(string $message) : void
Parameters
- $message : string
valid()
Checks if current position is valid
public
valid() : bool