File ext-form/src/MvcCore/Ext/Form/Core/Helpers.php

  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: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248:

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view 
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flídr (https://github.com/mvccore/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/4.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Form\Core;

require_once(__DIR__.'/../../Form.php');
require_once('Base.php');

use \MvcCore\Ext\Form;

class Helpers
{
    const CTRL_VIEW_PROVIDER_METHOD = 0;
    const CTRL_VIEW_PROVIDER_PROPERTY = 1;

    const SESSION_PROVIDER_INSTANCE = 0;
    const SESSION_PROVIDER_STATIC = 1;

    /**
     * Cofiguration how to get view object from controller object
     * @var array
     */
    public static $ControllerViewProvider = array(
        'type'      => self::CTRL_VIEW_PROVIDER_METHOD,
        'getter'    => 'GetView',
    );
    /**
     * Basic $_SESSION array as session service configuration.
     * @var array
     */
    public static $SessionProvider = array(
        'type'      => self::SESSION_PROVIDER_STATIC,
        'callable'  => array(__CLASS__, 'getSimpleSessionRecord'),
        'expirator' => '',
        'expiration'=> 0,
    );

    /**
     * Forms default values storage.
     * @var \stdClass
     */
    protected static $sessionData = NULL;
    /**
     * Forms cross site request forgery protecting hashes storage.
     * @var \stdClass
     */
    protected static $sessionCsrf = NULL;
    /**
     * Forms error messages storage.
     * @var \stdClass
     */
    protected static $sessionErrors = NULL;
    /**
     * Session services configurations by existing classes as keys
     * @var array
     */
    protected static $sessionProviders = array(
        '\MvcCore\Session'  => array(
            'type'          => self::SESSION_PROVIDER_STATIC,
            'callable'      => array('\MvcCore\Session', 'GetNamespace'),
            'expirator'     => 'SetExpirationSeconds',
            'expiration'    => 32872500, // (60 * 60 * 24 * 365.25) -> year
        ),
        'Zend_Session'      => array(
            'type'          => self::SESSION_PROVIDER_INSTANCE,
            'class'         => 'Zend_Session_Namespace',
            'expirator'     => 'setExpirationSeconds',
            'expiration'    => 32872500, // (60 * 60 * 24 * 365.25) -> year
        ),
    );

    /**
     * Static initialization - called at the class end.
     * @return void
     */
    public static function StaticInit () {
        foreach (static::$sessionProviders as $detectedClass => & $configuration) {
            if (class_exists($detectedClass)) {
                static::$SessionProvider = $configuration;
                break;
            }
        }
    }

    /* common helpers ********************************************************************/

    public static function ValidateMaxPostSizeIfNecessary(\MvcCore\Ext\Form & $form) {
        if (strtolower($form->Method) != 'post') return;
        $maxSize = ini_get('post_max_size');
        if (empty($_SERVER['CONTENT_LENGTH'])) {
            $form->AddError(
                sprintf(Form::$DefaultMessages[Form::EMPTY_CONTENT], $maxSize)
            );
            $form->Result = Form::RESULT_ERRORS;
        }
        $units = array('k' => 10, 'm' => 20, 'g' => 30);
        if (isset($units[$ch = strtolower(substr($maxSize, -1))])) {
            $maxSize <<= $units[$ch];
        }
        if ($maxSize > 0 && isset($_SERVER['CONTENT_LENGTH']) && $maxSize < $_SERVER['CONTENT_LENGTH']) {
            $form->AddError(
                sprintf(Form::$DefaultMessages[Form::MAX_POST_SIZE], $maxSize)
            );
            $form->Result = Form::RESULT_ERRORS;
        }
    }

    /* controller -> view ************************************************************/

    /**
     * Get view object from controller object by local configuration.
     * @param \MvcCore\Controller|mixed $controller
     * @return \MvcCore\View|mixed
     */
    public static function GetControllerView (/*\MvcCore\Controller*/ & $controller) {
        $result = NULL;
        $type = static::$ControllerViewProvider['type'];
        $getter = static::$ControllerViewProvider['getter'];
        if ($type == self::CTRL_VIEW_PROVIDER_PROPERTY) {
            $result = $controller->{$getter};
        } else if ($type == self::CTRL_VIEW_PROVIDER_METHOD) {
            $result = $controller->{$getter}();
        }
        return $result;
    }

    /* session ***********************************************************************/

    /**
     * Get form default values by form id.
     * @param string $formId 
     * @return array
     */
    public static function GetSessionData ($formId = '') {
        $sessionData = & static::setUpSessionData();
        if ($formId && isset($sessionData->$formId)) {
            $rawResult = $sessionData->$formId;
            return $rawResult;
        } else {
            return array();
        }
    }
    /**
     * Get form cross site request forgery protecting hashes as array by form id.
     * @param string $formId
     * @return array
     */
    public static function GetSessionCsrf ($formId = '') {
        $sessionCsrf = & static::setUpSessionCsrf();
        if ($formId && isset($sessionCsrf->$formId)) {
            $rawResult = $sessionCsrf->$formId;
            return $rawResult;
        } else {
            return array();
        }
    }
    /**
     * Get form error messages by form id, if there are any keys in array,
     * keys are representing form field names. If there are no keys, messages
     * have common meaning for whole form.
     * @param string $formId
     * @return array
     */
    public static function GetSessionErrors ($formId = '') {
        $sessionErrors = & static::setUpSessionErrors();
        if ($formId && isset($sessionErrors->$formId)) {
            $rawResult = $sessionErrors->$formId;
            return $rawResult;
        } else {
            return array();
        }
    }
    /**
     * Set form default values by form id into session.
     * @param string $formId 
     * @param array $data 
     */
    public static function SetSessionData ($formId = '', $data = array()) {
        $sessionData = & static::setUpSessionData();
        if ($formId) $sessionData->$formId = $data;
    }
    /**
     * Set form cross site request forgery values by form id into session.
     * @param string $formId
     * @param array $data
     */
    public static function SetSessionCsrf ($formId = '', $csrf = array()) {
        $sessionCsrf = & static::setUpSessionCsrf();
        if ($formId) $sessionCsrf->$formId = $csrf;
    }
    /**
     * Set form error messages by form id into session.
     * @param string $formId
     * @param array $data
     */
    public static function SetSessionErrors ($formId = '', $errors = array()) {
        $sessionErrors = & static::setUpSessionErrors();
        if ($formId) $sessionErrors->$formId = $errors;
    }

    /***********************************************************************************/

    protected static function & setUpSessionData () {
        if (static::$sessionData == NULL) static::$sessionData = static::getSessionNamespace('\MvcCore\Ext\Form\Data');
        return static::$sessionData;
    }
    protected static function & setUpSessionCsrf () {
        if (static::$sessionCsrf == NULL) static::$sessionCsrf = static::getSessionNamespace('\MvcCore\Ext\Form\Csrf');
        return static::$sessionCsrf;
    }
    protected static function & setUpSessionErrors () {
        if (self::$sessionErrors == NULL) static::$sessionErrors = static::getSessionNamespace('\MvcCore\Ext\Form\Errors');
        return self::$sessionErrors;
    }
    protected static function & getSessionNamespace ($namespace) {
        $result = new \stdClass;
        $type = static::$SessionProvider['type'];
        if ($type == self::SESSION_PROVIDER_INSTANCE) {
            $class = static::$SessionProvider['class'];
            $result = new $class($namespace);
        } else if ($type == self::SESSION_PROVIDER_STATIC) {
            $result = call_user_func(static::$SessionProvider['callable'], $namespace);
        }
        $expirator = static::$SessionProvider['expirator'];
        $expiration = static::$SessionProvider['expiration'];
        // do not use hoops
        // $result->SetExpirationHoops(1);
        if ($expirator && $expiration) $result->$expirator($expiration);
        return $result;
    }
    protected static function & getSimpleSessionRecord ($namespace) {
        if (!(isset($_SESSION[$namespace]) && !is_null($_SESSION[$namespace]))) {
            $_SESSION[$namespace] = new \stdClass;
        }
        return $_SESSION[$namespace];
    }
}

Namespaces

Classes

Exceptions