Spiral\Models\Traits\SolidStateTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	solidState()	0	6	1
A	isSolid()	0	4	1

<?php
/**
 * components
 *
 * @author    Wolfy-J
 */
namespace Spiral\Models\Traits;

/**
 * Provides ability for object (entity or accessor) to indicate that it's values must always be
 * stored together (no dirty fields, no atomic operations).
 *
 * Note: it's not the same as solid state relay :)
 */
trait SolidStateTrait
{
    /**
     * SolidState MUST force object to be saved as one big dataset without any atomic operations
     * or dirty field processing.
     *
     * @var bool
     */
    private $solidState = false;

    /**
     * Declare object as solid.
     *
     * @param bool $solidState
     *
     * @return $this
     */
    public function solidState(bool $solidState = true)
    {
        $this->solidState = $solidState;

        return $this;
    }

    /**
     * Is object is solid state?
     *
     * @see solidState()
     *
     * @return bool
     */
    public function isSolid()
    {
        return $this->solidState;
    }
}