flipbox\ember\services\traits\objects\AccessorByString

Complexity

Total Complexity

7

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	stringProperty()	0	1	?
A	find()	0	8	3
A	findByString()	0	6	1
A	getByString()	0	8	2
A	notFoundByStringException()	0	9	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember
 */

namespace flipbox\ember\services\traits\objects;

use flipbox\ember\exceptions\ObjectNotFoundException;
use yii\base\BaseObject;

/**
 * Similar to the inherited Accessor, you can also specific a unique string (typically a handle) to
 * retrieve an object.
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 *
 * @method BaseObject parentFind($identifier)
 */
trait AccessorByString
{
    use Accessor {
        find as parentFind;
    }

    /**
     * @return string
     */
    abstract protected static function stringProperty(): string;

    /*******************************************
     * OVERRIDE
     *******************************************/

    /**
     * @param $identifier
     * @return BaseObject|null
     */
    public function find($identifier)
    {
        if (!is_numeric($identifier) && is_string($identifier)) {
            return $this->findByString($identifier);
        }

        return $this->parentFind($identifier);
    }

    /*******************************************
     * FIND STRING
     *******************************************/

    /**
     * @param string $string
     * @return BaseObject|null
     */
    public function findByString(string $string)
    {
        return $this->findByCondition(
            [self::stringProperty() => $string]
        );
    }

    /**
     * @param string $string
     * @throws ObjectNotFoundException
     * @return BaseObject|null
     */
    public function getByString(string $string)
    {
        if (null === ($record = $this->findByString($string))) {
            $this->notFoundByStringException($string);
        }

        return $record;
    }

    /**
     * @param string|null $string
     * @throws ObjectNotFoundException
     */
    protected function notFoundByStringException(string $string = null)
    {
        throw new ObjectNotFoundException(
            sprintf(
                'Object does not exist with the string "%s".',
                (string)$string
            )
        );
    }
}