ConditionBuilder::relatedModelDetached() - Code Metrics - Inspection of "Reduced complexity in ConditionBuilder" - codefocus/managedcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( ebdf69...249119 )

by Menno
created 2017-08-23 07:06 UTC
ConditionBuilder::relatedModelDetached() A

↳ Parent: ConditionBuilder
Complexity

Conditions	1
Paths	1
Size

Total Lines	17
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	9
nc	1
nop	4
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
<?php

namespace Codefocus\ManagedCache;

use Codefocus\ManagedCache\Events\Event;
use Codefocus\ManagedCache\Traits\IdentifiesEloquentModels;
use Illuminate\Database\Eloquent\Model;
use Iterator;

/**
 * ConditionBuilder.
 */
class ConditionBuilder implements Iterator
{
    use IdentifiesEloquentModels;

    /**
     * @var array
     */
    protected $conditions = [];

    /**
     * Adds a Condition that tags a cache to get invalidated
     * when a new Model of the specified class is created.
     *
     * @param string $modelClassName model class name
     *
     * @return self
     */
    public function modelCreated(string $modelClassName): self
    {
        return $this->addEloquentEventCondition(
            Event::EVENT_ELOQUENT_CREATED,
            $modelClassName
        );
    }

    /**
     * Adds a Condition that tags a cache to get invalidated
     * when the specified Model instance, or any Model of the specified class
     * is updated.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) The Model id
     *
     * @return self
     */
    public function modelUpdated($model, ?int $modelId = null): self
    public function modelUpdated($model, /** @scrutinizer ignore-unused */ ?int $modelId = null): self
    {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);

        return $this->addEloquentEventCondition(
            Event::EVENT_ELOQUENT_UPDATED,
            $modelClassName,
            $modelId
        );
    }

    /**
     * Adds a Condition that tags a cache to get invalidated
     * when the specified Model instance, or any Model of the specified class
     * is saved.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) The Model id
     *
     * @return self
     */
    public function modelSaved($model, ?int $modelId = null): self
    public function modelSaved($model, /** @scrutinizer ignore-unused */ ?int $modelId = null): self
    {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);

        return $this->addEloquentEventCondition(
            Event::EVENT_ELOQUENT_SAVED,
            $modelClassName,
            $modelId
        );
    }

    /**
     * Adds a Condition that tags a cache to get invalidated
     * when the specified Model instance, or any Model of the specified class
     * is deleted.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) The Model id
     *
     * @return self
     */
    public function modelDeleted($model, ?int $modelId = null): self
    public function modelDeleted($model, /** @scrutinizer ignore-unused */ ?int $modelId = null): self
    {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);

        return $this->addEloquentEventCondition(
            Event::EVENT_ELOQUENT_DELETED,
            $modelClassName,
            $modelId
        );
    }

    /**
     * Adds a Condition that tags a cache to get invalidated
     * when the specified Model instance, or any Model of the specified class
     * is restored.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) The Model id
     *
     * @return self
     */
    public function modelRestored($model, ?int $modelId = null): self
    public function modelRestored($model, /** @scrutinizer ignore-unused */ ?int $modelId = null): self
    {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);

        return $this->addEloquentEventCondition(
            Event::EVENT_ELOQUENT_RESTORED,
            $modelClassName,
            $modelId
        );
    }

    /**
     * Adds a Condition that tags a cache to get invalidated when
     * a related Model of the specified class is attached.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) the Model id, if $model is a class name
     * @param mixed $relatedModel the related Model instance or class name
     * @param int|null $relatedModelId (default: null) the related Model id
     *
     * @return self
     */
    public function relatedModelAttached(
        $model,
        ?int $modelId = null,
        /** @scrutinizer ignore-unused */ ?int $modelId = null,
        $relatedModel,
        ?int $relatedModelId = null
        /** @scrutinizer ignore-unused */ ?int $relatedModelId = null
    ): self {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);
        list($relatedModelClassName, $relatedModelId) = $this->getModelClassNameAndId($relatedModel);
        $this->conditions[] = new Condition(
            Event::EVENT_ELOQUENT_ATTACHED,
            $modelClassName,
            $modelId,
            $relatedModelClassName,
            $relatedModelId
        );

        return $this;
    }

    /**
     * Adds a Condition that tags a cache to get invalidated when
     * a related Model of the specified class is detached.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) the Model id, if $model is a class name
     * @param mixed $relatedModel the related Model instance or class name
     * @param int|null $relatedModelId (default: null) the related Model id
     *
     * @return self
     */
    public function relatedModelDetached(
         $model,
         ?int $modelId = null,
         /** @scrutinizer ignore-unused */ ?int $modelId = null,
         $relatedModel,
         ?int $relatedModelId = null
         /** @scrutinizer ignore-unused */ ?int $relatedModelId = null
     ): self {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);
        list($relatedModelClassName, $relatedModelId) = $this->getModelClassNameAndId($relatedModel);
        $this->conditions[] = new Condition(
             Event::EVENT_ELOQUENT_DETACHED,
             $modelClassName,
             $modelId,
             $relatedModelClassName,
             $relatedModelId
         );

        return $this;
    }

    /**
     * Adds a Condition that tags a cache to get invalidated when
     * a related Model of the specified class is updated.
     *
     * @param mixed $model model instance or class name
     * @param int|null $modelId (default: null) the Model id, if $model is a class name
     * @param mixed $relatedModel (default: null) the related Model instance or class name
     * @param int|null $relatedModelId (default: null) the related Model id
     *
     * @return self
     */
    public function relatedModelUpdated(
          $model,
          ?int $modelId = null,
          /** @scrutinizer ignore-unused */ ?int $modelId = null,
          $relatedModel,
          ?int $relatedModelId = null
          /** @scrutinizer ignore-unused */ ?int $relatedModelId = null
      ): self {
        list($modelClassName, $modelId) = $this->getModelClassNameAndId($model);
        list($relatedModelClassName, $relatedModelId) = $this->getModelClassNameAndId($relatedModel);
        $this->conditions[] = new Condition(
              Event::EVENT_ELOQUENT_UPDATED,
              $modelClassName,
              $modelId,
              $relatedModelClassName,
              $relatedModelId
          );

        return $this;
    }

    /**
     * Add an Eloquent event Condition.
     *
     * @param string $eventName
     * @param string|null $modelClassName (default: null)
     * @param int|null $modelId (default: null)
     * @param string|null $relatedModelClassName (default: null)
     * @param int|null $relatedModelId (default: null)
     *
     * @return self
     */
    private function addEloquentEventCondition(
        string $eventName,
        string $modelClassName,
        ?int $modelId = null,
        ?string $relatedModelClassName = null,
        ?int $relatedModelId = null
    ): self {
        $this->conditions[] = new Condition(
            $eventName,
            $modelClassName,
            $modelId,
            $relatedModelClassName,
            $relatedModelId
        );

        return $this;
    }

    /**
     * Return the value of the current item in the conditions array.
     *
     * @return Condition|false
     */
    public function current()
    {
        return current($this->conditions);
    }

    /**
     * Return the key of the current item in the conditions array.
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->conditions);
    }

    /**
     * Move the conditions array pointer to the next item.
     */
    public function next(): void
    {
        next($this->conditions);
    }

    /**
     * Move the conditions array pointer to the first item.
     */
    public function rewind(): void
    {
        reset($this->conditions);
    }

    /**
     * Returns whether the current item in the conditions array is valid.
     *
     * @return bool
     */
    public function valid(): bool
    {
        return current($this->conditions) !== false;
    }
}

codefocus / managedcache

Push — master ( ebdf69...249119 )

ConditionBuilder::relatedModelDetached() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
