AbstractRouteEntity.php

<?php

/**
 * Routes.
 *
 * @copyright Zikula contributors (Zikula)
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 * @author Zikula contributors <info@ziku.la>.
 *
 * @see https://ziku.la
 *
 * @version Generated by ModuleStudio 1.5.0 (https://modulestudio.de).
 */

declare(strict_types=1);

namespace Zikula\RoutesModule\Entity\Base;

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Symfony\Component\Validator\Constraints as Assert;
use Zikula\Bundle\CoreBundle\Doctrine\EntityAccess;
use Zikula\RoutesModule\Traits\StandardFieldsTrait;
use Zikula\RoutesModule\Validator\Constraints as RoutesAssert;

/**
 * Entity class that defines the entity structure and behaviours.
 *
 * This is the base entity class for route entities.
 * The following annotation marks it as a mapped superclass so subclasses
 * inherit orm properties.
 *
 * @ORM\MappedSuperclass
 */
abstract class AbstractRouteEntity extends EntityAccess
{
    /**
     * Hook standard fields behaviour embedding createdBy, updatedBy, createdDate, updatedDate fields.
     */
    use StandardFieldsTrait;

    /**
     * @var string The tablename this object maps to
     */
    protected $_objectType = 'route';
    
    /**
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     * @ORM\Column(type="integer", unique=true)
     * @Assert\Type(type="integer")
     * @Assert\NotNull
     * @Assert\LessThan(value=1000000000)
     *
     * @var int
     */
    protected $id = 0;
    
    /**
     * The current workflow state.
     *
     * @ORM\Column(length=20)
     * @Assert\NotBlank
     * @RoutesAssert\ListEntry(entityName="route", propertyName="workflowState", multiple=false)
     *
     * @var string
     */
    protected $workflowState = 'initial';
    
    /**
     * @ORM\Column(length=255)
     * @Assert\NotBlank
     * @Assert\Length(min="0", max="255")
     *
     * @var string
     */
    protected $bundle = '';
    
    /**
     * @ORM\Column(length=255)
     * @Assert\NotBlank
     * @Assert\Length(min="0", max="255")
     *
     * @var string
     */
    protected $controller = '';
    
    /**
     * @ORM\Column(name="route_action", length=255)
     * @Assert\NotBlank
     * @Assert\Length(min="0", max="255")
     *
     * @var string
     */
    protected $action = '';
    
    /**
     * @ORM\Column(name="route_path", length=255)
     * @Assert\NotBlank
     * @Assert\Length(min="0", max="255")
     *
     * @var string
     */
    protected $path = '';
    
    /**
     * @ORM\Column(length=255, nullable=true)
     * @Assert\AtLeastOneOf({
     *     @Assert\Blank(),
     *     @Assert\Length(min="0", max="255")
     * })
     *
     * @var string
     */
    protected $description = '';
    
    /**
     * @Gedmo\SortablePosition
     * @ORM\Column(type="integer")
     * @Assert\Type(type="integer")
     * @Assert\NotNull
     * @Assert\LessThan(value=100000000000)
     *
     * @var int
     */
    protected $sort = 0;
    
    /**
     * @ORM\Column(type="boolean")
     * @Assert\NotNull
     * @Assert\Type(type="bool")
     *
     * @var bool
     */
    protected $prependBundlePrefix = true;
    
    /**
     * @ORM\Column(type="boolean")
     * @Assert\NotNull
     * @Assert\Type(type="bool")
     *
     * @var bool
     */
    protected $translatable = true;
    
    /**
     * @ORM\Column(length=255, nullable=true)
     * @Assert\AtLeastOneOf({
     *     @Assert\Blank(),
     *     @Assert\Length(min="0", max="255")
     * })
     *
     * @var string
     */
    protected $translationPrefix = '';
    
    /**
     * @ORM\Column(length=255)
     * @Assert\NotBlank
     * @RoutesAssert\ListEntry(entityName="route", propertyName="schemes", multiple=true)
     *
     * @var string
     */
    protected $schemes = 'http###https';
    
    /**
     * @ORM\Column(length=255)
     * @Assert\NotBlank
     * @RoutesAssert\ListEntry(entityName="route", propertyName="methods", multiple=true)
     *
     * @var string
     */
    protected $methods = 'GET';
    
    /**
     * @ORM\Column(name="route_defaults", type="array")
     * @Assert\NotNull
     * @Assert\Type(type="array")
     *
     * @var array
     */
    protected $defaults = [];
    
    /**
     * @ORM\Column(type="array")
     * @Assert\NotNull
     * @Assert\Type(type="array")
     *
     * @var array
     */
    protected $requirements = [];
    
    /**
     * @ORM\Column(type="array")
     * @Assert\NotNull
     * @Assert\Type(type="array")
     *
     * @var array
     */
    protected $options = [];
    
    /**
     * @ORM\Column(length=255, nullable=true)
     * @Assert\AtLeastOneOf({
     *     @Assert\Blank(),
     *     @Assert\Length(min="0", max="255")
     * })
     *
     * @var string
     */
    protected $host = '';
    
    /**
     * @ORM\Column(name="route_condition", length=255, nullable=true)
     * @Assert\AtLeastOneOf({
     *     @Assert\Blank(),
     *     @Assert\Length(min="0", max="255")
     * })
     *
     * @var string
     */
    protected $condition = '';
    
    /**
     * RouteEntity constructor.
     *
     * Will not be called by Doctrine and can therefore be used
     * for own implementation purposes. It is also possible to add
     * arbitrary arguments as with every other class method.
     */
    public function __construct()
    {
    }
    
    public function get_objectType(): string
    {
        return $this->_objectType;
    }
    
    public function set_objectType(string $_objectType): self
    {
        if ($this->_objectType !== $_objectType) {
            $this->_objectType = $_objectType ?? '';
        }
    
        return $this;
    }
    
    public function getId(): ?int
    {
        return $this->id;
    }
    
    public function setId(?int $id = null): self
    {
        if ((int) $this->id !== $id) {
            $this->id = $id;
        }
    
        return $this;
    }
    
    public function getWorkflowState(): string
    {
        return $this->workflowState;
    }
    
    public function setWorkflowState(string $workflowState): self
    {
        if ($this->workflowState !== $workflowState) {
            $this->workflowState = $workflowState ?? '';
        }
    
        return $this;
    }
    
    public function getBundle(): string
    {
        return $this->bundle;
    }
    
    public function setBundle(string $bundle): self
    {
        if ($this->bundle !== $bundle) {
            $this->bundle = $bundle ?? '';
        }
    
        return $this;
    }
    
    public function getController(): string
    {
        return $this->controller;
    }
    
    public function setController(string $controller): self
    {
        if ($this->controller !== $controller) {
            $this->controller = $controller ?? '';
        }
    
        return $this;
    }
    
    public function getAction(): string
    {
        return $this->action;
    }
    
    public function setAction(string $action): self
    {
        if ($this->action !== $action) {
            $this->action = $action ?? '';
        }
    
        return $this;
    }
    
    public function getPath(): string
    {
        return $this->path;
    }
    
    public function setPath(string $path): self
    {
        if ($this->path !== $path) {
            $this->path = $path ?? '';
        }
    
        return $this;
    }
    
    public function getDescription(): ?string
    {
        return $this->description;
    }
    
    public function setDescription(?string $description = null): self
    {
        if ($this->description !== $description) {
            $this->description = $description;
        }
    
        return $this;
    }
    
    public function getSort(): int
    {
        return $this->sort;
    }
    
    public function setSort(int $sort): self
    {
        if ((int) $this->sort !== $sort) {
            $this->sort = $sort;
        }
    
        return $this;
    }
    
    public function getPrependBundlePrefix(): bool
    {
        return $this->prependBundlePrefix;
    }
    
    public function setPrependBundlePrefix(bool $prependBundlePrefix): self
    {
        if ((bool) $this->prependBundlePrefix !== $prependBundlePrefix) {
            $this->prependBundlePrefix = $prependBundlePrefix;
        }
    
        return $this;
    }
    
    public function getTranslatable(): bool
    {
        return $this->translatable;
    }
    
    public function setTranslatable(bool $translatable): self
    {
        if ((bool) $this->translatable !== $translatable) {
            $this->translatable = $translatable;
        }
    
        return $this;
    }
    
    public function getTranslationPrefix(): ?string
    {
        return $this->translationPrefix;
    }
    
    public function setTranslationPrefix(?string $translationPrefix = null): self
    {
        if ($this->translationPrefix !== $translationPrefix) {
            $this->translationPrefix = $translationPrefix;
        }
    
        return $this;
    }
    
    public function getSchemes(): string
    {
        return $this->schemes;
    }
    
    public function setSchemes(string $schemes): self
    {
        if ($this->schemes !== $schemes) {
            $this->schemes = $schemes ?? '';
        }
    
        return $this;
    }
    
    public function getMethods(): string
    {
        return $this->methods;
    }
    
    public function setMethods(string $methods): self
    {
        if ($this->methods !== $methods) {
            $this->methods = $methods ?? '';
        }
    
        return $this;
    }
    
    public function getDefaults(): array
    {
        return $this->defaults;
    }
    
    public function setDefaults(array $defaults): self
    {
        if ($this->defaults !== $defaults) {
            $this->defaults = $defaults ?? [];
        }
    
        return $this;
    }
    
    public function getRequirements(): array
    {
        return $this->requirements;
    }
    
    public function setRequirements(array $requirements): self
    {
        if ($this->requirements !== $requirements) {
            $this->requirements = $requirements ?? [];
        }
    
        return $this;
    }
    
    public function getOptions(): array
    {
        return $this->options;
    }
    
    public function setOptions(array $options): self
    {
        if ($this->options !== $options) {
            $this->options = $options ?? [];
        }
    
        return $this;
    }
    
    public function getHost(): ?string
    {
        return $this->host;
    }
    
    public function setHost(?string $host = null): self
    {
        if ($this->host !== $host) {
            $this->host = $host;
        }
    
        return $this;
    }
    
    public function getCondition(): ?string
    {
        return $this->condition;
    }
    
    public function setCondition(?string $condition = null): self
    {
        if ($this->condition !== $condition) {
            $this->condition = $condition;
        }
    
        return $this;
    }
    
    /**
     * Creates url arguments array for easy creation of display urls.
     */
    public function createUrlArgs(): array
    {
        return [
            'id' => $this->getId(),
        ];
    }
    
    /**
     * Returns the primary key.
     */
    public function getKey(): ?int
    {
        return $this->getId();
    }
    
    /**
     * Returns an array of all related objects that need to be persisted after clone.
     */
    public function getRelatedObjectsToPersist(array &$objects = []): array
    {
        return [];
    }
    
    /**
     * ToString interceptor implementation.
     * This method is useful for debugging purposes.
     */
    public function __toString(): string
    {
        return 'Route ' . $this->getKey() . ': ' . $this->getBundle();
    }
    
    /**
     * Clone interceptor implementation.
     * This method is for example called by the reuse functionality.
     * Performs a quite simple shallow copy.
     *
     * See also:
     * (1) http://docs.doctrine-project.org/en/latest/cookbook/implementing-wakeup-or-clone.html
     * (2) http://www.php.net/manual/en/language.oop5.cloning.php
     * (3) http://stackoverflow.com/questions/185934/how-do-i-create-a-copy-of-an-object-in-php
     */
    public function __clone()
    {
        // if the entity has no identity do nothing, do NOT throw an exception
        if (!$this->id) {
            return;
        }
    
        // otherwise proceed
    
        // unset identifier
        $this->setId(0);
    
        // reset workflow
        $this->setWorkflowState('initial');
    
        $this->setCreatedBy(null);
        $this->setCreatedDate(null);
        $this->setUpdatedBy(null);
        $this->setUpdatedDate(null);
    }
}