View source: [ raw ] [ highlight ]

View on GitHub open_in_new

Below is the content for the selected file.

Class: \District5\Mondoc\Db\Service\Traits\Operators\PullTrait

<?php
/**
 * District5 Mondoc Library
 *
 * @author      District5 <hello@district5.co.uk>
 * @copyright   District5 <hello@district5.co.uk>
 * @link        https://www.district5.co.uk
 *
 * MIT LICENSE
 *
 * 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 District5\Mondoc\Db\Service\Traits\Operators;

use District5\Mondoc\Exception\MondocConfigConfigurationException;
use MongoDB\BSON\ObjectId;

/**
 * Trait PullTrait.
 *
 * @package District5\Mondoc\Db\Service\Traits\Operators
 */
trait PullTrait
{
    /**
     * Remove a normalised (not object or array) value from an array on via an atomic operation.
     *
     * @param array $filter
     * @param string $field
     * @param mixed $value
     * @return bool
     * @throws MondocConfigConfigurationException
     * @noinspection PhpUnused
     */
    protected static function pullFromArrayWithFilter(array $filter, string $field, mixed $value): bool
    {
        return self::updateOne(
            $filter, // Formatted in the updateOne method
            [
                '$pull' => [$field => $value]
            ]
        );
    }

    /**
     * Remove a single normalised (not object or array) value from an array on a single document via an atomic
     * operation.
     *
     * @param ObjectId $id
     * @param string $field
     * @param string|int|bool $value
     * @return bool
     * @throws MondocConfigConfigurationException
     * @noinspection PhpUnused
     */
    protected static function pullFromArrayById(ObjectId $id, string $field, mixed $value): bool
    {
        $filter = [
            '_id' => $id
        ];
        return self::updateOne(
            $filter, // Formatted in the updateOne method
            [
                '$pull' => [$field => $value]
            ]
        );
    }
}

Back to Mondoc sourcefast_rewind