IceHawk

Cookies

This section covers the accessability of values set to cookies.


The Cookies object

Since version 2.1.0 IceHawk provides a wrapper object for cookie values via $request data object. This wrapper is defined by the interface IceHawk\IceHawk\Interfaces\ProvidesCookieData and implemented as the default class Cookies.

As you can see in the request handlers section the IceHawk component provides a request data object to the request handler. This object carries the request information, request input and the cookie data.

This example shows how you can access the cookie data inside a GET request handler:

class YourGetRequestHandler implements HandlesGetRequest
{
    public function handle( ProvidesReadRequestData $request )
    {
        # Get the cookie data
        $requestInput = $request->getCookies();
    }
}

Where to intantiate the object?

As shown in the configuration section you need to provide an instance of the Cookies class (or an implementation of the ProvidesCookieData interface) once in the getCookies() method. IceHawk will then inject it to all subsequent objects.


1. Get a single value

Assuming your cookie data array looks like this:

Array
(
    [language] => en
    [lastPage] =>
)

You can now access these values by the get(string $key) method like this:

<?php

$language = $cookies->get( 'language' );
var_dump( $language );

$lastPage = $cookies->get( 'lastPage' );
var_dump( $lastPage );

$affiliate = $cookies->get( 'affiliate' ); # key doesn't exist!
var_dump( $affiliate );

# key doesn't exist, use FALSE as default value
$affiliate = $cookies->get( 'affiliate', false ); 
var_dump( $affiliate );

This will print:

string(2) "en"          # $language

string(0) ""            # $lastPpage

NULL                    # $affiliate

FALSE                   # $affiliate

2. Get all values

Assuming your cookie data array looks like this:

Array
(
    [language] => en
    [lastPage] =>
)

You can now access these values by the getData() method like this:

<?php

var_dump($cookies->getData());

This prints:

array(2) {
  'language' => string(2) "en"
  'lastPage' => string(0) ""
}