Overview

Packages

  • tipy

Classes

  • Tipy
  • TipyApp
  • TipyCli
  • TipyCliSession
  • TipyConfig
  • TipyController
  • TipyCookie
  • TipyDAO
  • TipyEnv
  • TipyFlash
  • TipyInflector
  • TipyInput
  • TipyIOWrapper
  • TipyLogger
  • TipyMailer
  • TipyModel
  • TipyOutput
  • TipyRequest
  • TipySession
  • TipyTestCase
  • TipyTestRunner
  • TipyView

Exceptions

  • AssertionFailedException
  • CompileErrorException
  • CompileWarningException
  • CoreErrorException
  • CoreWarningException
  • DeprecatedException
  • NoMethodException
  • NoticeException
  • ParseException
  • RecoverableErrorException
  • StrictException
  • TipyDaoException
  • TipyException
  • TipyModelException
  • TipyRollbackException
  • TipyValidationException
  • UserDeprecatedException
  • UserErrorException
  • UserNoticeException
  • UserWarningException
  • WarningException
  • Overview
  • Package
  • Class
  • Deprecated
  • Todo
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 
<?php
/**
 * TipySession
 *
 * @package tipy
 */

/**
 * Access session data the same way as any other tipy input/output objects
 *
 * <code>
 * class MyController extends TipyController {
 *     public function index() {
 *         $userId = $this->session->get('userId');
 *         $this->session->set('my_variable', 'Hello World!');
 *         // ...
 *     }
 * }
 * </code>
 */
class TipySession {

    /**
     * Construct TipySession instance from $_SESSION.
     * If session is not yet started it will be started immediately.
     * If session is already started if will be resumed.
     */
    public function __construct() {
        $this->start();
    }

    /**
     * Start new or resume existing session
     */
    public function start() {
        if (!session_id()) {
            session_set_cookie_params($this->get('sessionExpires', 0), '/');
            session_start();
        }
    }

    /**
     * Set session lifetime in seconds
     * @param integer $time
     */
    public function setLifetime($time = 0) {
        $this->set('sessionExpires', $time);
        session_set_cookie_params($this->get('sessionExpires', 0), '/');
        session_regenerate_id();
    }

    /**
     * Destroy the session and delete all session data
     */
    public function close() {
        $_SESSION = [];
        // If it's desired to kill the session, also delete the session cookie
        if (isset($_COOKIE[session_name()])) {
            setcookie(session_name(), '', 1, '/');
        }
        session_destroy();
    }

    /**
     * The way to set many variables at once
     *
     * **NOTE:** This will overwrite existing session data
     * @param array $map
     */
    public function bind($map) {
        $_SESSION = $map;
    }

    /**
     * Get session variable by its name
     * @param string $key
     * @param mixed $defaultValue
     * @return mixed
     */
    public function get($key) {
        if (isset($_SESSION[$key])) {
            return $_SESSION[$key];
        } else {
            if (func_num_args() > 1) {
                return func_get_arg(1);
            } else {
                return null;
            }
        }
    }

    /**
     * Set session variable
     * @param string $key
     * @param mixed $value
     */
    public function set($key, $value) {
        $_SESSION[$key] = $value;
    }

    /**
     * Get all data stored in session
     * @return array
     */
    public function getAll() {
        return $_SESSION;
    }
}
tipy API documentation generated by ApiGen