oms-Marketing/Models/Promotion.php

513 lines
8.2 KiB
PHP
Executable File

<?php
/**
* Orange Management
*
* PHP Version 7.4
*
* @package Modules\Marketing\Models
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link https://orange-management.org
*/
declare(strict_types=1);
namespace Modules\Marketing\Models;
use Modules\Admin\Models\Account;
use Modules\Admin\Models\NullAccount;
use Modules\Calendar\Models\Calendar;
use Modules\Tasks\Models\Task;
use phpOMS\Localization\Money;
/**
* Project class.
*
* @package Modules\Marketing\Models
* @license OMS License 1.0
* @link https://orange-management.org
* @since 1.0.0
*/
class Promotion
{
/**
* ID.
*
* @var int
* @since 1.0.0
*/
protected int $id = 0;
private $start = null;
private $end = null;
/**
* Name.
*
* @var string
* @since 1.0.0
*/
private string $name = '';
/**
* Description.
*
* @var string
* @since 1.0.0
*/
private string $description = '';
private $calendar = null;
private $costs = null;
private $budget = null;
private $earnings = null;
private $media = [];
private $progress = 0;
private $progressType = ProgressType::MANUAL;
/**
* Created at.
*
* @var \DateTime
* @since 1.0.0
*/
private \DateTime $createdAt;
/**
* Created by.
*
* @var Account
* @since 1.0.0
*/
private Account $createdBy;
private $tasks = [];
/**
* Cosntructor
*
* @param string $name Promotion name
*
* @since 1.0.0
*/
public function __construct(string $name = '')
{
$this->start = new \DateTime('now');
$this->end = new \DateTime('now');
$this->end->modify('+1 month');
$this->createdAt = new \DateTime('now');
$this->createdBy = new NullAccount();
$this->calendar = new Calendar();
$this->costs = new Money();
$this->budget = new Money();
$this->earnings = new Money();
$this->setName($name);
}
/**
* Get id.
*
* @return int Model id
*
* @since 1.0.0
*/
public function getId() : int
{
return $this->id;
}
/**
* Get media files.
*
* @return array
*
* @since 1.0.0
*/
public function getMedia() : array
{
return $this->media;
}
/**
* Add media file.
*
* @param mixed $media Media
*
* @return void
*
* @since 1.0.0
*/
public function addMedia($media) : void
{
$this->media[] = $media;
}
/**
* Add task.
*
* @param Task $task Task
*
* @return void
*
* @since 1.0.0
*/
public function addTask(Task $task) : void
{
if ($task->getId() !== 0) {
$this->tasks[$task->getId()] = $task;
} else {
$this->tasks[] = $task;
}
}
/**
* Remove task
*
* @param int $id id to remove
*
* @return bool
*
* @since 1.0.0
*/
public function removeTask(int $id) : bool
{
if (isset($this->tasks[$id])) {
unset($this->tasks[$id]);
return true;
}
return false;
}
/**
* Get task by id.
*
* @param int $id Task id
*
* @return Task
*
* @since 1.0.0
*/
public function getTask(int $id) : Task
{
return $this->tasks[$id] ?? new Task();
}
/**
* Get tasks.
*
* @return array
*
* @since 1.0.0
*/
public function getTasks() : array
{
return $this->tasks;
}
/**
* Count tasks.
*
* @return int
*
* @since 1.0.0
*/
public function countTasks() : int
{
return \count($this->tasks);
}
/**
* Get start date.
*
* @return \DateTime
*
* @since 1.0.0
*/
public function getStart() : \DateTime
{
return $this->start;
}
/**
* Set start date.
*
* @param \DateTime $start Start date
*
* @return void
*
* @since 1.0.0
*/
public function setStart(\DateTime $start) : void
{
$this->start = $start;
}
/**
* Set end.
*
* @param \DateTime $end End date
*
* @return void
*
* @since 1.0.0
*/
public function setEnd(\DateTime $end) : void
{
$this->end = $end;
}
/**
* Get end.
*
* @return \DateTime
*
* @since 1.0.0
*/
public function getEnd() : \DateTime
{
return $this->end;
}
/**
* Get progress.
*
* @return int
*
* @since 1.0.0
*/
public function getProgress() : int
{
return $this->progress;
}
/**
* Set progress.
*
* @param int $progress Progress
*
* @return void
*
* @since 1.0.0
*/
public function setProgress(int $progress) : void
{
$this->progress = $progress;
}
/**
* Get progress type.
*
* @return int
*
* @since 1.0.0
*/
public function getProgressType() : int
{
return $this->progressType;
}
/**
* Set progress type.
*
* @param int $type Progress type
*
* @return void
*
* @since 1.0.0
*/
public function setProgressType(int $type) : void
{
$this->progressType = $type;
}
/**
* Get calendar.
*
* @return Calendar
*
* @since 1.0.0
*/
public function getCalendar() : Calendar
{
return $this->calendar;
}
/**
* Get name
*
* @return string
*
* @since 1.0.0
*/
public function getName() : string
{
return $this->name;
}
/**
* Set name
*
* @param string $name Name
*
* @return void
*
* @since 1.0.0
*/
public function setName(string $name) : void
{
$this->name = $name;
$this->calendar->setName($name);
}
/**
* Get description
*
* @return string
*
* @since 1.0.0
*/
public function getDescription() : string
{
return $this->description;
}
/**
* Set description
*
* @param string $description Description
*
* @return void
*
* @since 1.0.0
*/
public function setDescription(string $description) : void
{
$this->description = $description;
}
/**
* Get costs.
*
* @return Money
*
* @since 1.0.0
*/
public function getCosts() : Money
{
return $this->costs;
}
/**
* Get budget.
*
* @return Money
*
* @since 1.0.0
*/
public function getBudget() : Money
{
return $this->budget;
}
/**
* Get earnings.
*
* @return Money
*
* @since 1.0.0
*/
public function getEarnings() : Money
{
return $this->earnings;
}
/**
* Set costs.
*
* @param Money $costs Costs
*
* @return void
*
* @since 1.0.0
*/
public function setCosts(Money $costs) : void
{
$this->costs = $costs;
}
/**
* Set budget.
*
* @param Money $budget Budget
*
* @return void
*
* @since 1.0.0
*/
public function setBudget(Money $budget) : void
{
$this->budget = $budget;
}
/**
* Set earnings.
*
* @param Money $earnings Earnings
*
* @return void
*
* @since 1.0.0
*/
public function setEarnings(Money $earnings) : void
{
$this->earnings = $earnings;
}
/**
* Get created at
*
* @return \DateTime
*
* @since 1.0.0
*/
public function getCreatedAt() : \DateTime
{
return $this->createdAt;
}
/**
* Get created by
*
* @return Account
*
* @since 1.0.0
*/
public function getCreatedBy() : Account
{
return $this->createdBy;
}
/**
* Set creator
*
* @param Account $createdBy Creator
*
* @since 1.0.0
*/
public function setCreatedBy(Account $createdBy) : void
{
$this->createdBy = $createdBy;
}
}