Slim\Collection Class Reference

Collection. More...

Inheritance diagram for Slim\Collection:

Collaboration diagram for Slim\Collection:

Public Member Functions
	__construct (array $items=[])
	Create new collection. More...
	set ($key, $value)
	Set collection item. More...
	get ($key, $default=null)
	Get collection item for key. More...
	replace (array $items)
	Add item to collection, replacing existing items with the same data key. More...
	all ()
	Get all items in collection. More...
	keys ()
	Get collection keys. More...
	has ($key)
	Does this collection have a given key? More...
	remove ($key)
	Remove item from collection. More...
	clear ()
	Remove all items from collection. More...
	offsetExists ($key)
	Does this collection have a given key? More...
	offsetGet ($key)
	Get collection item for key. More...
	offsetSet ($key, $value)
	Set collection item. More...
	offsetUnset ($key)
	Remove item from collection. More...
	count ()
	Get number of items in collection. More...
	getIterator ()
	Get collection iterator. More...

Protected Attributes
	$data = []

Detailed Description

Collection.

This class provides a common interface used by many other classes in a Slim application that manage "collections" of data that must be inspected and/or manipulated

Definition at line 21 of file Collection.php.

Constructor & Destructor Documentation

__construct()

Slim\Collection::__construct

(

array

$items = []

)

Create new collection.

Parameters

array

$items

Pre-populate collection with this key-value array

Definition at line 35 of file Collection.php.

    {
        $this->replace($items);
    }

Member Function Documentation

all()

Slim\Collection::all

(

)

Get all items in collection.

Returns

array The collection's source data

Implements Slim\Interfaces\CollectionInterface.

Definition at line 85 of file Collection.php.

References $data.

Referenced by Slim\Http\Request\createFromEnvironment().

    {
        return $this->data;
    }

Here is the caller graph for this function:

clear()

Slim\Collection::clear

(

)

Remove all items from collection.

Implements Slim\Interfaces\CollectionInterface.

Definition at line 125 of file Collection.php.

References data.

    {
        $this->data = [];
    }

count()

Slim\Collection::count

(

)

Get number of items in collection.

Returns

int

Definition at line 184 of file Collection.php.

References data.

    {
        return count($this->data);
    }

get()

Slim\Collection::get	(		$key,
			$default = null
	)

Get collection item for key.

Parameters

string	$key	The data key
mixed	$default	The default value to return if data key does not exist

Returns

mixed The key's value, or the default value

Implements Slim\Interfaces\CollectionInterface.

Definition at line 63 of file Collection.php.

References $default, $key, and data.

Referenced by Slim\Http\Uri\createFromEnvironment(), and Slim\Http\Headers\determineAuthorization().

    {
        return $this->has($key) ? $this->data[$key] : $default;
    }

Here is the caller graph for this function:

getIterator()

Slim\Collection::getIterator

(

)

Get collection iterator.

Returns

Definition at line 198 of file Collection.php.

References data.

    {
        return new ArrayIterator($this->data);
    }

has()

Slim\Collection::has

(

$key

)

Does this collection have a given key?

Parameters

string

$key

The data key

Returns

bool

Implements Slim\Interfaces\CollectionInterface.

Definition at line 107 of file Collection.php.

References $key, and data.

Referenced by Slim\Http\UploadedFile\createFromEnvironment(), and Slim\Http\Uri\createFromEnvironment().

    {
        return array_key_exists($key, $this->data);
    }

Here is the caller graph for this function:

keys()

Slim\Collection::keys

(

)

Get collection keys.

Returns

array The collection's source data keys

Definition at line 95 of file Collection.php.

References data.

    {
        return array_keys($this->data);
    }

offsetExists()

Slim\Collection::offsetExists

(

$key

)

Does this collection have a given key?

Parameters

string

$key

The data key

Returns

bool

Definition at line 141 of file Collection.php.

References $key.

    {
        return $this->has($key);
    }

offsetGet()

Slim\Collection::offsetGet

(

$key

)

Get collection item for key.

Parameters

string

$key

The data key

Returns

mixed The key's value, or the default value

Definition at line 153 of file Collection.php.

References $key.

    {
        return $this->get($key);
    }

offsetSet()

Slim\Collection::offsetSet	(		$key,
			$value
	)

Set collection item.

Parameters

string	$key	The data key
mixed	$value	The data value

Definition at line 164 of file Collection.php.

References $key.

    {
        $this->set($key, $value);
    }

offsetUnset()

Slim\Collection::offsetUnset

(

$key

)

Remove item from collection.

Parameters

string

$key

The data key

Definition at line 174 of file Collection.php.

References $key.

    {
        $this->remove($key);
    }

remove()

Slim\Collection::remove

(

$key

)

Remove item from collection.

Parameters

string

$key

The data key

Implements Slim\Interfaces\CollectionInterface.

Definition at line 117 of file Collection.php.

References $key, and data.

    {
        unset($this->data[$key]);
    }

replace()

Slim\Collection::replace

(

array

$items

)

Add item to collection, replacing existing items with the same data key.

Parameters

array

$items

Key-value array of data to append to this collection

Implements Slim\Interfaces\CollectionInterface.

Definition at line 73 of file Collection.php.

References $key.

    {
        foreach ($items as $key => $value) {
            $this->set($key, $value);
        }
    }

set()

Slim\Collection::set	(		$key,
			$value
	)

Set collection item.

Parameters

string	$key	The data key
mixed	$value	The data value

Implements Slim\Interfaces\CollectionInterface.

Definition at line 50 of file Collection.php.

References $key, and data.

Referenced by Slim\Http\Headers\determineAuthorization().

    {
        $this->data[$key] = $value;
    }

Here is the caller graph for this function:

Field Documentation

$data

Slim\Collection::$data = []

protected

Definition at line 28 of file Collection.php.

Referenced by Slim\Http\Headers\createFromEnvironment(), and Slim\Http\Environment\mock().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/slim/slim/Slim/Collection.php