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\Dgfip\UsersOutofoffice

Classe utilisateur pour DGFIP utilisation de la syntaxe Mél pour la gestion du gestionnaire d'absence

Summary

Methods
Properties
Constants
define()
render()
__construct()
registerCache()
executeCache()
getList()
$start
$end
$enable
$message
$order
$type
$start
$end
$enable
$message
$order
$type
$start
$end
$enable
$message
$order
$type
$days
$hour_start
$hour_end
$offset
TYPE_EXTERNAL
TYPE_INTERNAL
TYPE_ALL
HEBDO
DAY_SUNDAY
DAY_MONDAY
DAY_TUESDAY
DAY_WEDNESDAY
DAY_THURSDAY
DAY_FRIDAY
DAY_SATURDAY
setTypeInternal()
setTypeExternal()
setTypeAll()
setMapStart()
setMapEnd()
setMapHour_start()
getMapHour_start()
setMapHour_end()
getMapHour_end()
setMapOffset()
setMapDays()
getMapDays()
isLocalTimezone()
getMapStart()
issetMapStart()
getMapEnd()
issetMapEnd()
issetMapDays()
issetMapHour_start()
issetMapHour_end()
getMapOffset()
issetMapOffset()
setMapEnable()
getMapEnable()
issetMapEnable()
setMapMessage()
getMapMessage()
issetMapMessage()
setMapOrder()
getMapOrder()
issetMapOrder()
setMapType()
getMapType()
issetMapType()
$serializedProperties
$start
$end
$days
$hour_start
$hour_end
$offset
$enable
$message
$order
$type
N/A
No private methods found
$mapping
$mappingDays
N/A

Constants

TYPE_EXTERNAL

TYPE_EXTERNAL ='ext'

TYPE_INTERNAL

TYPE_INTERNAL ='int'

TYPE_ALL

TYPE_ALL ='all'

HEBDO

HEBDO ='hebdo'

DAY_SUNDAY

DAY_SUNDAY ='sun'

DAY_MONDAY

DAY_MONDAY ='mon'

DAY_TUESDAY

DAY_TUESDAY ='tue'

DAY_WEDNESDAY

DAY_WEDNESDAY ='wed'

DAY_THURSDAY

DAY_THURSDAY ='thu'

DAY_FRIDAY

DAY_FRIDAY ='fri'

DAY_SATURDAY

DAY_SATURDAY ='sat'

Properties

$start

$start :\Datetime

Date de début de l'absence

Type

\Datetime

$end

$end :\Datetime

Date de fin de l'absence

Type

\Datetime

$enable

$enable :boolean

Est-ce que l'absence est active

Type

boolean

$message

$message :string

Message d'absence a afficher

Type

string

$order

$order :integer

Ordre de tri du message d'absence

Type

integer

$type

$type :\LibMelanie\Api\Dgfip\Users\Outofoffice::TYPE_*

Type d'absence (Interne, Externe)

Type

\LibMelanie\Api\Dgfip\Users\Outofoffice::TYPE_*

$start

$start :\Datetime

Date de début de l'absence

Date de début de l'absence

Type

\Datetime

$end

$end :\Datetime

Date de fin de l'absence

Date de fin de l'absence

Type

\Datetime

$enable

$enable :\boolean

Est-ce que l'absence est active

Est-ce que l'absence est active

Type

\boolean

$message

$message :\string

Message d'absence a afficher

Message d'absence a afficher

Type

\string

$order

$order :\int

Ordre de tri du message d'absence

Ordre de tri du message d'absence

Type

\int

$type

$type :\LibMelanie\Api\Mel\Users\Outofoffice::TYPE_*

Type d'absence (Interne, Externe)

Type d'absence (Interne, Externe)

Type

\LibMelanie\Api\Mel\Users\Outofoffice::TYPE_*

$start

$start :\Datetime

Date de début de l'absence

Type

\Datetime

$end

$end :\Datetime

Date de fin de l'absence

Type

\Datetime

$enable

$enable :boolean

Est-ce que l'absence est active

Type

boolean

$message

$message :string

Message d'absence a afficher

Type

string

$order

$order :integer

Ordre de tri du message d'absence

Type

integer

$type

$type :\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*

Type d'absence (Interne, Externe)

Type

\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*

$days

$days :array<mixed,\LibMelanie\Api\Defaut\Users\Outofoffice::DAY_*>

Liste des jours pour une absence hebdomadaire

Type

array<mixed,\LibMelanie\Api\Defaut\Users\Outofoffice::DAY_*>

$hour_start

$hour_start :\Datetime

Heure de début de l'absence

Type

\Datetime

$hour_end

$hour_end :\Datetime

Heure de fin de l'absence

Type

\Datetime

$offset

$offset :integer

Offset du timezone en fonction de GMT

Type

integer

$serializedProperties

$serializedProperties :

Liste des propriétés à sérialiser pour le cache

Type

$start

$start :\Datetime

Date de début de l'absence

Type

\Datetime

$end

$end :\Datetime

Date de fin de l'absence

Type

\Datetime

$days

$days :array

Liste des jours pour une récurrence hebdomadaire

Type

array

$hour_start

$hour_start :\Datetime

Heure de début pour une absence récurrente

Type

\Datetime

$hour_end

$hour_end :\Datetime

Heure de fin pour une absence récurrente

Type

\Datetime

$offset

$offset :integer

Offset du timezone en fonction de GMT

Type

integer

$enable

$enable :boolean

Est-ce que l'absence est active

Type

boolean

$message

$message :string

Message d'absence a afficher

Type

string

$order

$order :integer

Ordre de tri du message d'absence

Type

integer

$type

$type :\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*

Type d'absence (Interne, Externe)

Type

\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*

$mapping

$mapping :

Mapping champ ldap => fonction set

Type

$mappingDays

$mappingDays :

Mapping des jours dans l'annuaire

Type

Methods

define()

define(  $data)

Define depuis un format annuaire l'entrée du message d'absence

Parameters

$data

render()

render()

Retourne au format annuaire l'entrée du message d'absence

__construct()

__construct(  $data = null)

Constructeur permettant de parser les données

Parameters

$data

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)

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

setTypeInternal()

setTypeInternal()

Positionne le type Internal

setTypeExternal()

setTypeExternal()

Positionne le type External

setTypeAll()

setTypeAll()

Positionne le type All

setMapStart()

setMapStart(\Datetime  $start)

Mapping start field

Parameters

\Datetime $start

setMapEnd()

setMapEnd(\Datetime  $end)

Mapping end field

Parameters

\Datetime $end

setMapHour_start()

setMapHour_start(\Datetime  $hour_start)

Mapping hour_start field

Parameters

\Datetime $hour_start

getMapHour_start()

getMapHour_start(): \Datetime

Mapping hour_start field

Returns

\Datetime —

$hour_start

setMapHour_end()

setMapHour_end(\Datetime  $hour_end)

Mapping hour_end field

Parameters

\Datetime $hour_end

getMapHour_end()

getMapHour_end(): \Datetime

Mapping hour_end field

Returns

\Datetime —

$hour_end

setMapOffset()

setMapOffset(integer  $offset)

Mapping offset field

Parameters

integer $offset

setMapDays()

setMapDays(array  $days)

Mapping days field

Parameters

array $days

getMapDays()

getMapDays(): array

Mapping days field

Returns

array —

$days

isLocalTimezone()

isLocalTimezone(\DateTimeZone  $timezone): boolean

Retourne si le timezone est local

Parameters

\DateTimeZone $timezone

Returns

boolean

getMapStart()

getMapStart(): \Datetime

Mapping start field

Returns

\Datetime —

$start

issetMapStart()

issetMapStart(): boolean

Mapping start field

Returns

boolean

getMapEnd()

getMapEnd(): \Datetime

Mapping end field

Returns

\Datetime —

$end

issetMapEnd()

issetMapEnd(): boolean

Mapping end field

Returns

boolean

issetMapDays()

issetMapDays(): boolean

Mapping days field

Returns

boolean

issetMapHour_start()

issetMapHour_start(): boolean

Mapping hour_start field

Returns

boolean

issetMapHour_end()

issetMapHour_end(): boolean

Mapping hour_end field

Returns

boolean

getMapOffset()

getMapOffset(): integer

Mapping offset field

Returns

integer —

$offset

issetMapOffset()

issetMapOffset(): boolean

Mapping offset field

Returns

boolean

setMapEnable()

setMapEnable(boolean  $enable)

Mapping enable field

Parameters

boolean $enable

getMapEnable()

getMapEnable(): boolean

Mapping enable field

Returns

boolean —

$enable

issetMapEnable()

issetMapEnable(): boolean

Mapping enable field

Returns

boolean

setMapMessage()

setMapMessage(string  $message)

Mapping message field

Parameters

string $message

getMapMessage()

getMapMessage(): string

Mapping message field

Returns

string —

$message

issetMapMessage()

issetMapMessage(): boolean

Mapping message field

Returns

boolean

setMapOrder()

setMapOrder(integer  $order)

Mapping order field

Parameters

integer $order

getMapOrder()

getMapOrder(): integer

Mapping order field

Returns

integer —

$order

issetMapOrder()

issetMapOrder(): boolean

Mapping order field

Returns

boolean

setMapType()

setMapType(\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*  $type)

Mapping type field

Parameters

\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_* $type

getMapType()

getMapType(): \LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_*

Mapping type field

Returns

\LibMelanie\Api\Defaut\Users\Outofoffice::TYPE_* —

$type

issetMapType()

issetMapType(): boolean

Mapping type field

Returns

boolean