\LibMelanie\Api\Mi\UsersShare

Classe utilisateur pour MI pour la gestion des partages de messagerie

Summary

Methods
Properties
Constants
registerCache()
executeCache()
getList()
$user
$type
$user
$type
TYPE_READ
TYPE_WRITE
TYPE_SEND
TYPE_ADMIN
setMapUser()
getMapUser()
issetMapUser()
setMapType()
getMapType()
issetMapType()
$serializedProperties
$user
$type
N/A
No private methods found
No private properties found
N/A

Constants

TYPE_READ

TYPE_READ ='L'

TYPE_WRITE

TYPE_WRITE ='E'

TYPE_SEND

TYPE_SEND ='C'

TYPE_ADMIN

TYPE_ADMIN ='G'

Properties

$user

$user :string

Identifiant de l'utilisateur

Identifiant de l'utilisateur

Type

string

$type

$type :string

Type de partage (Voir Share::TYPE_*)

Type de partage (Voir Share::TYPE_*)

Type

string

$user

$user :string

Identifiant de l'utilisateur

Type

string

$type

$type :string

Type de partage (Voir Share::TYPE_*)

Type

string

$serializedProperties

$serializedProperties :

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

Type

$user

$user :string

Identifiant de l'utilisateur

Type

string

$type

$type :string

Type de partage (Voir Share::TYPE_*)

Type

string

Methods

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

setMapUser()

setMapUser(string  $user)

Mapping user field

Parameters

string $user

getMapUser()

getMapUser(): string

Mapping user field

Returns

string —

$user

issetMapUser()

issetMapUser(): boolean

Mapping user field

Returns

boolean

setMapType()

setMapType(string  $type)

Mapping type field

Parameters

string $type

getMapType()

getMapType(): string

Mapping type field

Returns

string —

$type

issetMapType()

issetMapType(): boolean

Mapping type field

Returns

boolean