Tasks doc comments

This commit is contained in:
Dennis Eichhorn 2016-02-11 22:31:42 +01:00
parent da1fa7f921
commit ed7b69c0d2
3 changed files with 62 additions and 3 deletions

View File

@ -20,8 +20,8 @@ use phpOMS\Datatypes\Exception\InvalidEnumValue;
/** /**
* Task class. * Task class.
* *
* @category Modules * @category Tasks
* @package Tasks * @package Modules
* @author OMS Development Team <dev@oms.com> * @author OMS Development Team <dev@oms.com>
* @author Dennis Eichhorn <d.eichhorn@oms.com> * @author Dennis Eichhorn <d.eichhorn@oms.com>
* @license OMS License 1.0 * @license OMS License 1.0
@ -111,6 +111,12 @@ class Task
*/ */
private $taskElements = []; private $taskElements = [];
/**
* Schedule
*
* @var Schedule
* @since 1.0.0
*/
private $schedule = null; private $schedule = null;
/** /**
@ -380,6 +386,14 @@ class Task
return $this->type; return $this->type;
} }
/**
* Get schedule.
*
* @return Schedule
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getSchedule() : Schedule { public function getSchedule() : Schedule {
return $this->schedule; return $this->schedule;
} }

View File

@ -16,8 +16,18 @@
namespace Modules\Tasks\Models; namespace Modules\Tasks\Models;
use phpOMS\DataStorage\Database\DataMapperAbstract; use phpOMS\DataStorage\Database\DataMapperAbstract;
use phpOMS\DataStorage\Database\Query\Builder;
/**
* Mapper class.
*
* @category Tasks
* @package Modules
* @author OMS Development Team <dev@oms.com>
* @author Dennis Eichhorn <d.eichhorn@oms.com>
* @license OMS License 1.0
* @link http://orange-management.com
* @since 1.0.0
*/
class TaskElementMapper extends DataMapperAbstract class TaskElementMapper extends DataMapperAbstract
{ {
@ -46,6 +56,12 @@ class TaskElementMapper extends DataMapperAbstract
*/ */
protected static $table = 'task_element'; protected static $table = 'task_element';
/**
* Created at.
*
* @var string
* @since 1.0.0
*/
protected static $createdAt = 'task_created_at'; protected static $createdAt = 'task_created_at';
/** /**

View File

@ -19,6 +19,17 @@ use phpOMS\DataStorage\Database\DataMapperAbstract;
use phpOMS\DataStorage\Database\Query\Builder; use phpOMS\DataStorage\Database\Query\Builder;
use phpOMS\DataStorage\Database\Query\Column; use phpOMS\DataStorage\Database\Query\Column;
/**
* Mapper class.
*
* @category Tasks
* @package Modules
* @author OMS Development Team <dev@oms.com>
* @author Dennis Eichhorn <d.eichhorn@oms.com>
* @license OMS License 1.0
* @link http://orange-management.com
* @since 1.0.0
*/
class TaskMapper extends DataMapperAbstract class TaskMapper extends DataMapperAbstract
{ {
@ -41,6 +52,12 @@ class TaskMapper extends DataMapperAbstract
'task_created_at' => ['name' => 'task_created_at', 'type' => 'DateTime', 'internal' => 'createdAt'], 'task_created_at' => ['name' => 'task_created_at', 'type' => 'DateTime', 'internal' => 'createdAt'],
]; ];
/**
* Has many relation.
*
* @var array<string, array>
* @since 1.0.0
*/
protected static $hasMany = [ protected static $hasMany = [
'taskElements' => [ 'taskElements' => [
'mapper' => '\Modules\Tasks\Models\TaskElementMapper', 'mapper' => '\Modules\Tasks\Models\TaskElementMapper',
@ -51,6 +68,12 @@ class TaskMapper extends DataMapperAbstract
], ],
]; ];
/**
* Has one relation.
*
* @var array<string, array>
* @since 1.0.0
*/
protected static $hasOne = [ protected static $hasOne = [
'schedule' => [ 'schedule' => [
'mapper' => '\Modules\Calendar\Models\ScheduleMapper', 'mapper' => '\Modules\Calendar\Models\ScheduleMapper',
@ -66,6 +89,12 @@ class TaskMapper extends DataMapperAbstract
*/ */
protected static $table = 'task'; protected static $table = 'task';
/**
* Created at.
*
* @var string
* @since 1.0.0
*/
protected static $createdAt = 'task_created_at'; protected static $createdAt = 'task_created_at';
/** /**