src/Flexy/ShopBundle/Entity/Shipping/StepType.php line 25

  1. <?php
  3. namespace App\Flexy\ShopBundle\Entity\Shipping;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use App\Entity\Role;
  7. use App\Flexy\ShopBundle\Repository\Shipping\StepTypeRepository;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\DBAL\Types\Types;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use Gedmo\Mapping\Annotation as Gedmo;
  13. use Gedmo\SoftDeleteable\Traits\SoftDeleteableEntity;
  14. use Symfony\Component\Serializer\Annotation\Groups;
  16. /**
  17.  * @example Represent the class responsible for creating status or steps for shipping like (Delivered,Picked,On Hold,Waiting,Processing,....)
  18.  */
  19. #[ORM\Entity(repositoryClass: StepTypeRepository::class)]
  20. #[ApiResource(
  21.     normalizationContext: ['groups' => ['read']],
  22.     denormalizationContext: ['groups' => ['write']],
  23. )]
  24. #[Gedmo\SoftDeleteable(fieldName: 'deletedAt', timeAware: false, hardDelete: true)]
  25. class StepType
  26. {
  28.     use SoftDeleteableEntity;
  30.     
  31.     #[ORM\Id]
  32.     #[ORM\GeneratedValue]
  33.     #[ORM\Column]
  34.     #[Groups(["read"])]
  35.     private ?int $id = null;
  37.     #[ORM\Column(length: 255)]
  38.     #[Groups(["write","read"])]
  39.     private ?string $name = null;
  41.     #[ORM\Column(type: Types::TEXT, nullable: true)]
  42.     #[Groups(["write","read"])]
  43.     private ?string $description = null;
  45.     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
  46.     #[Groups(["write","read"])]
  47.     private ?\DateTimeInterface $createdAt = null;
  49.     #[ORM\Column(nullable: true)]
  50.     #[Gedmo\SortablePosition]
  51.     #[Groups(["write","read"])]
  52.     private ?int $priority = null;
  54.     #[ORM\OneToMany(mappedBy: 'stepType', targetEntity: TrackingStep::class,cascade:["persist","remove"])]
  55.     #[Groups(["write","read"])]
  56.     private Collection $trackingSteps;
  58.     #[ORM\Column(nullable: true)]
  59.     #[Groups(["write","read"])]
  60.     private ?bool $isBidirectional = null;
  62.     #[ORM\Column(nullable: true)]
  63.     #[Groups(["write","read"])]
  64.     private ?bool $isBatchTracking = null;
  66.     #[ORM\ManyToMany(targetEntity: City::class, inversedBy: 'stepTypes')]
  67.     #[Groups(["write","read"])]
  68.     private Collection $excludeCities;
  70.     #[ORM\Column(nullable: true)]
  71.     #[Groups(["write","read"])]
  72.     private ?bool $isMultiShipments = null;
  74.     #[ORM\Column(nullable: true)]
  75.     #[Groups(["write","read"])]
  76.     private ?bool $canEditShipment = null;
  80.     #[ORM\Column(length: 255,nullable:true)]
  81.     #[Gedmo\Slug(fields: ['name'])]
  82.     #[Groups(["write","read"])]
  83.     private ?string $code = null;
  85.     #[ORM\Column(nullable: true)]
  86.     #[Groups(["write","read"])]
  87.     private array $fieldsToEdit = [];
  89.     #[ORM\ManyToOne]
  90.     #[ORM\JoinColumn(nullable: true)]
  91.     #[Groups(["write","read"])]
  92.     private ?Role $role = null;
  94.     #[ORM\Column(length: 255,nullable:true)]
  95.     #[Groups(["write","read"])]
  96.     private ?string $directionHub = "from-hub";
  98.     #[ORM\Column(nullable: true)]
  99.     #[Groups(["write","read"])]
  100.     private ?bool $isExcludeHUB = null;
  102.     /**
  103.      * 
  104.      *
  105.      * @example [notify-recipient] 
  106.      */
  107.     #[ORM\Column(nullable: true)]
  108.     #[Groups(["write","read"])]
  109.     private array $events = [];
  111.     /**
  112.      * Undocumented variable
  113.      *
  114.      * @example Must be an hexadecimal like #fffff
  115.      */
  116.     #[ORM\Column(length: 255, nullable: true)]
  117.     #[Groups(["write","read"])]
  118.     private ?string $color = null;
  120.     #[ORM\Column(length: 255, nullable: true)]
  121.     #[Groups(["write","read"])]
  122.     private ?string $textColor = "#333";
  124.     #[Groups(["write","read"])]
  125.     #[ORM\ManyToMany(targetEntity: Role::class)]
  126.     private Collection $roles;
  130.     public function __toString()
  131.     {
  132.         return $this->name;
  133.     }
  135.     public function __construct()
  136.     {
  137.         $this->trackingSteps = new ArrayCollection();
  138.         $this->excludeCities = new ArrayCollection();
  139.         $this->roles = new ArrayCollection();
  140.     }
  142.     public function getId(): ?int
  143.     {
  144.         return $this->id;
  145.     }
  147.     public function getName(): ?string
  148.     {
  149.         return $this->name;
  150.     }
  152.     public function setName(string $name): self
  153.     {
  154.         $this->name = $name;
  156.         return $this;
  157.     }
  159.     public function getDescription(): ?string
  160.     {
  161.         return $this->description;
  162.     }
  164.     public function setDescription(?string $description): self
  165.     {
  166.         $this->description = $description;
  168.         return $this;
  169.     }
  171.     public function getCreatedAt(): ?\DateTimeInterface
  172.     {
  173.         return $this->createdAt;
  174.     }
  176.     public function setCreatedAt(?\DateTimeInterface $createdAt): self
  177.     {
  178.         $this->createdAt = $createdAt;
  180.         return $this;
  181.     }
  183.     public function getPriority(): ?int
  184.     {
  185.         return $this->priority;
  186.     }
  188.     public function setPriority(?int $priority): self
  189.     {
  190.         $this->priority = $priority;
  192.         return $this;
  193.     }
  195.     /**
  196.      * @return Collection<int, TrackingStep>
  197.      */
  198.     public function getTrackingSteps(): Collection
  199.     {
  200.         return $this->trackingSteps;
  201.     }
  203.     public function addTrackingStep(TrackingStep $shipmentTrackingStep): self
  204.     {
  205.         if (!$this->trackingSteps->contains($shipmentTrackingStep)) {
  206.             $this->trackingSteps->add($shipmentTrackingStep);
  207.             $shipmentTrackingStep->setStepType($this);
  208.         }
  210.         return $this;
  211.     }
  213.     public function removeTrackingStep(TrackingStep $shipmentTrackingStep): self
  214.     {
  215.         if ($this->trackingSteps->removeElement($shipmentTrackingStep)) {
  216.             // set the owning side to null (unless already changed)
  217.             if ($shipmentTrackingStep->getStepType() === $this) {
  218.                 $shipmentTrackingStep->setStepType(null);
  219.             }
  220.         }
  222.         return $this;
  223.     }
  225.     public function isIsBidirectional(): ?bool
  226.     {
  227.         return $this->isBidirectional;
  228.     }
  230.     public function setIsBidirectional(?bool $isBidirectional): self
  231.     {
  232.         $this->isBidirectional = $isBidirectional;
  234.         return $this;
  235.     }
  237.     public function isIsBatchTracking(): ?bool
  238.     {
  239.         return $this->isBatchTracking;
  240.     }
  242.     public function setIsBatchTracking(?bool $isBatchTracking): self
  243.     {
  244.         $this->isBatchTracking = $isBatchTracking;
  246.         return $this;
  247.     }
  249.     /**
  250.      * @return Collection<int, City>
  251.      */
  252.     public function getExcludeCities(): Collection
  253.     {
  254.         return $this->excludeCities;
  255.     }
  257.     public function addExcludeCity(City $excludeCity): self
  258.     {
  259.         if (!$this->excludeCities->contains($excludeCity)) {
  260.             $this->excludeCities->add($excludeCity);
  261.         }
  263.         return $this;
  264.     }
  266.     public function removeExcludeCity(City $excludeCity): self
  267.     {
  268.         $this->excludeCities->removeElement($excludeCity);
  270.         return $this;
  271.     }
  273.     public function isIsMultiShipments(): ?bool
  274.     {
  275.         return $this->isMultiShipments;
  276.     }
  278.     public function setIsMultiShipments(?bool $isMultiShipments): self
  279.     {
  280.         $this->isMultiShipments = $isMultiShipments;
  282.         return $this;
  283.     }
  285.     public function isCanEditShipment(): ?bool
  286.     {
  287.         return $this->canEditShipment;
  288.     }
  290.     public function setCanEditShipment(?bool $canEditShipment): self
  291.     {
  292.         $this->canEditShipment = $canEditShipment;
  294.         return $this;
  295.     }
  299.     public function getCode(): ?string
  300.     {
  301.         return $this->code;
  302.     }
  304.     public function setCode(string $code): self
  305.     {
  306.         $this->code = $code;
  308.         return $this;
  309.     }
  311.     public function getFieldsToEdit(): array
  312.     {
  313.         return $this->fieldsToEdit;
  314.     }
  316.     public function setFieldsToEdit(?array $fieldsToEdit): self
  317.     {
  318.         $this->fieldsToEdit = $fieldsToEdit;
  320.         return $this;
  321.     }
  323.     public function getRole(): ?Role
  324.     {
  325.         return $this->role;
  326.     }
  328.     public function setRole(?Role $role): self
  329.     {
  330.         $this->role = $role;
  332.         return $this;
  333.     }
  335.     public function getDirectionHub(): ?string
  336.     {
  337.         return $this->directionHub;
  338.     }
  340.     public function setDirectionHub(string $directionHub): self
  341.     {
  342.         $this->directionHub = $directionHub;
  344.         return $this;
  345.     }
  347.     public function isIsExcludeHUB(): ?bool
  348.     {
  349.         return $this->isExcludeHUB;
  350.     }
  352.     public function setIsExcludeHUB(?bool $isExcludeHUB): self
  353.     {
  354.         $this->isExcludeHUB = $isExcludeHUB;
  356.         return $this;
  357.     }
  359.     public function getEvents(): array
  360.     {
  361.         return $this->events;
  362.     }
  364.     public function setEvents(?array $events): self
  365.     {
  366.         $this->events = $events;
  368.         return $this;
  369.     }
  371.     public function getColor(): ?string
  372.     {
  373.         return $this->color;
  374.     }
  376.     public function setColor(?string $color): self
  377.     {
  378.         $this->color = $color;
  380.         return $this;
  381.     }
  383.     public function getTextColor(): ?string
  384.     {
  385.         return $this->textColor;
  386.     }
  388.     public function setTextColor(?string $textColor): self
  389.     {
  390.         $this->textColor = $textColor;
  392.         return $this;
  393.     }
  395.     /**
  396.      * @return Collection<int, Role>
  397.      */
  398.     public function getRoles(): Collection
  399.     {
  400.         return $this->roles;
  401.     }
  403.     public function addRole(Role $role): static
  404.     {
  405.         if (!$this->roles->contains($role)) {
  406.             $this->roles->add($role);
  407.         }
  409.         return $this;
  410.     }
  412.     public function removeRole(Role $role): static
  413.     {
  414.         $this->roles->removeElement($role);
  416.         return $this;
  417.     }
  418. }