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: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 

<?php

/**
 * This file is part of the Lean Mapper library (http://www.leanmapper.com)
 *
 * Copyright (c) 2013 Vojtěch Kohout (aka Tharos)
 *
 * For the full copyright and license information, please view the file
 * license-mit.txt that was distributed with this source code.
 */

namespace LeanMapper;

use Closure;
use DibiConnection;
use DibiRow;
use LeanMapper\Exception\InvalidArgumentException;
use LeanMapper\Exception\InvalidStateException;

/**
 * Set of related data
 *
 * @author Vojtěch Kohout
 */
class Result implements \Iterator
{

    /** @var array */
    private $data;

    /** @var array */
    private $modified = array();

    /** @var string */
    private $table;

    /** @var array */
    private $keys;

    /** @var DibiConnection */
    private $connection;

    /** @var array */
    private $referenced = array();

    /** @var array */
    private $referencing = array();

    /** @var array */
    private $detached = array();


    /**
     * Creates new common instance (it means persisted)
     *
     * @param DibiRow|DibiRow[] $data
     * @param string $table
     * @param DibiConnection $connection
     * @return self
     * @throws InvalidArgumentException
     */
    public static function getInstance($data, $table, DibiConnection $connection)
    {
        $dataArray = array();
        if ($data instanceof DibiRow) {
            $dataArray = array(isset($data->id) ? $data->id : 0 => $data->toArray());
        } elseif (is_array($data)) {
            foreach ($data as $record) {
                if (isset($record->id)) {
                    $dataArray[$record->id] = $record->toArray();
                } else {
                    $dataArray[] = $record->toArray();
                }
            }
        } else {
            throw new InvalidArgumentException('Invalid type of data given, only DibiRow or array of DibiRow is supported at this moment.');
        }
        return new self($dataArray, $table, $connection);
    }

    /**
     * Creates new detached instance (it means non-persisted)
     *
     * @return self
     */
    public static function getDetachedInstance()
    {
        return new self;
    }

    /**
     * Creates new LeanMapper\Row instance pointing to requested row in LeanMapper\Result
     *
     * @param int $id
     * @return Row|null
     */
    public function getRow($id = 0)
    {
        if (!isset($this->data[$id])) {
            return null;
        }
        return new Row($this, $id);
    }

    /**
     * Returns data of given field from row with given id
     *
     * @param int $id
     * @param string $key
     * @return mixed
     * @throws InvalidArgumentException
     */
    public function getDataEntry($id, $key)
    {
        if (!isset($this->data[$id]) or !array_key_exists($key, $this->data[$id])) {
            throw new InvalidArgumentException("Missing '$key' value for requested row.");
        }
        return $this->data[$id][$key];
    }

    /**
     * Sets data of given field in row with given id
     *
     * @param int $id
     * @param string $key
     * @param mixed $value
     * @throws InvalidArgumentException
     */
    public function setDataEntry($id, $key, $value)
    {
        if (!isset($this->data[$id])) {
            throw new InvalidArgumentException("Missing row with ID $id.");
        }
        if (!$this->isDetached($id) and !array_key_exists($key, $this->data[$id])) {
            throw new InvalidArgumentException("Missing field '$key' in row.");
        }
        if ($key === 'id' and !$this->isDetached($id)) {
            throw new InvalidArgumentException("ID can only be set in detached rows.");
        }
        $this->modified[$id][$key] = true;
        $this->data[$id][$key] = $value;
    }

    /**
     * Tells whether requested row is modified state
     *
     * @param int $id
     * @return bool
     */
    public function isModified($id)
    {
        return isset($this->modified[$id]) and !empty($this->modified[$id]);
    }

    /**
     * Tells whether requested row is in detached state (like newly created row)
     *
     * @param int $id
     * @return bool
     */
    public function isDetached($id)
    {
        return !isset($this->data[$id]) or isset($this->detached[$id]);
    }

    /**
     * Marks requested row as detached (it means non-persisted)
     *
     * @param int $id
     * @throws InvalidArgumentException
     */
    public function detach($id)
    {
        if (!isset($this->data[$id])) {
            throw new InvalidArgumentException("Missing row with ID $id.");
        }
        if ($this->isDetached($id)) {
            throw new InvalidArgumentException("Row with ID $id is already detached.");
        }
        $this->detached[$id] = true;
        foreach ($this->data[$id] as $field => $value) {
            $this->modified[$id][$field] = true;
        }
    }

    /**
     * Marks requested row as non-updated (isModified($id) returns false right after this method call)
     *
     * @param int $id
     */
    public function markAsUpdated($id)
    {
        if (isset($this->modified[$id])) {
            unset($this->modified[$id]);
        }
    }

    /**
     * Marks requested row as persisted
     *
     * @param int $newId
     * @param int $oldId
     * @param string $table
     * @param DibiConnection $connection
     * @throws InvalidStateException
     */
    public function markAsCreated($newId, $oldId, $table, DibiConnection $connection)
    {
        if (!$this->isDetached($oldId)) {
            throw new InvalidStateException('Result is not in detached state.');
        }
        $this->data = array($newId => array('id' => $newId) + $this->getModifiedData($oldId));
        foreach (array($newId, $oldId) as $key) {
            unset($this->modified[$key]);
            unset($this->detached[$key]);
        }
        $this->table = $table;
        $this->connection = $connection;
    }

    /**
     * Returns array of modified fields of requested row with new values
     *
     * @param int $id
     * @return array
     */
    public function getModifiedData($id)
    {
        $result = array();
        if (isset($this->modified[$id])) {
            foreach (array_keys($this->modified[$id]) as $field) {
                $result[$field] = $this->data[$id][$field];
            }
        }
        return $result;
    }

    /**
     * Creates new LeanMapper\Row instance pointing to requested row in referenced result
     *
     * @param int $id
     * @param string $table
     * @param callable|null $filter
     * @param string|null $viaColumn
     * @throws InvalidStateException
     * @return Row
     */
    public function getReferencedRow($id, $table, Closure $filter = null, $viaColumn = null)
    {
        if ($this->connection === null) {
            throw new InvalidStateException('Cannot get referenced row for result without DibiConnection instance.');
        }
        if ($viaColumn === null) {
            $viaColumn = $table . '_id';
        }
        return $this->getReferencedResult($table, $viaColumn, $filter)
                ->getRow($this->getDataEntry($id, $viaColumn));
    }

    /**
     * Creates new array of LeanMapper\Row instances pointing to requested row in referencing result
     *
     * @param int $id
     * @param string $table
     * @param callable|null $filter
     * @param string|null $viaColumn
     * @throws InvalidStateException
     * @return Row[]
     */
    public function getReferencingRows($id, $table, Closure $filter = null, $viaColumn = null)
    {
        if ($this->connection === null or $this->table === null) {
            throw new InvalidStateException('Cannot get referencing rows for detached result.');
        }
        if ($viaColumn === null) {
            $viaColumn = $this->table . '_id';
        }
        $collection = $this->getReferencingResult($table, $viaColumn, $filter);
        $rows = array();
        foreach ($collection as $key => $row) {
            if ($row[$viaColumn] === $id) {
                $rows[] = new Row($collection, $key);
            }
        }
        return $rows;
    }

    /**
     * Clean in-memory cache of referenced results
     *
     * @param string|null $table
     * @param string|null $column
     */
    public function cleanReferencedResultsCache($table = null, $column = null)
    {
        if ($table === null or $column === null) {
            $this->referenced = array();
        } else {
            foreach ($this->referenced as $key => $value) {
                if (preg_match("~^$table\\($column\\)(#.*)?$~", $key)) {
                    unset($this->referenced[$key]);
                }
            }
        }
    }

    //========== interface \Iterator ====================

    /**
     * @return mixed
     */
    public function current()
    {
        $key = current($this->keys);
        return $this->data[$key];
    }

    public function next()
    {
        next($this->keys);
    }

    /**
     * @return int
     */
    public function key()
    {
        return current($this->keys);
    }

    /**
     * @return bool
     */
    public function valid()
    {
        return current($this->keys) !== false;
    }

    public function rewind()
    {
        $this->keys = array_keys($this->data);
        reset($this->keys);
    }

    ////////////////////
    ////////////////////

    /**
     * @param array|null $data
     * @param string|null $table
     * @param DibiConnection|null $connection
     */
    private function __construct(array $data = null, $table = null, DibiConnection $connection = null)
    {
        if ($data === null) {
            $data = array(array());
        }
        $this->data = $data;
        $this->table = $table;
        $this->connection = $connection;
        if (func_num_args() === 0) {
            $this->detached[0] = true;
        }
    }

    /**
     * @param string $table
     * @param string $viaColumn
     * @param Closure|null $filter
     * @return self
     */
    private function getReferencedResult($table, $viaColumn, Closure $filter = null)
    {
        $key = "$table($viaColumn)";
        $statement = $this->connection->select('*')->from($table);

        if ($filter === null) {
            if (!isset($this->referenced[$key])) {
                $data = $statement->where('%n.[id] IN %in', $table, $this->extractReferencedIds($viaColumn))
                        ->fetchAll();
                $this->referenced[$key] = self::getInstance($data, $table, $this->connection);
            }
        } else {
            $statement->where('%n.[id] IN %in', $table, $this->extractReferencedIds($viaColumn));
            $filter($statement);

            $sql = (string) $statement;
            $key .= '#' . md5($sql);

            if (!isset($this->referenced[$key])) {
                $this->referenced[$key] = self::getInstance($this->connection->query($sql)->fetchAll(), $table, $this->connection);
            }
        }
        return $this->referenced[$key];
    }

    /**
     * @param string $table
     * @param string $viaColumn
     * @param Closure|null $filter
     * @return self
     */
    private function getReferencingResult($table, $viaColumn, Closure $filter = null)
    {
        $key = "$table($viaColumn)";
        $statement = $this->connection->select('*')->from($table);

        if ($filter === null) {
            if (!isset($this->referencing[$key])) {
                $data = $statement->where('%n.%n IN %in', $table, $viaColumn, $this->extractReferencedIds())
                        ->fetchAll();
                $this->referencing[$key] = self::getInstance($data, $table, $this->connection);
            }
        } else {
            $statement->where('%n.%n IN %in', $table, $viaColumn, $this->extractReferencedIds());
            $filter($statement);

            $sql = (string)$statement;
            $key .= '#' . md5($sql);

            if (!isset($this->referencing[$key])) {
                $this->referencing[$key] = self::getInstance($this->connection->query($sql)->fetchAll(), $table, $this->connection);
            }
        }
        return $this->referencing[$key];
    }

    /**
     * @param string $column
     * @return array
     */
    private function extractReferencedIds($column = 'id')
    {
        $ids = array();
        foreach ($this->data as $data) {
            if ($data[$column] === null) continue;
            $ids[$data[$column]] = true;
        }
        return array_keys($ids);
    }

}