\LibMelanie\Api\Defaut\PostsPost

Classe de gestion des Posts

Summary

Methods
Properties
Constants
registerCache()
executeCache()
getList()
__construct()
listComments()
countComments()
listReactions()
listImages()
countReactions()
listTags()
addTag()
removeTag()
countTags()
listPosts()
load()
exists()
save()
delete()
$id
$uid
$title
$summary
$content
$created
$modified
$creator
$workspace
$settings
$history
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$id

$id :integer

Identifiant unique entier du post

Type

integer

$uid

$uid :string

Identifiant unique string du post

Type

string

$title

$title :string

Titre donné au post

Type

string

$summary

$summary :string

Résumé du post

Type

string

$content

$content :string

Contenu du post

Type

string

$created

$created :string

timestamp de création du post (format Y-m-d H:i:s)

Type

string

$modified

$modified :string

timestamp de modification du post (format Y-m-d H:i:s)

Type

string

$creator

$creator :string

uid de l'utilisateur qui a créé le post

Type

string

$workspace

$workspace :string

uid de l'espace de travail associé au post

Type

string

$settings

$settings :array

Paramètres du post

Type

array

$history

$history :array

Historique en JSON du post

Type

array

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

__construct()

__construct(\LibMelanie\Api\Defaut\Workspace  $workspace = null,string  $creator = null)

Constructeur de l'objet

Parameters

\LibMelanie\Api\Defaut\Workspace $workspace

Workspace

string $creator

uid de l'utilisateur qui a créé le post

listComments()

listComments(boolean  $onlyParent = false,string  $search = null,string  $orderby = 'created',boolean  $asc = true): array<mixed,\LibMelanie\Api\Defaut\Posts\Comment>

Récupère la liste des commentaires associés au post

Parameters

boolean $onlyParent

Récupérer uniquement les commentaires de premier niveau

string $search

Recherche

string $orderby

Champ de tri

boolean $asc

Tri ascendant ou descendant

Returns

array<mixed,\LibMelanie\Api\Defaut\Posts\Comment> —

Liste des commentaires

countComments()

countComments(): integer

Compte le nombre de commentaires associés au post

Returns

integer —

Nombre de commentaires

listReactions()

listReactions(): array<mixed,\LibMelanie\Api\Defaut\Posts\Reaction>

Récupère la liste des réactions associées au post

Returns

array<mixed,\LibMelanie\Api\Defaut\Posts\Reaction> —

Liste des réactions

listImages()

listImages(): array<mixed,\LibMelanie\Api\Defaut\Posts\Image>

Récupère la liste des images associées au post

Returns

array<mixed,\LibMelanie\Api\Defaut\Posts\Image> —

Liste des images

countReactions()

countReactions(): integer

Compte le nombre de réactions associées au post

Returns

integer —

Nombre de réactions

listTags()

listTags(array<mixed,\LibMelanie\Api\Defaut\Posts\Post>  $postsList = array()): array<mixed,\LibMelanie\Api\Defaut\Posts\Tag>

Récupère la liste des tags associés au post

Parameters

array<mixed,\LibMelanie\Api\Defaut\Posts\Post> $postsList

Liste des posts

Returns

array<mixed,\LibMelanie\Api\Defaut\Posts\Tag> —

Liste des tags

addTag()

addTag(\LibMelanie\Api\Defaut\Posts\Tag  $tag): boolean

Associer un tag au post courant

Parameters

\LibMelanie\Api\Defaut\Posts\Tag $tag

Tag à associer

Returns

boolean —

Vrai si l'association a été faite

removeTag()

removeTag(\LibMelanie\Api\Defaut\Posts\Tag  $tag): boolean

Dissocier un tag du post courant

Parameters

\LibMelanie\Api\Defaut\Posts\Tag $tag

Tag à dissocier

Returns

boolean —

Vrai si la dissociation a été faite

countTags()

countTags(): integer

Compte le nombre de tags associés au post

Returns

integer —

Nombre de tags

listPosts()

listPosts(string  $search = null,  $tags = array(),string  $orderby = 'created',boolean  $asc = true,integer  $limit = null,integer  $offset = null): array<mixed,\LibMelanie\Api\Defaut\Posts\Post>

Récupère la liste des posts

Parameters

string $search

Recherche

$tags
string $orderby

Champ de tri

boolean $asc

Tri ascendant ou descendant

integer $limit

Limite de résultats

integer $offset

Offset de résultats

Returns

array<mixed,\LibMelanie\Api\Defaut\Posts\Post> —

Liste des posts

load()

load(): boolean

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

Returns

boolean

exists()

exists(): boolean

Est-ce que le post existe dans la base de données ?

Returns

boolean

save()

save(): boolean

Enregistre le post dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime le post de la base de données

Returns

boolean