PyRowMan / pheanstalk

src/Structure/Workflow.php

<?php


namespace Pheanstalk\Structure;

use Doctrine\Common\Collections\ArrayCollection;

class Workflow
{
    /** @var null|string */
    private $id;

    /** @var $name string */

The doc comment $name at position 0 could not be parsed: Unknown type name '$name' at position 0 in $name.

    private $name;

    /** @var string $group */
    private $group;

    /** @var ArrayCollection[Job] */

The doc comment ArrayCollection[Job] at position 1 could not be parsed: Expected ']' at position 1, but found '['.

    private $jobs;

    /** @var null|string $comment */
    private $comment;

    /** @var null|int $boundToSchedule */
    private $boundToSchedule;

    /** @var null|int $lastcommit */
    private $lastcommit;

    /** @var null|int $modified */
    private $modified;

    /**
     * Job constructor.
     *
     * @param string                $name       The name of the workflow
     * @param string                $group      The group of the workflow
     * @param ArrayCollection[Job]  $jobs       The collection of jobs

The doc comment ArrayCollection[Job] at position 1 could not be parsed: Expected ']' at position 1, but found '['.

     * @param null|string           $comment    The comment of the workflow
     */
    public function __construct(string $name, string $group, ArrayCollection $jobs, ?string $comment = null)
    {
        $this->name = $name;
        $this->group = $group;
        $this->setJobs($jobs);
        $this->comment = $comment;
    }

    /**
     * @return string|null
     */
    public function getId(): ?string
    {
        return $this->id;
    }

    /**
     * @param string|null $id
     *
     * @return Workflow
     */
    public function setId(?string $id): Workflow
    {
        $this->id = $id;
        return $this;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @param string $name
     *
     * @return Workflow
     */
    public function setName(string $name): Workflow
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getGroup(): string
    {
        return $this->group;
    }

    /**
     * @param string $group
     *
     * @return Workflow
     */
    public function setGroup(string $group): Workflow
    {
        $this->group = $group;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getComment(): ?string
    {
        return $this->comment;
    }

    /**
     * @param string|null $comment
     *
     * @return Workflow
     */
    public function setComment(?string $comment): Workflow
    {
        $this->comment = $comment;
        return $this;
    }

    /**
     * @return ArrayCollection
     */
    public function getJobs(): ArrayCollection
    {
        return $this->jobs;
    }

    /**
     * @param ArrayCollection $jobs
     *
     * @return Workflow
     */
    public function setJobs(ArrayCollection $jobs): Workflow
    {
        $this->jobs = $jobs->filter(function (Job $job) {

The parameter $job is not used and could be removed.

            return true;
        });
        return $this;
    }

    /**
     * @param Job $job
     *
     * @return Workflow
     */
    public function addJob(Job $job): Workflow
    {
        $this->jobs[] = $job;
        return $this;
    }

    /**
     * @param Job $job
     *
     * @return Workflow
     */
    public function removeJob(Job $job): Workflow
    {
        $this->jobs->removeElement($job);
        return $this;
    }

    /**
     * @return int|null
     */
    public function getBoundToSchedule(): ?int
    {
        return $this->boundToSchedule;
    }

    /**
     * @param int|null $boundToSchedule
     *
     * @return Workflow
     */
    public function setBoundToSchedule(?int $boundToSchedule): Workflow
    {
        $this->boundToSchedule = $boundToSchedule;
        return $this;
    }

    /**
     * @return int|null
     */
    public function getLastcommit(): ?int
    {
        return $this->lastcommit;
    }

    /**
     * @param int|null $lastcommit
     *
     * @return Workflow
     */
    public function setLastcommit(?int $lastcommit): Workflow
    {
        $this->lastcommit = $lastcommit;
        return $this;
    }

    /**
     * @return int|null
     */
    public function getModified(): ?int
    {
        return $this->modified;
    }

    /**
     * @param int|null $modified
     *
     * @return Workflow
     */
    public function setModified(?int $modified): Workflow
    {
        $this->modified = $modified;
        return $this;
    }

    /**
     * @return \DOMDocument
     * @throws \ReflectionException
     */
    public function getXml()
    {
        $dom = new \DOMDocument("1.0", "utf-8");
        $root = $dom->createElement("workflow");
        $subjobs = $dom->createElement("subjobs");
        /** @var Job $job*/
        foreach ($this->getJobs() as $job) {
            $jobNode = $job->getXml()->getElementsByTagName('job')->item(0);
            $subjobs->appendChild($dom->importNode($jobNode, true));
        }
        $root->appendChild($subjobs);
        $dom->appendChild($root);
        return $dom;
    }
}