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\MelWorkspace

Classe workspace par defaut

Summary

Methods
Properties
Constants
__construct()
save()
delete()
listWorkspacesByHashtag()
listPublicsWorkspaces()
createEmailList()
getEmailList()
registerCache()
executeCache()
getList()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
$id
$uid
$created
$modified
$creator
$title
$description
$logo
$ispublic
$isarchived
$objects
$links
$flux
$settings
$shares
$hashtags
$id
$uid
$created
$modified
$creator
$title
$description
$logo
$ispublic
$isarchived
$objects
$links
$flux
$settings
$shares
$hashtags
No constants found
saveShares()
saveHashtags()
deleteHashtags()
getListEmailAddress()
setMapHashtags()
getMapHashtags()
loadHastags()
setMapShares()
getMapShares()
loadShares()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$id

$id :string

Identifiant numérique du workspace

Type

string

$uid

$uid :string

Identifiant unique du workspace

Type

string

$created

$created :integer

Timestamp de creation du workspace

Type

integer

$modified

$modified :integer

Timestamp de modification du workspace

Type

integer

$creator

$creator :string

Uid utilisateur du createur

Type

string

$title

$title :string

Titre du workspace

Type

string

$description

$description :string

Description du workspace

Type

string

$logo

$logo :string

Logo du workspace

Type

string

$ispublic

$ispublic :boolean

Est-ce que le workspace est public ?

Type

boolean

$isarchived

$isarchived :boolean

Est-ce que le workspace est archivé ?

Type

boolean

$objects

$objects :string

JSON des objets du workspace

Type

string

$links

$links :string

JSON des liens utiles du workspace

Type

string

$flux

$flux :string

JSON des flux rss du workspace

Type

string

$settings

$settings :string

JSON des paramètres du workspace

Type

string

$shares

$shares :array<mixed,\LibMelanie\Api\Mel\Workspaces\Share>

Liste des partages du workspaces

Type

array<mixed,\LibMelanie\Api\Mel\Workspaces\Share>

$hashtags

$hashtags :array<mixed,string>

Liste des hashtags du workspaces

Type

array<mixed,string>

$id

$id :string

Identifiant numérique du workspace

Type

string

$uid

$uid :string

Identifiant unique du workspace

Type

string

$created

$created :integer

Timestamp de creation du workspace

Type

integer

$modified

$modified :integer

Timestamp de modification du workspace

Type

integer

$creator

$creator :string

Uid utilisateur du createur

Type

string

$title

$title :string

Titre du workspace

Type

string

$description

$description :string

Description du workspace

Type

string

$logo

$logo :string

Logo du workspace

Type

string

$ispublic

$ispublic :boolean

Est-ce que le workspace est public ?

Type

boolean

$isarchived

$isarchived :boolean

Est-ce que le workspace est archivé ?

Type

boolean

$objects

$objects :string

JSON des objets du workspace

Type

string

$links

$links :string

JSON des liens utiles du workspace

Type

string

$flux

$flux :string

JSON des flux rss du workspace

Type

string

$settings

$settings :string

JSON des paramètres du workspace

Type

string

$shares

$shares :array<mixed,\LibMelanie\Api\Defaut\Workspaces\Share>

Liste des partages du workspaces

Type

array<mixed,\LibMelanie\Api\Defaut\Workspaces\Share>

$hashtags

$hashtags :array<mixed,string>

Liste des hashtags du workspaces

Type

array<mixed,string>

Methods

__construct()

__construct(\LibMelanie\Api\Gen\User  $user = null)

Constructeur de l'objet

Parameters

\LibMelanie\Api\Gen\User $user

save()

save(): null

Enregistrement de l'objet Nettoie le cache du user

Returns

null —

si erreur, boolean sinon (true insert, false update)

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Returns

boolean

listWorkspacesByHashtag()

listWorkspacesByHashtag(string  $hashtag,string  $orderby = null,boolean  $asc = true,integer  $limit = null,integer  $offset = null): array<mixed,\LibMelanie\Api\Defaut\Workspace>

Lister les workspaces par hashtag

Parameters

string $hashtag

Hashtag recherché
string $orderby

[Optionnel] nom du champ a trier
boolean $asc

[Optionnel] tri ascendant ?
integer $limit

[Optionnel] limite du nombre de résultats à retourner
integer $offset

[Optionnel] offset pour la pagination

Returns

array<mixed,\LibMelanie\Api\Defaut\Workspace>

listPublicsWorkspaces()

listPublicsWorkspaces(string  $orderby = null,boolean  $asc = true,integer  $limit = null,integer  $offset = null): array<mixed,\LibMelanie\Api\Defaut\Workspace>

Lister les workspaces par hashtag

Parameters

string $orderby

[Optionnel] nom du champ a trier
boolean $asc

[Optionnel] tri ascendant ?
integer $limit

[Optionnel] limite du nombre de résultats à retourner
integer $offset

[Optionnel] offset pour la pagination

Returns

array<mixed,\LibMelanie\Api\Defaut\Workspace>

createEmailList()

createEmailList(  $members_email = array(),  $domain = null,  $prefix = 'edt'): \LibMelanie\Api\Gen\Group|null

Créer une liste de diffusion associée au workspace

Parameters

$members_email
$domain
$prefix

Returns

\LibMelanie\Api\Gen\Group|null —

Retourne la liste créée ou null si erreur

getEmailList()

getEmailList(): \LibMelanie\Api\Gen\Group|null

Récupérer la liste associée au workspace

Returns

\LibMelanie\Api\Gen\Group|null —

Retourne la liste associée ou null si elle n'existe pas

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

load()

load(): boolean

Charge les données du workspace depuis la base de données

Returns

boolean

exists()

exists(): boolean

Recherche si le workspace existe dans la base de données

Returns

boolean

save()

save(): boolean

Enregistrement de l'objet Nettoie le cache du user

Enregistre le workspace dans la base de données

Returns

boolean

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Supprime le workspace de la base de données

Returns

boolean

load()

load(): boolean

Charge les données du workspace depuis la base de données

Returns

boolean

exists()

exists(): boolean

Recherche si le workspace existe dans la base de données

Returns

boolean

save()

save(): boolean

Enregistre le workspace dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime le workspace de la base de données

Returns

boolean

saveShares()

saveShares()

Enregistrer les partages modifiés dans la base de données

saveHashtags()

saveHashtags()

Enregistrer les hashtags modifiés dans la base de données

deleteHashtags()

deleteHashtags()

Supprimer les hashtags et les refs

getListEmailAddress()

getListEmailAddress(  $prefix = '',string  $domain = null)

Retourne l'adresse email de la liste

Parameters

$prefix
string $domain

Nom de domaine pour l'adresse email

setMapHashtags()

setMapHashtags(array<mixed,string>  $hashtags)

Mapping hashtags field

Parameters

array<mixed,string> $hashtags

getMapHashtags()

getMapHashtags(): array<mixed,string>

Mapping hashtags field

Returns

array<mixed,string>

loadHastags()

loadHastags()

Chargement des hashtags du workspace

loadShares()

loadShares()

Chargement des shares du workspace