ganbarodigital / php-data-containers

src/Editors/MergeIntoAssignable.php

<?php

/**
 * Copyright (c) 2015-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   DataContainers/Editors
 * @author    Stuart Herbert <stuherbert@ganbarodigital.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://code.ganbarodigital.com/php-data-containers
 */

namespace GanbaroDigital\DataContainers\Editors;

use Traversable;
use GanbaroDigital\DataContainers\Containers\DataBag;
use GanbaroDigital\DataContainers\Exceptions\E4xx_UnsupportedType;
use GanbaroDigital\DataContainers\Internal\Checks\ShouldOverwrite;
use GanbaroDigital\Reflection\Checks\IsAssignable;
use GanbaroDigital\Reflection\Checks\IsIndexable;
use GanbaroDigital\Reflection\Checks\IsTraversable;
use GanbaroDigital\Reflection\Requirements\RequireAssignable;
use GanbaroDigital\Reflection\Requirements\RequireTraversable;
use GanbaroDigital\Reflection\ValueBuilders\FirstMethodMatchingType;
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;

class MergeIntoAssignable
{
    /**
     * merge their array into our object
     *
     * @param  object $ours
     *         the object that we want to merge into
     * @param  array|Traversable $theirs
     *         the array that we want to merge from
     * @return void
     */
    public static function fromArray($ours, $theirs)
    {
        // robustness!
        RequireAssignable::check($ours, E4xx_UnsupportedType::class);
        RequireTraversable::check($theirs, E4xx_UnsupportedType::class);

        // copy from them to us
        foreach ($theirs as $key => $value) {
            self::mergeKeyIntoAssignable($ours, $key, $value);
        }

        // all done
    }

    /**
     * merge a single key into our object
     *
     * @param  object $ours
     *         the object to merge into
     * @param  mixed $key
     *         the array key to merge into
     * @param  mixed $value
     *         the data to merge in
     * @return void
     */
    private static function mergeKeyIntoAssignable($ours, $key, $value)
    {
        // general case - overwrite because merging isn't possible
        if (ShouldOverwrite::intoObject($ours, $key, $value)) {
            $ours->$key = $value;
            return;
        }

        // special case - we are merging into an array
        if (IsIndexable::check($ours->$key)) {
            MergeIntoIndexable::from($ours->$key, $value);
            return;
        }

        // at this point, we are merging into an object, using recursion
        // for which I am going to hell
        MergeIntoAssignable::from($ours->$key, $value);
    }

    /**
     * merge their object into our object
     *
     * @param  object $ours
     *         the object that we want to merge into
     * @param  object $theirs
     *         the object that we want to merge from
     * @return void
     */
    public static function fromObject($ours, $theirs)
    {
        // robustness!
        RequireAssignable::check($theirs, E4xx_UnsupportedType::class);
        self::fromArray($ours, get_object_vars($theirs));
    }

    /**
     * merge their data into our object
     *
     * @param  object $ours
     *         the object that we want to merge into
     * @param  array|object $theirs
     *         the data that we want to merge from
     * @return void
     */
    public static function from($ours, $theirs)
    {
        if (IsAssignable::check($theirs)) {
            return self::fromObject($ours, $theirs);

It seems like $theirs defined by parameter $theirs on line 139 can also be of type array; however, GanbaroDigital\DataContainers\Editors\MergeIntoAssignable::fromObject() does only seem to accept object, maybe add an additional type check?

        }

        if (IsTraversable::check($theirs)) {
            return self::fromArray($ours, $theirs);

It seems like $theirs defined by parameter $theirs on line 139 can also be of type object; however, GanbaroDigital\DataContainers\Editors\MergeIntoAssignable::fromArray() does only seem to accept array|object<Traversable>, maybe add an additional type check?

        }

        // cannot merge anything that reaches here!
        throw new E4xx_UnsupportedType(SimpleType::from($ours));
    }

    /**
     * merge their data into our object
     *
     * @deprecated since 2.2.0
     * @codeCoverageIgnore
     *
     * @param  object $ours
     *         the object that we want to merge into
     * @param  array|object $theirs
     *         the data that we want to merge from
     * @return void
     */
    public static function fromMixed($ours, $theirs)
    {
        return self::from($ours, $theirs);
    }

    /**
     * merge their data into our object
     *
     * @param  object $ours
     *         the object that we want to merge into
     * @param  array|object $theirs
     *         the data that we want to merge from
     * @return void
     */
    public function __invoke($ours, $theirs)
    {
        return self::from($ours, $theirs);
    }
}