public
|
#
__construct( array $params = null )
Provides a means of setting multiple values on object instantiation.
Provides a means of setting multiple values on object instantiation.
Parameters
|
public
boolean
|
#
__isset( scalar $name )
Provides compatibility with the PHP native isset() function.
Provides compatibility with the PHP native isset() function.
Parameters
Returns
boolean
|
public
|
#
__unset( scalar $name )
Provides compatibility with the PHP native unset() function.
Provides compatibility with the PHP native unset() function.
Parameters
|
public
|
#
__set( scalar $name, mixed $value )
Provides compatibility with the PHP native setter language construct.
Provides compatibility with the PHP native setter language construct.
Parameters
|
public
mixed
|
#
__get( scalar $name )
Provides compatibility with the PHP native getter language construct.
Provides compatibility with the PHP native getter language construct.
Parameters
Returns
mixed
|
public
|
#
clear( )
Resets the collection to an empty state.
Resets the collection to an empty state.
|
public
oroboros\core\traits\libraries\container\CollectionTrait
|
#
copy( )
Returns a new instance of the same object this trait is instantiated on.
Returns a new instance of the same object this trait is instantiated on.
Returns
|
public
integer
|
#
count( integer $mode = COUNT_NORMAL )
Returns a count of the values in the collection.
The $mode parameter does nothing, due to a native PHP bug that
prevents recursive counting from working on instances of \Countable,
but it must be provided to honor the interface.
Returns a count of the values in the collection.
The $mode parameter does nothing, due to a native PHP bug that
prevents recursive counting from working on instances of \Countable,
but it must be provided to honor the interface.
Parameters
- $mode
- Currently does nothing due to a native PHP bug
Returns
integer
|
public
mixed
|
#
current( )
Gets the current iterable index, provided to honor
the PHP native \Iterable interface.
Gets the current iterable index, provided to honor
the PHP native \Iterable interface.
Returns
mixed
|
public
boolean
|
#
isEmpty( )
Returns a boolean determination as to whether the collection is empty.
Returns a boolean determination as to whether the collection is empty.
Returns
boolean
|
public
scalar
|
#
key( )
Provided for compatibility with the PHP native \Iterator interface.
Returns the current key assigned to the pointer.
Provided for compatibility with the PHP native \Iterator interface.
Returns the current key assigned to the pointer.
Returns
scalar
|
public
array
|
#
jsonSerialize( )
Provided for compatibilibty with the PHP native \JsonSerializable interface.
Provided for compatibilibty with the PHP native \JsonSerializable interface.
Returns
array
|
public
|boolean
|
#
next( )
Provided for compatibility with the PHP native \Iterator interface.
Increments the pointer, returns false if it has reached
the end of iterable values.
Provided for compatibility with the PHP native \Iterator interface.
Increments the pointer, returns false if it has reached
the end of iterable values.
Returns
|boolean
|
public
boolean
|
#
offsetExists( scalar $offset )
Provided for compatibility with the PHP native \ArrayAccess interface.
Returns a boolean determination as to whether the specified offset exists.
Provided for compatibility with the PHP native \ArrayAccess interface.
Returns a boolean determination as to whether the specified offset exists.
Parameters
Returns
boolean
|
public
mixed
|
#
offsetGet( scalar $offset )
Provided for compatibility with the PHP native \ArrayAccess interface.
Returns the value for the specified offset.
Provided for compatibility with the PHP native \ArrayAccess interface.
Returns the value for the specified offset.
Parameters
Returns
mixed
|
public
|
#
offsetSet( scalar $offset, mixed $value )
Provided for compatibility with the PHP native \ArrayAccess interface.
Sets the specified value to the specified offset.
Provided for compatibility with the PHP native \ArrayAccess interface.
Sets the specified value to the specified offset.
Parameters
|
public
|
#
offsetUnset( scalar $offset )
Provided for compatibility with the PHP native \ArrayAccess interface.
Unsets the specified offset.
Provided for compatibility with the PHP native \ArrayAccess interface.
Unsets the specified offset.
Parameters
|
public
|
#
rewind( )
Provided for compatibility with the PHP native \Iterator interface.
Rewinds the iterator. Called natively when loops begin.
Provided for compatibility with the PHP native \Iterator interface.
Rewinds the iterator. Called natively when loops begin.
|
public
array
|
#
toArray( )
Returns an array of the values in the collection.
Returns an array of the values in the collection.
Returns
array
|
public
boolean
|
#
valid( )
Provided for compatibility with the PHP native \Iterator interface.
Returns a boolean determination as to whether a specified
pointer key exists.
Provided for compatibility with the PHP native \Iterator interface.
Returns a boolean determination as to whether a specified
pointer key exists.
Returns
boolean
|
protected
|
#
_initializeCollection( array $params = null )
Provides an alternative initialization method if another trait
needs to provide a different constructor method.
Provides an alternative initialization method if another trait
needs to provide a different constructor method.
Parameters
|
private
|
#
_init( array $params = null , type $flags,… )
This is the real initialization method.
It insures that core initialization logic is not overridden,
and backreference always points to this trait on execution.
This is the real initialization method.
It insures that core initialization logic is not overridden,
and backreference always points to this trait on execution.
Parameters
|
private
|
#
_autoInit( )
This method will initialize the trait only
if it was not already initialized.
This method will initialize the trait only
if it was not already initialized.
|