155 lines
4.7 KiB
PHP
155 lines
4.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Kolab Task (ToDo) model class
|
|
*
|
|
* @version @package_version@
|
|
* @author Thomas Bruederli <bruederli@kolabsys.com>
|
|
*
|
|
* Copyright (C) 2012, Kolab Systems AG <contact@kolabsys.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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
class kolab_format_task extends kolab_format_xcal
|
|
{
|
|
public $CTYPEv2 = 'application/x-vnd.kolab.task';
|
|
|
|
public static $scheduling_properties = array('start', 'due', 'summary', 'status');
|
|
|
|
protected $objclass = 'Todo';
|
|
protected $read_func = 'readTodo';
|
|
protected $write_func = 'writeTodo';
|
|
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
function __construct($data = null, $version = 3.0)
|
|
{
|
|
parent::__construct(is_string($data) ? $data : null, $version);
|
|
|
|
// copy static property overriden by this class
|
|
$this->_scheduling_properties = self::$scheduling_properties;
|
|
}
|
|
|
|
/**
|
|
* Set properties to the kolabformat object
|
|
*
|
|
* @param array Object data as hash array
|
|
*/
|
|
public function set(&$object)
|
|
{
|
|
// set common xcal properties
|
|
parent::set($object);
|
|
|
|
$this->obj->setPercentComplete(intval($object['complete']));
|
|
|
|
$status = kolabformat::StatusUndefined;
|
|
if ($object['complete'] == 100 && !array_key_exists('status', $object))
|
|
$status = kolabformat::StatusCompleted;
|
|
else if ($object['status'] && array_key_exists($object['status'], $this->status_map))
|
|
$status = $this->status_map[$object['status']];
|
|
$this->obj->setStatus($status);
|
|
|
|
$this->obj->setStart(self::get_datetime($object['start'], null, $object['start']->_dateonly));
|
|
$this->obj->setDue(self::get_datetime($object['due'], null, $object['due']->_dateonly));
|
|
|
|
$related = new vectors;
|
|
if (!empty($object['parent_id']))
|
|
$related->push($object['parent_id']);
|
|
$this->obj->setRelatedTo($related);
|
|
|
|
// cache this data
|
|
$this->data = $object;
|
|
unset($this->data['_formatobj']);
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public function is_valid()
|
|
{
|
|
return !$this->formaterror && ($this->data || (is_object($this->obj) && $this->obj->isValid()));
|
|
}
|
|
|
|
/**
|
|
* Convert the Configuration object into a hash array data structure
|
|
*
|
|
* @param array Additional data for merge
|
|
*
|
|
* @return array Config object data as hash array
|
|
*/
|
|
public function to_array($data = array())
|
|
{
|
|
// return cached result
|
|
if (!empty($this->data))
|
|
return $this->data;
|
|
|
|
// read common xcal props
|
|
$object = parent::to_array($data);
|
|
|
|
$object['complete'] = intval($this->obj->percentComplete());
|
|
|
|
// if due date is set
|
|
if ($due = $this->obj->due())
|
|
$object['due'] = self::php_datetime($due);
|
|
|
|
// related-to points to parent task; we only support one relation
|
|
$related = self::vector2array($this->obj->relatedTo());
|
|
if (count($related))
|
|
$object['parent_id'] = $related[0];
|
|
|
|
// TODO: map more properties
|
|
|
|
$this->data = $object;
|
|
return $this->data;
|
|
}
|
|
|
|
/**
|
|
* Return the reference date for recurrence and alarms
|
|
*
|
|
* @return mixed DateTime instance of null if no refdate is available
|
|
*/
|
|
public function get_reference_date()
|
|
{
|
|
if ($this->data['due'] && $this->data['due'] instanceof DateTime) {
|
|
return $this->data['due'];
|
|
}
|
|
|
|
return self::php_datetime($this->obj->due()) ?: parent::get_reference_date();
|
|
}
|
|
|
|
/**
|
|
* Callback for kolab_storage_cache to get object specific tags to cache
|
|
*
|
|
* @return array List of tags to save in cache
|
|
*/
|
|
public function get_tags($obj = null)
|
|
{
|
|
$tags = parent::get_tags($obj);
|
|
$object = $obj ?: $this->data;
|
|
|
|
if ($object['status'] == 'COMPLETED' || ($object['complete'] == 100 && empty($object['status'])))
|
|
$tags[] = 'x-complete';
|
|
|
|
if ($object['priority'] == 1)
|
|
$tags[] = 'x-flagged';
|
|
|
|
if ($object['parent_id'])
|
|
$tags[] = 'x-parent:' . $object['parent_id'];
|
|
|
|
return array_unique($tags);
|
|
}
|
|
|
|
}
|