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: 

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

/**
 * Array adapter maps a PHP array-like interface to a key or prop value
 * where values are separated by a separator character.
 *
 * @api
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 */
class ArrayAdapter implements AdapterInterface, \ArrayAccess, \IteratorAggregate, \Countable
{
    /**
     * The character used as separator to encode/decode the array string value.
     * @var string
     */
    private $separator;

    /**
     * This boolean is indeed a tri-state value, where NULL indicates
     * that object state is uninitialized.
     * @var boolean
     */
    private $modified;

    /**
     * Keeps the array values.
     * @var ArrayObject
     */
    private $data;

    /**
     *
     * @var \Nethgui\Serializer\SerializerInterface
     */
    private $serializer;

    public function __construct($separator, \Nethgui\Serializer\SerializerInterface $serializer)
    {
        $this->separator = $separator;
        $this->serializer = $serializer;
    }

    public function get()
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if (is_null($this->data)) {
            return NULL;
        }

        return $this->data;
    }

    public function set($value)
    {

        if ( ! (is_array($value) || empty($value))) {
            throw new \InvalidArgumentException(sprintf('%s: Invalid data type. Expected `array` or `EMPTY`, was `%s`', get_class($this), gettype($value)), 1322148826);
        }

        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        // handle set-NULL
        if ($value === NULL) {
            if ($this->data === NULL) {
                // nothing to do
            } else {
                $this->modified = TRUE;
                $this->data = NULL;
            }
            return;
        }

        // empty string translated to empty array
        if ($value === '') {
            $value = array();
        }

        if (is_null($this->data)) {
            $this->data = new \ArrayObject($value);
            $this->modified = TRUE;
        } elseif ($this->data->getArrayCopy() !== $value) {
            $this->data->exchangeArray($value);
            $this->modified = TRUE;
        }
    }

    public function delete()
    {
        $this->set(NULL);
    }

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

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

        if (is_object($this->data)) {
            $value = implode($this->separator, $this->data->getArrayCopy());
        } else {
            $value = NULL;
        }

        $this->serializer->write($value);

        $this->modified = FALSE;

        return TRUE;
    }

    public function count()
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if (is_null($this->data)) {
            return 0;
        }

        return count($this->data);
    }

    public function getIterator()
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if (is_null($this->data)) {
            return new \ArrayIterator(array());
        }

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

    public function offsetExists($offset)
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }
        return is_object($this->data) && $this->data->offsetExists($offset);
    }

    public function offsetGet($offset)
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if ($this->offsetExists($offset)) {
            return $this->data[$offset];
        }

        return NULL;
    }

    public function offsetSet($offset, $value)
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

        if (is_null($this->data)) {
            $this->data = new \ArrayObject();
        }

        $this->data[$offset] = $value;
        $this->modified = TRUE;
    }

    public function offsetUnset($offset)
    {
        if (is_null($this->modified)) {
            $this->lazyInitialization();
        }

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

    private function lazyInitialization()
    {
        $value = $this->serializer->read();

        if (is_null($value)) {
            $this->data = NULL;
        } elseif ($value === '') {
            $this->data = new \ArrayObject();
        } else {
            $this->data = new \ArrayObject(explode($this->separator, $value));
        }

        $this->modified = FALSE;
    }

}