API Documentation
\
LibMelanie
Api
Defaut
News
Posts
Comments
Resources
Users
Workspaces
Dgfip
News
Users
Ens
News
Users
Workspaces
Gn
News
Users
Mce
News
Users
Workspaces
Mel
News
Resources
Users
Workspaces
Melanie2
Mi
News
Users
Cache
Config
Exceptions
Interfaces
Ldap
Lib
Log
Mail
Objects
Sql

\LibMelanie\Api\MiTask

Classe tâche pour MI implémente les API de la librairie pour aller chercher les données dans la base de données Certains champs sont mappés directement ou passe par des classes externes

Summary

Methods
Properties
Constants
__construct()
getAttribute()
setAttribute()
deleteAttribute()
getList()
registerCache()
executeCache()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
$id
$taskslist
$uid
$owner
$name
$description
$priority
$category
$alarm
$completed
$class
$assignee
$estimate
$parent
$due
$completed_date
$start
$modified
$percent_complete
$status
$ics
$id
$taskslist
$uid
$owner
$name
$description
$priority
$category
$alarm
$completed
$class
$assignee
$estimate
$parent
$due
$completed_date
$start
$modified
$percent_complete
$status
$ics
CLASS_PRIVATE
CLASS_PUBLIC
CLASS_CONFIDENTIAL
PRIORITY_NO
PRIORITY_VERY_HIGH
PRIORITY_HIGH
PRIORITY_NORMAL
PRIORITY_LOW
PRIORITY_VERY_LOW
COMPLETED_TRUE
COMPLETED_FALSE
STATUS_IN_PROCESS
STATUS_NEEDS_ACTION
STATUS_CANCELLED
STATUS_COMPLETED
setMapClass()
getMapClass()
setMapPriority()
getMapPriority()
setMapPercent_Complete()
getMapPercent_Complete()
issetMapPercent_Complete()
setMapStatus()
getMapStatus()
issetMapStatus()
$user
$taskslistmce
N/A
saveAttributes()
loadAttributes()
deleteAttributes()
$attributes
$attributes_loaded
N/A

Constants

CLASS_PRIVATE

CLASS_PRIVATE =\LibMelanie\Config\DefaultConfig::PRIV

CLASS_PUBLIC

CLASS_PUBLIC =\LibMelanie\Config\DefaultConfig::PUB

CLASS_CONFIDENTIAL

CLASS_CONFIDENTIAL =\LibMelanie\Config\DefaultConfig::CONFIDENTIAL

PRIORITY_NO

PRIORITY_NO =\LibMelanie\Config\DefaultConfig::NO_PRIORITY

PRIORITY_VERY_HIGH

PRIORITY_VERY_HIGH =\LibMelanie\Config\DefaultConfig::VERY_HIGH

PRIORITY_HIGH

PRIORITY_HIGH =\LibMelanie\Config\DefaultConfig::HIGH

PRIORITY_NORMAL

PRIORITY_NORMAL =\LibMelanie\Config\DefaultConfig::NORMAL

PRIORITY_LOW

PRIORITY_LOW =\LibMelanie\Config\DefaultConfig::LOW

PRIORITY_VERY_LOW

PRIORITY_VERY_LOW =\LibMelanie\Config\DefaultConfig::VERY_LOW

COMPLETED_TRUE

COMPLETED_TRUE =\LibMelanie\Config\DefaultConfig::COMPLETED

COMPLETED_FALSE

COMPLETED_FALSE =\LibMelanie\Config\DefaultConfig::NOTCOMPLETED

STATUS_IN_PROCESS

STATUS_IN_PROCESS ='IN-PROCESS'

STATUS_NEEDS_ACTION

STATUS_NEEDS_ACTION ='NEEDS-ACTION'

STATUS_CANCELLED

STATUS_CANCELLED ='CANCELLED'

STATUS_COMPLETED

STATUS_COMPLETED ='COMPLETED'

Properties

$id

$id :string

Identifiant unique de la tâche

Type

string

$taskslist

$taskslist :string

Identifiant de la liste de tâches associée

Type

string

$uid

$uid :string

UID de la tâche

Type

string

$owner

$owner :string

Créateur de la tâche

Type

string

$name

$name :string

Nom de la tâche

Type

string

$description

$description :string

Description de la tâche

Type

string

$priority

$priority :\LibMelanie\Api\Mi\Task::PRIORITY_*

Priorité de la tâche

Type

\LibMelanie\Api\Mi\Task::PRIORITY_*

$category

$category :string

Catégorie de la tâche

Type

string

$alarm

$alarm :integer

Alarme en minute (TODO: class Alarm)

Type

integer

$completed

$completed :\LibMelanie\Api\Mi\Task::COMPLETED_*

Tâche terminée

Type

\LibMelanie\Api\Mi\Task::COMPLETED_*

$class

$class :\LibMelanie\Api\Mi\Task::CLASS_*

Class de la tâche (privé/public)

Type

\LibMelanie\Api\Mi\Task::CLASS_*

$assignee

$assignee :string

Utilisateur à qui est assigné la tâche

Type

string

$estimate

$estimate :integer

Estimation de la tâche ?

Type

integer

$parent

$parent :string

ID de la tâche parente

Type

string

$due

$due :integer

Timestamp correspondant à la date de fin prévue

Type

integer

$completed_date

$completed_date :integer

Timestamp correspondant à la date de fin réelle

Type

integer

$start

$start :integer

Timestamp correspondant à la date de début

Type

integer

$modified

$modified :integer

Timestamp de la modification de la tâche Liste des attributs :

Type

integer

$percent_complete

$percent_complete :integer

Pourcentage de réalisation pour la tâche

Type

integer

$status

$status :string

Status de la tâche

Type

string

$ics

$ics :string

ICS associé à l'évènement courant, calculé à la volée en attendant la mise en base de données

Type

string

$id

$id :string

Identifiant unique de la tâche

Type

string

$taskslist

$taskslist :string

Identifiant de la liste de tâches associée

Type

string

$uid

$uid :string

UID de la tâche

Type

string

$owner

$owner :string

Créateur de la tâche

Type

string

$name

$name :string

Nom de la tâche

Type

string

$description

$description :string

Description de la tâche

Type

string

$priority

$priority :\LibMelanie\Api\Defaut\Task::PRIORITY_*

Priorité de la tâche

Type

\LibMelanie\Api\Defaut\Task::PRIORITY_*

$category

$category :string

Catégorie de la tâche

Type

string

$alarm

$alarm :integer

Alarme en minute (TODO: class Alarm)

Type

integer

$completed

$completed :\LibMelanie\Api\Defaut\Task::COMPLETED_*

Tâche terminée

Type

\LibMelanie\Api\Defaut\Task::COMPLETED_*

$class

$class :\LibMelanie\Api\Defaut\Task::CLASS_*

Class de la tâche (privé/public)

Type

\LibMelanie\Api\Defaut\Task::CLASS_*

$assignee

$assignee :string

Utilisateur à qui est assigné la tâche

Type

string

$estimate

$estimate :integer

Estimation de la tâche ?

Type

integer

$parent

$parent :string

ID de la tâche parente

Type

string

$due

$due :integer

Timestamp correspondant à la date de fin prévue

Type

integer

$completed_date

$completed_date :integer

Timestamp correspondant à la date de fin réelle

Type

integer

$start

$start :integer

Timestamp correspondant à la date de début

Type

integer

$modified

$modified :integer

Timestamp de la modification de la tâche Liste des attributs :

Type

integer

$percent_complete

$percent_complete :integer

Pourcentage de réalisation pour la tâche

Type

integer

$status

$status :string

Status de la tâche

Type

string

$ics

$ics :string

ICS associé à l'évènement courant, calculé à la volée en attendant la mise en base de données

Type

string

$attributes

$attributes :array

Tableau d'attributs pour l'évènement

Type

array

$attributes_loaded

$attributes_loaded :boolean

Permet de savoir si les attributs ont déjà été chargés depuis la base

Type

boolean

Methods

getAttribute()

getAttribute(string  $name): string|NULL

Retourne un attribut supplémentaire pour la tâche

Parameters

string $name

Nom de l'attribut

Returns

string|NULL —

valeur de l'attribut, null s'il n'existe pas

setAttribute()

setAttribute(string  $name,string  $value)

Met à jour ou ajoute l'attribut

Parameters

string $name

Nom de l'attribut
string $value

Valeur de l'attribut

deleteAttribute()

deleteAttribute(string  $name)

Suppression d'un attribut

Parameters

string $name

getList()

getList(array<mixed,String>  $fields = array(),String  $filter = "",array<mixed,String>  $operators = array(),String  $orderby = "",boolean  $asc = true,integer  $limit = null,integer  $offset = null,array<mixed,String>  $case_unsensitive_fields = array(),  $join = null,  $type_join = 'INNER',  $using = null,  $prefix = null,  $groupby = array(),  $groupby_count = null,  $subqueries = array()): array<mixed,\LibMelanie\Lib\MceObject>

Permet de récupérer la liste d'objet en utilisant les données passées (la clause where s'adapte aux données) Il faut donc peut être sauvegarder l'objet avant d'appeler cette méthode pour réinitialiser les données modifiées (propriété haschanged)

Parameters

array<mixed,String> $fields

Liste les champs à récupérer depuis les données
String $filter

Filtre pour la lecture des données en fonction des valeurs déjà passé, exemple de filtre : "((#description# OR #title#) AND #start#)"
array<mixed,String> $operators

Liste les propriétés par operateur (MappingMce::like, MappingMce::supp, MappingMce::inf, MappingMce::diff)
String $orderby

Tri par le champ
boolean $asc

Tri ascendant ou non
integer $limit

Limite le nombre de résultat (utile pour la pagination)
integer $offset

Offset de début pour les résultats (utile pour la pagination)
array<mixed,String> $case_unsensitive_fields

Liste des champs pour lesquels on ne sera pas sensible à la casse
$join
$type_join
$using
$prefix
$groupby
$groupby_count
$subqueries

Returns

array<mixed,\LibMelanie\Lib\MceObject> —

Array

registerCache()

registerCache(  $app,  $callback)

Enregistrement des methodes de gestion du cache

Parameters

$app
$callback

executeCache()

executeCache()

Lancement des methodes de gestion du cache (nouveau contenu)

load()

load(): boolean

Chargement l'évènement, en fonction du taskslist et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si l'évènement existe, en fonction du taskslist et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde l'évènement et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime l'évènement et met à jour l'historique dans la base de données

Returns

boolean

load()

load(): boolean

Chargement l'évènement, en fonction du taskslist et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si l'évènement existe, en fonction du taskslist et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde l'évènement et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime l'évènement et met à jour l'historique dans la base de données

Returns

boolean

setMapClass()

setMapClass(\LibMelanie\Api\Defaut\Task::CLASS_*  $class)

Mapping class field

Parameters

\LibMelanie\Api\Defaut\Task::CLASS_* $class

getMapClass()

getMapClass()

Mapping class field

setMapPriority()

setMapPriority(\LibMelanie\Api\Defaut\Task::PRIORITY_*  $priority)

Mapping priority field

Parameters

\LibMelanie\Api\Defaut\Task::PRIORITY_* $priority

getMapPriority()

getMapPriority(): \LibMelanie\Api\Defaut\Task::PRIORITY_*

Mapping priority field

Returns

\LibMelanie\Api\Defaut\Task::PRIORITY_*

setMapPercent_Complete()

setMapPercent_Complete(integer  $percent_complete)

Mapping percent_complete field

Parameters

integer $percent_complete

getMapPercent_Complete()

getMapPercent_Complete(): integer

Mapping percent_complete field

Returns

integer

issetMapPercent_Complete()

issetMapPercent_Complete(): boolean

Mapping percent_complete field

Returns

boolean

setMapStatus()

setMapStatus(\LibMelanie\Api\Defaut\Task::STATUS_*  $status)

Mapping status field

Parameters

\LibMelanie\Api\Defaut\Task::STATUS_* $status

getMapStatus()

getMapStatus(): integer

Mapping percent_complete field

Returns

integer

issetMapStatus()

issetMapStatus(): boolean

Mapping percent_complete field

Returns

boolean

saveAttributes()

saveAttributes()

Sauvegarde les attributs dans la base de données

loadAttributes()

loadAttributes()

Charge les attributs en mémoire

deleteAttributes()

deleteAttributes()

Supprime les attributs