Scaling\Playbook\PlaybookDefenition

Complexity

Total Complexity

3

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	times()	0	7	1
A	once()	0	7	1

<?php

namespace Scaling\Playbook;

class PlaybookDefenition
{
    /**
     * The playbook identification.
     *
     * @var string
     */
    public $id;

    /**
     * The instance of the playbook.
     *
     * @var \Scaling\Playbook\Playbook
     */
    public $playbook;

    /**
     * Times the playbook needs to run.
     *
     * @var int
     */
    public $times = 1;

    /**
     * Playbook only has to run once.
     *
     * @var bool
     */
    public $once = false;

    /**
     * Create a new playbook instance.
     *
     * @param string $className
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(string $className)
    {
        $this->playbook = app($className);
        $this->id = get_class($this->playbook);
    }

    /**
     * Create a new playbook instance which has to run more than one time.
     *
     * @param string $className
     * @param int $times
     * @return \Scaling\Playbook\PlaybookDefenition
     */
    public static function times(string $className, int $times): self
    {
        $defenition = new self($className);
        $defenition->times = $times;

        return $defenition;
    }

    /**
     * Create a new playbook instance which only has to run once.
     *
     * @param string $className
     * @return \Scaling\Playbook\PlaybookDefenition
     */
    public static function once(string $className): self
    {
        $defenition = new self($className);
        $defenition->once = true;

        return $defenition;
    }
}