itstructure / yii2-multi-format-uploader

src/models/Owner.php

<?php

namespace Itstructure\MFUploader\models;

use yii\db\ActiveQuery;
use yii\base\InvalidArgumentException;

The type yii\base\InvalidArgumentException was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * This is the base class for owners.
 *
 * @property int $ownerId Owner id.
 * @property string $owner Owner name (post, article, page e.t.c.).
 * @property string $ownerAttribute Owner attribute (thumbnail, image e.t.c.).
 *
 * @package Itstructure\MFUploader\models
 *
 * @author Andrey Girnik <girnikandrey@gmail.com>
 */
abstract class Owner extends \yii\db\ActiveRecord
{
    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [
                [
                    'ownerId',
                    'owner',
                    'ownerAttribute',
                ],
                'required',
            ],
            [
                'ownerId',
                'integer',
            ],
            [
                [
                    'owner',
                    'ownerAttribute',
                ],
                'string',
                'max' => 64,
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return [
            'ownerId' => 'Owner ID',
            'owner' => 'Owner',
            'ownerAttribute' => 'Owner Attribute',
        ];
    }

    /**
     * Get model (mediafile/album) primary key name.
     *
     * @return string
     */
    abstract protected static function getModelKeyName(): string;

    /**
     * Add owner to mediafiles table.
     *
     * @param int    $modelId
     * @param int    $ownerId
     * @param string $owner
     * @param string $ownerAttribute
     *
     * @return bool
     */
    public static function addOwner(int $modelId, int $ownerId, string $owner, string $ownerAttribute): bool
    {
        $ownerModel = new static();
        $ownerModel->{static::getModelKeyName()} = $modelId;
        $ownerModel->ownerId = $ownerId;
        $ownerModel->owner = $owner;
        $ownerModel->ownerAttribute = $ownerAttribute;

        return $ownerModel->save();
    }

    /**
     * Remove this mediafile/album owner.
     *
     * @param int $ownerId
     * @param string $owner
     * @param string|null $ownerAttribute
     *
     * @return bool
     */
    public static function removeOwner(int $ownerId, string $owner, string $ownerAttribute = null): bool
    {
        $deleted = static::deleteAll(static::buildFilterOptions($ownerId, $owner, $ownerAttribute));

        return $deleted > 0;
    }

    /**
     * Getting entity id's which are related with Other owners too.
     *
     * @param string $owner
     * @param int $ownerId
     * @param array $entityIds
     *
     * @return array|\yii\db\ActiveRecord[]
     */
    public static function filterMultipliedEntityIds(string $owner, int $ownerId, array $entityIds)
    {
        return static::find()
            ->select(static::getModelKeyName())
            ->where([static::getModelKeyName() => $entityIds])
            ->andWhere([
                'OR',
                ['!=', 'ownerId', $ownerId],
                ['!=', 'owner', $owner]
            ])
            ->all();
    }

    /**
     * Get Id's by owner.
     *
     * @param string $nameId
     * @param array $args It can be an array of the next params: owner{string}, ownerId{int}, ownerAttribute{string}.
     *
     * @throws InvalidArgumentException
     *
     * @return ActiveQuery
     */
    protected static function getEntityIdsQuery(string $nameId, array $args): ActiveQuery
    {
        $conditions = [];

        if (!empty($args['owner'])) {
            if (!is_string($args['owner'])) {
                throw new InvalidArgumentException('Parameter owner must be a string.');
            }
            $conditions['owner'] = $args['owner'];

            if (!empty($args['ownerId'])) {
                if (!is_numeric($args['ownerId'])) {
                    throw new InvalidArgumentException('Parameter ownerId must be numeric.');
                }
                $conditions['ownerId'] = $args['ownerId'];
            }
        }

        if (!empty($args['ownerAttribute'])) {
            if (!is_string($args['ownerAttribute'])) {
                throw new InvalidArgumentException('Parameter ownerAttribute must be a string.');
            }
            $conditions['ownerAttribute'] = $args['ownerAttribute'];
        }

        $query = static::find()
            ->select($nameId);

        if (count($conditions) > 0) {
            return $query->where($conditions);
        }

        return $query;
    }

    /**
     * Build filter options for some actions.
     *
     * @param int $ownerId
     * @param string $owner
     * @param string|null $ownerAttribute
     *
     * @return array
     */
    protected static function buildFilterOptions(int $ownerId, string $owner, string $ownerAttribute = null)
    {
        return array_merge([
            'ownerId' => $ownerId,
            'owner' => $owner
        ], empty($ownerAttribute) ? [] : ['ownerAttribute' => $ownerAttribute]);
    }
}