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: 

<?php
namespace Nethgui\Adapter;

/*
 * 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/>.
 */

/**
 * The TabularValueAdapter provide an array interface to access tabular data 
 * encoded into a value stored in a key or prop.
 * 
 * The encoding uses two distinct string separators to divide the logical rows and
 * split each row into logical columns.
 * 
 * Note implementation applies Decorator Pattern to ArrayAdapter
 * 
 * @api
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 */
class TabularValueAdapter implements \Nethgui\Adapter\AdapterInterface, \ArrayAccess, \IteratorAggregate, \Countable
{

    /**
     * @var ArrayAdapter
     */
    private $innerAdapter;

    /**
     *
     * @var ArrayObject
     */
    private $data;
    private $modified;
    private $columnSeparator;

    public function __construct(ArrayAdapter $innerAdapter, $columnSeparator)
    {
        $this->innerAdapter = $innerAdapter;
        $this->columnSeparator = $columnSeparator;
    }

    private function lazyInitialization()
    {
        $this->data = new \ArrayObject();
        
        foreach ($this->innerAdapter as $rawRow) {
            $row = explode($this->columnSeparator, $rawRow);
            $key = array_shift($row);
            $this->data[$key] = $row;
        }

        $this->modified = FALSE;
    }

    public function count()
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        return $this->data->count();
    }

    public function delete()
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        if (count($this->data) != 0) {
            $this->modified = TRUE;
            $this->data = new \ArrayObject();
        }
    }

    public function get()
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        return $this->data;
    }

    public function set($value)
    {
        $this->data = new \ArrayObject();
        $this->modified = TRUE;

        if ( ! is_array($value) && ! $value instanceof \Traversable) {
            throw new \InvalidArgumentException(sprintf('%s: Value must be an array or a Traversable object!', __CLASS__), 1322149790);
        }

        foreach ($value as $key => $row) {
            if ( ! is_array($row)) {
                throw new \InvalidArgumentException(sprintf('%s: Value must be an array of arrays!', __CLASS__), 1322149791);
            }
            $this[$key] = $row;
        }
    }

    public function save()
    {
        if ( ! $this->isModified()) {
            return FALSE;
        }

        $value = array();

        foreach ($this->data as $key => $row) {
            $value[] = implode($this->columnSeparator, array_merge(array($key), $row));
        }

        $this->innerAdapter->set($value);

        $saved = $this->innerAdapter->save();

        $this->modified = FALSE;

        return $saved;
    }

    public function getIterator()
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        return $this->data->getIterator();
    }

    public function isModified()
    {
        return $this->modified === TRUE;
    }

    public function offsetExists($offset)
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

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

    public function offsetGet($offset)
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

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

    public function offsetSet($offset, $value)
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        if ( ! is_array($value) && ! $value instanceof \Traversable) {
            throw new \InvalidArgumentException(sprintf('%s: Value must be an array or a Traversable object!', __CLASS__), 1322149888);
        }

        $this->modified = TRUE;

        $this->data->offsetSet($offset, $value);
    }

    public function offsetUnset($offset)
    {
        if ( ! isset($this->data)) {
            $this->lazyInitialization();
        }

        if ($this->data->offsetExists($offset)) {
            unset($this->data[$offset]);
            $this->modified = TRUE;
        }
    }

}