appwrite/src/Database/Document.php

<?php

namespace Database;

use ArrayObject;

class Document extends ArrayObject
{
    const SET_TYPE_ASSIGN   = 'assign';
    const SET_TYPE_PREPEND  = 'prepend';
    const SET_TYPE_APPEND   = 'append';

    /**
     * Construct
     *
     * Construct a new fields object
     *
     * @see ArrayObject::__construct
     * @param null $input
     * @param int $flags
     * @param string $iterator_class
     */
    public function __construct($input = null, $flags = 0, $iterator_class = "ArrayIterator")
    {
        foreach($input as $key => &$value) {
            if(is_array($value)) {
                if(isset($value['$uid']) || isset($value['$collection'])){
                    $input[$key] = new self($value);
                }
                else {
                    foreach ($value as $childKey => $child) {
                        if(isset($child['$uid']) || isset($child['$collection'])){
                            $value[$childKey] = new self($child);
                        }
                    }
                }
            }
        }

        parent::__construct($input, $flags, $iterator_class);
    }

    /**
     * @return string|null
     */
    public function getUid()
    {
        return $this->getAttribute('$uid', null);
    }

    /**
     * @return int|null
     */
    public function getCollection()
    {
        return $this->getAttribute('$collection', null);
    }

    /**
     * @return array
     */
    public function getPermissions()
    {
        return $this->getAttribute('$permissions', []);
    }

    /**
     * Get Attribute
     *
     * Method for getting a specific fields attribute. If $name is not found $default value will be returned.
     *
     * @param  string $name
     * @param  mixed  $default
     * @return mixed
     */
    public function getAttribute($name, $default = null)
    {
        $name = explode('.', $name);

        $temp = &$this;

        foreach($name as $key) {
            if(!isset($temp[$key])) {
                return $default;
            }

            $temp = &$temp[$key];
        }

        return $temp;
    }

    /**
     * Set Attribute
     *
     * Method for setting a specific field attribute
     *
     * @param  string $key
     * @param  mixed $value
     * @param string $type
     * @return mixed
     */
    public function setAttribute($key, $value, $type = self::SET_TYPE_ASSIGN)
    {
        switch ($type) {
            case self::SET_TYPE_ASSIGN:
                $this[$key] = $value;
                break;
            case self::SET_TYPE_APPEND:
                $this[$key] = (!isset($this[$key]) || !is_array($this[$key])) ? [] : $this[$key];
                array_push($this[$key], $value);
                break;
            case self::SET_TYPE_PREPEND:
                $this[$key] = (!isset($this[$key]) || !is_array($this[$key])) ? [] : $this[$key];
                array_unshift($this[$key], $value);
                break;
        }

        return $this;
    }

    /**
     * Search
     *
     * Get array child by key and value match
     *
     * @param $key
     * @param $value
     * @param array|null $scope
     * @return Document|Document[]|mixed|null|array
     */
    public function search($key, $value, $scope = null)
    {
        $array = (!is_null($scope)) ? $scope : $this;

        if(is_array($array)  || $array instanceof self) {
            if(isset($array[$key]) && $array[$key] == $value) {
                return $array;
            }

            foreach ($array as $k => $v) {
                if((is_array($v) || $v instanceof self) && (!empty($v))) {
                    $result = $this->search($key, $value, $v);

                    if(!empty($result)) {
                        return $result;
                    }
                }
                else {
                    if ($k === $key && $v === $value) {
                        return $array;
                    }
                }
            }
        }

        if($array === $value) {
            return $array;
        }

        return null;
    }

    /**
     * Checks if document has data
     *
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->getUid());
    }

    /**
     * Get Array Copy
     *
     * Outputs entity as a PHP array
     *
     * @param array $whitelist
     * @param array $blacklist
     * @return array
     */
    public function getArrayCopy(array $whitelist = [], array $blacklist = [])
    {
        $array = parent::getArrayCopy();

        $output = array();

        foreach ($array as $key => &$value) {
            if(!empty($whitelist) && !in_array($key, $whitelist)) { // Export only whitelisted fields
                continue;
            }

            if(!empty($blacklist) && in_array($key, $blacklist)) { // Don't export blacklisted fields
                continue;
            }

            if ($value instanceof self) {
                $output[$key] = $value->getArrayCopy($whitelist, $blacklist);
            }
            elseif (is_array($value)) {
                foreach ($value as $childKey => &$child) {
                    if ($child instanceof self) {
                        $output[$key][$childKey] = $child->getArrayCopy($whitelist, $blacklist);
                    }
                    else {
                        $output[$key][$childKey] = $child;
                    }
                }

                if(empty($value)) {
                    $output[$key] = $value;
                }
            }
            else {
                $output[$key] = $value;
            }
        }

        return $output;
    }
}