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: 

<?php
namespace Nethgui\Adapter;

/*
 * Copyright (C) 2012 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/>.
 */

/**
 * Handles record-like operations for a database.
 * 
 * The internal value is an hash of values
 * 
 * States: 
 * NEW, CLEAN, MODIFIED:{DELETED, DIRTY}
 * 
 * Transactions:
 * CREATED -> CLEAN
 * CREATED -> DIRTY, when the key has been set and does not exist in arr
 * CLEAN -> DIRTY -> DELETED
 * CLEAN -> DELETED
 * DIRTY -> CLEAN
 *
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 */
class RecordAdapter implements \Nethgui\Adapter\AdapterInterface, \ArrayAccess, \IteratorAggregate
{
    const CREATED = 0;
    const CLEAN = 1;
    const DIRTY = 2;
    const DELETED = 3;

    /**
     * The records container
     * @var \ArrayAccess
     */
    protected $arr;

    /**
     *
     * @var string
     */
    private $keyValue = NULL;

    /**
     *
     * @var bool
     */
    private $state = 0;

    /**
     * This is our record, the fields container
     * @var \ArrayObject
     */
    private $data = NULL;

    public function __construct(\ArrayAccess $arr = NULL)
    {
        $this->arr = $arr;
        $this->data = new \ArrayObject();
    }

    public function setTableData(\ArrayAccess $arr)
    {
        $this->arr = $arr;
        return $this;
    }

    public function setKeyValue($value)
    {
        if ($value === $this->keyValue) {
            return $this;
        } elseif (isset($this->keyValue)) {
            throw new \LogicException(sprintf('%s: the record key is already set', __CLASS__), 1336463530);
        }
        $this->keyValue = $value;

        // put the missing tableAdapter values into the current data:
        $this->mergeTableData();

        return $this;
    }

    public function getKeyValue()
    {
        return $this->keyValue;
    }

    public function delete()
    {
        $this->state = self::DELETED;
    }

    public function get()
    {
        return $this->data->getArrayCopy();
    }

    public function isModified()
    {
        return $this->state === self::DIRTY || $this->state === self::DELETED;
    }

    public function save()
    {
        if (is_null($this->arr)) {
            throw new \LogicException(sprintf('%s: you must setTableData() before save().', __CLASS__), 1354113867);
        }

        if ( ! $this->isModified()) {
            return FALSE;
        }
        
        if (is_null($this->getKeyValue())) {
            throw new \LogicException(sprintf('%s: you must setKeyValue() before save().', __CLASS__), 1336388582);
        }

        if ($this->state === self::DELETED) {
            $this->arr->offsetUnset($this->getKeyValue());
            $this->data = new \ArrayObject();
            //$this->keyValue = NULL;
        } else {
            $this->mergeTableData();
            $this->arr->offsetSet($this->getKeyValue(), $this->data->getArrayCopy());
        }

        $this->state = self::CLEAN;
    }

    public function set($value)
    {
        if (is_array($value)) {
            $value = new \ArrayObject($value);
        }

        if ( ! $value instanceof \Traversable) {
            throw new \InvalidArgumentException(sprintf('%s: the $value must be an array or an instance of Traversable interface', __CLASS__), 1336388598);
        }

        foreach ($value as $propName => $propValue) {
            $this->offsetSet($propName, $propValue);
        }
    }

    public function offsetExists($offset)
    {
        return $this->data->offsetExists($offset);
    }

    public function offsetGet($offset)
    {
        return $this->data->offsetGet($offset);
    }

    public function offsetSet($offset, $value)
    {
        if ( ! $this->offsetExists($offset) ||
            $this->offsetGet($offset) !== $value) {
            $this->data->offsetSet($offset, $value);
            if ($this->state !== self::DELETED) {
                $this->state = self::DIRTY;
            }
        }
    }

    public function offsetUnset($offset)
    {
        $this->data->offsetUnset($offset);
    }

    public function getIterator()
    {
        return $this->data->getIterator();
    }

    private function mergeTableData()
    {
        $keyValue = $this->getKeyValue();

        // Nothing to do if setTableData() has not been called
        if ($this->arr === NULL) {
            return;
        }

        // Mark record as modified if we are a new record
        if ( ! $this->arr->offsetExists($keyValue)) {
            $this->state = self::DIRTY;
            return;
        }

        // DB fields are transfered into the object storage. Record state
        // is unchanged and existing values are retained.
        foreach ($this->arr->offsetGet($keyValue) as $key => $value) {
            if ( ! $this->data->offsetExists($key)) {
                $this->data->offsetSet($key, $value);
            }
        }
    }

}