Spiral\ORM\Entities\Relations\Traits\PartialTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	partial()	0	6	1
A	isPartial()	0	4	1

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

/**
 * Provides ability to skip loading data from database for realtion.
 */
trait PartialTrait
{
    /**
     * @var bool
     */
    private $autoload = true;

    /**
     * Partial selections will not be autoloaded.
     *
     * Example:
     *
     * $post = $this->findPost(); //no comments
     * $post->comments->partial(true);
     * $post->comments->add(new Comment());
     * assert($post->comments->count() == 1); //no other comments to be loaded
     *
     * $post->comments->add($comment);
     *
     * @param bool $partial
     *
     * @return self|$this

The return type PartialTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function partial(bool $partial = true)
    {
        $this->autoload = !$partial;

        return $this;
    }

    /**
     * @return bool
     */
    public function isPartial(): bool
    {
        return !$this->autoload;
    }
}