apparat/object

<?php

/**
 * apparat/object
 *
 * @category    Apparat
 * @package     Apparat\Server
 * @subpackage  Apparat\Object\Application\Model\Properties
 * @author      Joschi Kuphal <joschi@tollwerk.de> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@tollwerk.de> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Application\Model\Properties\Domain;

use Apparat\Kernel\Ports\Kernel;

/**
 * Abstract domain properties
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Application
 */
abstract class AbstractDomainProperties extends \Apparat\Object\Domain\Model\Properties\AbstractDomainProperties
{
    /**
     * Name
     *
     * @var string
     */
    const NAME = 'name';
    /**
     * Publication date & time
     *
     * @var string
     */
    const PUBLISHED = 'published';
    /**
     * Modification date & time
     *
     * @var string
     */
    const UPDATED = 'updated';
    /**
     * Authors
     *
     * @var string
     */
    const AUTHOR = 'author';
    /**
     * Categories
     *
     * @var string
     */
    const CATEGORY = 'category';
    /**
     * URL
     *
     * @var string
     */
    const URL = 'url';
    /**
     * UID
     *
     * @var string
     */
    const UID = 'uid';
    /**
     * Location
     *
     * @var string
     */
    const LOCATION = 'location';
    /**
     * Syndication URLs
     *
     * @var string
     */
    const SYNDICATION = 'syndication';

    /**
     * Set a property value by path list and base data
     *
     * @param array $propertyPath Path list
     * @param array $propertyTree Base data
     * @param mixed $value Property value
     * @return AbstractDomainProperties Self reference
     */
    protected function setPropertyPath(array $propertyPath, array $propertyTree, $value)
    {
        // Traverse the property tree and find the property node to set
        $created = false;
        $propertyModel = null;
        $data =& $this->findPropertyNode($propertyPath, $propertyTree, $created, $propertyModel);

        // If a new property is created with a non-empty value or an existing property is altered: Mutate
        if ($created ? !empty($value) : !$this->assertEquals($data, $value)) {
            $this->setPropertyValue($data, $value, $propertyPath, $propertyModel);
            return new static($propertyTree, $this->object);
        }

        return $this;
    }

    /**
     * Traverse the property tree and return a node
     *
     * @param array $propertyPath Property name path
     * @param array $propertyTree Copy of the current property tree
     * @param boolean $created Property has been created
     * @param PropertyModel $propertyModel Property model
     * @return mixed Property node
     * @throws DomainException If an invalid subproperty should be allocated
     */
    protected function &findPropertyNode(
        array $propertyPath,
        array &$propertyTree,
        &$created,
        PropertyModel &$propertyModel = null
    ) {
        $propertyModel = null;
        $propertyModelName = 'pm';
        $propertyPathSteps = [];
        $data =& $propertyTree;

        // Run through all sub-properties
        foreach ($propertyPath as $property) {
            // If an invalid sub-property should be allocated
            if ($propertyModel !== null) {
                throw new DomainException(
                    sprintf(
                        'Property data model of "%s" does not allow sub-properties',
                        implode(self::PROPERTY_TRAVERSAL_SEPARATOR, $propertyPathSteps)
                    ),
                    DomainException::INVALID_DOMAIN_SUBPROPERTY
                );
            }

            $propertyPathSteps[] = $property;
            $propertyModelName .= ucfirst($property);
            /** @var PropertyModel $propertyModel */
            $propertyModel = isset($this->$propertyModelName) ?
                Kernel::create(PropertyModel::class, array_merge([$this->object], $this->$propertyModelName)) : null;

            // If the sub-property doesn't exist
            if (!array_key_exists($property, $data)) {
                $data[$property] = (($propertyModel === null) || $propertyModel->isMultivalue()) ? [] : null;
                $created = true;
            }

            $data =& $data[$property];
        }

        return $data;
    }

    /**
     * Set a property value
     *
     * @param mixed $property Property
     * @param mixed $value Value
     * @param array $propertyPath Property path
     * @param PropertyModel $propertyModel Property model
     */
    protected function setPropertyValue(
        &$property,
        $value,
        array $propertyPath = null,
        PropertyModel $propertyModel = null
    ) {
        // If the property path is not empty
        if (is_array($propertyPath) && count($propertyPath)) {
            // Filter the value if a property model is given
            if ($propertyModel) {
                $value = $propertyModel->filterValue($value);
            }

            // Determine the setter name
            $propertySetter = 'setPm'.implode(array_map('ucfirst', $propertyPath));

            // If there's an explicit setter for this property: Use it
            if (is_callable([$this, $propertySetter])) {
                $this->$propertySetter($property, $value);
                return;
            }

            $property = $value;
        }
    }
}