Initial commit

application/Espo/Modules/Crm/Entities/Campaign.php

@@ -0,0 +1,123 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Modules\Crm\Entities;
+
+use Espo\Core\Field\Date;
+use Espo\Core\Field\Link;
+use Espo\Core\Field\LinkMultiple;
+use Espo\Core\Name\Field;
+use Espo\Core\ORM\Entity;
+use Espo\Entities\User;
+
+class Campaign extends Entity
+{
+    public const ENTITY_TYPE = 'Campaign';
+
+    public const TYPE_EMAIL = 'Email';
+    public const TYPE_NEWSLETTER = 'Newsletter';
+    public const TYPE_INFORMATIONAL_EMAIL = 'Informational Email';
+    public const TYPE_MAIL = 'Mail';
+
+    public const STATUS_ACTIVE = 'Active';
+    public const STATUS_INACTIVE = 'Inactive';
+
+    public function getName(): ?string
+    {
+        return $this->get(Field::NAME);
+    }
+
+    public function setName(?string $name): self
+    {
+        $this->set(Field::NAME, $name);
+
+        return $this;
+    }
+
+    public function setDescription(?string $description): self
+    {
+        return $this->set('description', $description);
+    }
+
+    public function getDescription(): ?string
+    {
+        return $this->get('description');
+    }
+
+    public function getType(): ?string
+    {
+        return $this->get('type');
+    }
+
+    public function getStatus(): ?string
+    {
+        return $this->get('status');
+    }
+
+    public function setStatus(string $status): self
+    {
+        return $this->set('status', $status);
+    }
+
+    public function getStartDate(): ?Date
+    {
+        /** @var ?Date */
+        return $this->getValueObject('startDate');
+    }
+
+    public function getEndDate(): ?Date
+    {
+        /** @var ?Date */
+        return $this->getValueObject('endDate');
+    }
+
+    public function getAssignedUser(): ?Link
+    {
+        /** @var ?Link */
+        return $this->getValueObject(Field::ASSIGNED_USER);
+    }
+
+    public function getTeams(): LinkMultiple
+    {
+        /** @var LinkMultiple */
+        return $this->getValueObject(Field::TEAMS);
+    }
+
+    public function setAssignedUser(Link|User|null $assignedUser): self
+    {
+        return $this->setRelatedLinkOrEntity(Field::ASSIGNED_USER, $assignedUser);
+    }
+
+    public function setTeams(LinkMultiple $teams): self
+    {
+        $this->setValueObject(Field::TEAMS, $teams);
+
+        return $this;
+    }
+}