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: 

<?php
namespace Nethgui\Controller\Table;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Processes the table modification actions: create, update, delete
 *
 * @see Read
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 * @api
 */
class Modify extends \Nethgui\Controller\Table\RowAbstractAction
{

    /**
     * Create a Modify instance that realizes one of the allowed behaviours:
     * 
     * - create
     * - delete
     * - update
     * 
     * @param string $identifier One of 'create', 'delete', 'update'
     * @param array $parameterSchema - DEPRECATED
     * @param mixed $viewTemplate - DEPRECATED 
     * @throws \InvalidArgumentException 
     */
    public function __construct($identifier, $parameterSchema = NULL, $viewTemplate = NULL)
    {
        if ( ! in_array($identifier, array('create', 'delete', 'update'))) {
            throw new \InvalidArgumentException(sprintf('%s: Module identifier must be one of `create`, `delete`, `update` values.', get_class($this)), 1322149372);
        }

        parent::__construct($identifier);

        if ( ! is_null($viewTemplate)) {
            $this->setViewTemplate($viewTemplate);
        }

        if ( ! is_null($parameterSchema)) {
            $this->setSchema($parameterSchema);
        }
    }

    /**
     * Establish what is the key value, then invoke setKeyValue() on the 
     * RecordAdapter BEFORE parent::bind()
     * 
     * @param \Nethgui\Controller\RequestInterface $request 
     */
    public function bind(\Nethgui\Controller\RequestInterface $request)
    {
        if ($this->getIdentifier() === 'create') {
            if ($request->isMutation()) {
                $keyValue = $this->calculateKeyFromRequest($request);
            } else {
                $keyValue = FALSE;
            }
        } else {
            $keyValue = implode('/', $request->getPath());
            $this->ensureKeyExists($keyValue);
        }

        // bind the record adapter to the row with identifier equal to $keyValue
        if (is_null($this->getAdapter()->getKeyValue())) {
            $this->getAdapter()->setKeyValue($keyValue);
        }

        parent::bind($request);       
    }

    protected function ensureKeyExists($keyValue) {
        // FIXME: use orginalAdapter member from parent class (?)
        if( ! $this->getParent()->getAdapter()->offsetExists($keyValue) ) {
            throw new \Nethgui\Exception\HttpException('Not found', 404, 1352715526);
        }
        return TRUE;
    }

    /**
     * Calculate the key value for a new record from the given $request 
     * object.
     * 
     * Override this function whenever the key value requires some kind of 
     * processing to be calculated.
     * 
     * @api
     * @param \Nethgui\Controller\RequestInterface $request
     * @return string
     */
    protected function calculateKeyFromRequest(\Nethgui\Controller\RequestInterface $request)
    {
        return $request->getParameter($this->getKey());
    }

    public function process()
    {
        if ( ! $this->getRequest()->isMutation()) {
            return;
        }

        $action = $this->getIdentifier();
        $key = $this->getAdapter()->getKeyValue();

        if ($action == 'delete') {
            $this->processDelete($key);
        } elseif ($action == 'create') {
            $this->processCreate($key);
        } elseif ($action == 'update') {
            $this->processUpdate($key);
        } else {
            throw new \Nethgui\Exception\HttpException('Not found', 404, 1322148408);
        }

        $changes = $this->parameters->getModifiedKeys();

        if ($this->saveParameters()) {
            $this->onParametersSaved($changes);
            $this->getParent()->onParametersSaved($this, $changes, $this->parameters->getArrayCopy());
        }
    }

    protected function processDelete($key)
    {
        $this->getAdapter()->delete();
    }

    protected function processCreate($key)
    {
        
    }

    protected function processUpdate($key)
    {
        
    }

    public function prepareView(\Nethgui\View\ViewInterface $view)
    {
        parent::prepareView($view);
        if ($view->getTargetFormat() === $view::TARGET_XHTML) {
            $view['__key'] = $this->getKey();
        }
    }

    /**
     * Set the default parameter values in "create" action
     *
     * Call before bind()
     *
     * @param array $defaultValues
     * @return Modify
     */
    public function setCreateDefaults($defaultValues)
    {
        foreach ($defaultValues as $parameterName => $value) {
            $this->setDefaultValue($parameterName, $value);
        }
        return $this;
    }

}