Flash.php

Go to the documentation of this file.

<?php
class Slim_Session_Flash implements ArrayAccess {

    protected $sessionKey = 'flash';

    protected $messages = array(
        'prev' => array(), //flash messages from prev request
        'next' => array(), //flash messages for next request
        'now' => array() //flash messages for current request
    );

    public function __construct( $sessionKey = null ) {
        if ( !is_null($sessionKey) ) {
            $this->setSessionKey($sessionKey);
        }
        $this->load();
    }

    public function setSessionKey( $key ) {
        if ( is_null($key) ) {
            throw new RuntimeException('Session key cannot be null');
        }
        $this->sessionKey = (string)$key;
        return $this;
    }

    public function getSessionKey() {
        return $this->sessionKey;
    }

    public function now( $key, $value ) {
        $this->messages['now'][(string)$key] = $value;
        return $this->save();
    }

    public function set( $key, $value ) {
        $this->messages['next'][(string)$key] = $value;
        return $this->save();
    }

    public function getMessages() {
        return array_merge($this->messages['prev'], $this->messages['now']);
    }

    public function load() {
        $this->messages['prev'] = isset($_SESSION[$this->sessionKey]) ? $_SESSION[$this->sessionKey] : array();
        return $this;
    }

    public function keep() {
        foreach ( $this->messages['prev'] as $key => $val ) {
            $this->messages['next'][$key] = $val;
        }
        return $this->save();
    }

    public function save() {
        $_SESSION[$this->sessionKey] = $this->messages['next'];
        return $this;
    }

    /***** ARRAY ACCESS INTERFACE *****/

    public function offsetExists( $offset ) {
        $messages = $this->getMessages();
        return isset($messages[$offset]);
    }

    public function offsetGet( $offset ) {
        $messages = $this->getMessages();
        return isset($messages[$offset]) ? $messages[$offset] : null;
    }

    public function offsetSet( $offset, $value ) {
        $this->now($offset, $value);
    }

    public function offsetUnset( $offset ) {
        unset($this->messages['prev'][$offset]);
        unset($this->messages['now'][$offset]);
    }

}