vendor/shapecode/cron-bundle/src/Entity/CronJob.php line 16

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Shapecode\Bundle\CronBundle\Entity;
  7. use Cron\CronExpression;
  8. use DateTimeInterface;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\DBAL\Types\Types;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use Shapecode\Bundle\CronBundle\Repository\CronJobRepository;
  15. #[ORM\Entity(repositoryClass: CronJobRepository::class)]
  16. class CronJob extends AbstractEntity
  17. {
  18.     #[ORM\Column(type: Types::STRING)]
  19.     private string $command;
  21.     #[ORM\Column(type: Types::STRING, nullable: true)]
  22.     private string|null $arguments = null;
  24.     #[ORM\Column(type: Types::STRING, nullable: true)]
  25.     private string|null $description = null;
  27.     #[ORM\Column(type: Types::INTEGER, options: ['unsigned' => true, 'default' => 0])]
  28.     private int $runningInstances = 0;
  30.     #[ORM\Column(type: Types::INTEGER, options: ['unsigned' => true, 'default' => 1])]
  31.     private int $maxInstances = 1;
  33.     #[ORM\Column(type: Types::INTEGER, options: ['unsigned' => true, 'default' => 1])]
  34.     private int $number = 1;
  36.     #[ORM\Column(type: Types::STRING)]
  37.     private string $period;
  39.     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
  40.     private DateTimeInterface|null $lastUse = null;
  42.     #[ORM\Column(type: Types::DATETIME_MUTABLE)]
  43.     private DateTimeInterface $nextRun;
  45.     /** @var Collection<int, CronJobResult>*/
  46.     #[ORM\OneToMany(mappedBy: 'cronJob', targetEntity: CronJobResult::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
  47.     private Collection $results;
  49.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => true])]
  50.     private bool $enable = true;
  52.     public function __construct(
  53.         string $command,
  54.         string $period,
  55.     ) {
  56.         $this->command = $command;
  57.         $this->period  = $period;
  58.         $this->results = new ArrayCollection();
  60.         $this->calculateNextRun();
  61.     }
  63.     public static function create(string $command, string $period): self
  64.     {
  65.         return new self($command, $period);
  66.     }
  68.     public function getCommand(): string
  69.     {
  70.         return $this->command;
  71.     }
  73.     public function getFullCommand(): string
  74.     {
  75.         $arguments = '';
  77.         if ($this->getArguments() !== null) {
  78.             $arguments = ' ' . $this->getArguments();
  79.         }
  81.         return $this->getCommand() . $arguments;
  82.     }
  84.     public function getArguments(): string|null
  85.     {
  86.         return $this->arguments;
  87.     }
  89.     public function setArguments(string|null $arguments): self
  90.     {
  91.         $this->arguments = $arguments;
  93.         return $this;
  94.     }
  96.     public function getDescription(): string|null
  97.     {
  98.         return $this->description;
  99.     }
  101.     public function setDescription(string|null $description): self
  102.     {
  103.         $this->description = $description;
  105.         return $this;
  106.     }
  108.     public function getRunningInstances(): int
  109.     {
  110.         return $this->runningInstances;
  111.     }
  113.     public function increaseRunningInstances(): self
  114.     {
  115.         ++$this->runningInstances;
  117.         return $this;
  118.     }
  120.     public function decreaseRunningInstances(): self
  121.     {
  122.         --$this->runningInstances;
  124.         return $this;
  125.     }
  127.     public function getMaxInstances(): int
  128.     {
  129.         return $this->maxInstances;
  130.     }
  132.     public function setMaxInstances(int $maxInstances): self
  133.     {
  134.         $this->maxInstances = $maxInstances;
  136.         return $this;
  137.     }
  139.     public function getNumber(): int
  140.     {
  141.         return $this->number;
  142.     }
  144.     public function setNumber(int $number): self
  145.     {
  146.         $this->number = $number;
  148.         return $this;
  149.     }
  151.     public function getPeriod(): string
  152.     {
  153.         return $this->period;
  154.     }
  156.     public function setPeriod(string $period): self
  157.     {
  158.         $this->period = $period;
  160.         return $this;
  161.     }
  163.     public function getLastUse(): DateTimeInterface|null
  164.     {
  165.         return $this->lastUse;
  166.     }
  168.     public function setLastUse(DateTimeInterface $lastUse): self
  169.     {
  170.         $this->lastUse = $lastUse;
  172.         return $this;
  173.     }
  175.     public function setNextRun(DateTimeInterface $nextRun): self
  176.     {
  177.         $this->nextRun = $nextRun;
  179.         return $this;
  180.     }
  182.     public function getNextRun(): DateTimeInterface
  183.     {
  184.         return $this->nextRun;
  185.     }
  187.     /** @return Collection<int, CronJobResult> */
  188.     public function getResults(): Collection
  189.     {
  190.         return $this->results;
  191.     }
  193.     public function setEnable(bool $enable): self
  194.     {
  195.         $this->enable = $enable;
  197.         return $this;
  198.     }
  200.     public function isEnable(): bool
  201.     {
  202.         return $this->enable;
  203.     }
  205.     public function enable(): self
  206.     {
  207.         return $this->setEnable(true);
  208.     }
  210.     public function disable(): self
  211.     {
  212.         return $this->setEnable(false);
  213.     }
  215.     public function calculateNextRun(): self
  216.     {
  217.         $cron = new CronExpression($this->getPeriod());
  218.         $this->setNextRun($cron->getNextRunDate());
  220.         return $this;
  221.     }
  223.     public function __toString(): string
  224.     {
  225.         return $this->getCommand();
  226.     }
  227. }