src/Cms/DomainBundle/Entity/SslCertificate.php line 37

Open in your IDE?
  1. <?php
  3. namespace Cms\DomainBundle\Entity;
  5. use Cms\CoreBundle\Util\DateTimeUtils;
  6. use Cms\DomainBundle\Entity\Embeddables\SslCertificateDataEmbeddable;
  7. use Cms\DomainBundle\Entity\SslCertificates\CustomSslCertificate;
  8. use Cms\DomainBundle\Entity\SslCertificates\LetsEncryptSslCertificate;
  9. use Cms\TenantBundle\Entity\TenantedEntity;
  10. use DateTime;
  11. use Doctrine\ORM\Mapping as ORM;
  13. /**
  14.  * Class SslCertificate
  15.  * @package Cms\DomainBundle\Entity
  16.  *
  17.  * @ORM\Entity(
  18.  *     repositoryClass = "Cms\DomainBundle\Doctrine\SslCertificateRepository"
  19.  * )
  20.  *
  21.  * @ORM\InheritanceType("SINGLE_TABLE")
  22.  *
  23.  * @ORM\DiscriminatorColumn(
  24.  *     name = "_discr",
  25.  *     type = "string"
  26.  * )
  27.  *
  28.  * @ORM\DiscriminatorMap({
  29.  *     CustomSslCertificate::DISCR = "Cms\DomainBundle\Entity\SslCertificates\CustomSslCertificate",
  30.  *     LetsEncryptSslCertificate::DISCR = "Cms\DomainBundle\Entity\SslCertificates\LetsEncryptSslCertificate"
  31.  * })
  32.  *
  33.  * @ORM\Table(
  34.  *      name = "cms__domain__ssl_certificate"
  35.  * )
  36.  */
  37. abstract class SslCertificate extends TenantedEntity
  38. {
  39.     const DISCR = null;
  41.     /**
  42.      * @var Domain
  43.      *
  44.      * @ORM\OneToOne(
  45.      *     targetEntity = "Domain"
  46.      * )
  47.      * @ORM\JoinColumn(
  48.      *     name = "domain",
  49.      *     nullable = false,
  50.      *     referencedColumnName = "id",
  51.      *     onDelete = "CASCADE"
  52.      * )
  53.      */
  54.     protected $domain;
  56.     /**
  57.      * When a cert is prepared and this is marked as ready, this should be set to the expiration of the cert.
  58.      * This cached expiration is useful in knowing when a cert expires without having to always parse the cert.
  59.      *
  60.      * @var DateTime
  61.      *
  62.      * @ORM\Column(
  63.      *     type = "datetime",
  64.      *     nullable = true
  65.      * )
  66.      */
  67.     protected $expiration;
  69.     /**
  70.      * @var SslCertificateDataEmbeddable
  71.      *
  72.      * @ORM\Embedded(
  73.      *     class = "Cms\DomainBundle\Entity\Embeddables\SslCertificateDataEmbeddable",
  74.      *     columnPrefix = "data_"
  75.      * )
  76.      */
  77.     protected $data;
  79.     /**
  80.      * @var bool
  81.      *
  82.      * @ORM\Column(
  83.      *     type = "boolean",
  84.      *     nullable = false,
  85.      *     options = {
  86.      *         "default" = false
  87.      *     }
  88.      * )
  89.      */
  90.     protected $ready = false;
  92.     /**
  93.      * @var array|null
  94.      *
  95.      * @ORM\Column(
  96.      *     type = "json",
  97.      *     nullable = true,
  98.      * )
  99.      */
  100.     protected ?array $error = null;
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     public function __construct()
  106.     {
  107.         $this->data = new SslCertificateDataEmbeddable();
  108.     }
  110.     /**
  111.      * @return Domain
  112.      */
  113.     public function getDomain()
  114.     {
  115.         return $this->domain;
  116.     }
  118.     /**
  119.      * @param Domain $value
  120.      * @return $this
  121.      */
  122.     public function setDomain(Domain $value)
  123.     {
  124.         $this->domain = $value;
  125.         return $this;
  126.     }
  128.     /**
  129.      * @return bool
  130.      */
  131.     public function isExpired(): bool
  132.     {
  133.         return $this->getExpiration() && ($this->getExpiration() < DateTimeUtils::now());
  134.     }
  136.     /**
  137.      * @return DateTime
  138.      */
  139.     public function getExpiration()
  140.     {
  141.         return $this->expiration;
  142.     }
  144.     /**
  145.      * @param DateTime $value
  146.      * @return $this
  147.      */
  148.     public function setExpiration(DateTime $value = null)
  149.     {
  150.         $this->expiration = $value;
  151.         return $this;
  152.     }
  154.     /**
  155.      * @return SslCertificateDataEmbeddable
  156.      */
  157.     public function getData()
  158.     {
  159.         return $this->data;
  160.     }
  162.     /**
  163.      * @return bool
  164.      */
  165.     public function isReady()
  166.     {
  167.         return ($this->getReady() === true);
  168.     }
  170.     /**
  171.      * @return bool
  172.      */
  173.     public function getReady()
  174.     {
  175.         return ($this->ready === true);
  176.     }
  178.     /**
  179.      * @param bool $value
  180.      * @return $this
  181.      */
  182.     public function setReady($value)
  183.     {
  184.         $this->ready = ($value === true);
  185.         return $this;
  186.     }
  188.     /**
  189.      * @return string
  190.      */
  191.     public function getType()
  192.     {
  193.         $type = '';
  195.         switch (static::DISCR) {
  196.             case LetsEncryptSslCertificate::DISCR:
  197.                 $type = 'Let\'s Encrypt';
  198.                 break;
  199.             case CustomSslCertificate::DISCR:
  200.                 $type = 'Custom';
  201.                 break;
  202.         }
  204.         return $type;
  205.     }
  207.     /**
  208.      * @return array|null
  209.      */
  210.     public function getError(): ?array
  211.     {
  212.         return $this->error;
  213.     }
  215.     /**
  216.      * @param array|null $error
  217.      * @return self
  218.      */
  219.     public function setError(?array $error): self
  220.     {
  221.         $this->error = $error;
  223.         return $this;
  224.     }
  225. }