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

Classe pièces jointes pour Melanie2, 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()
getDownloadURL()
getList()
registerCache()
executeCache()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
$id
$modified
$isfolder
$name
$path
$owner
$data
$url
$type
$hash
$size
$contenttype
$id
$modified
$isfolder
$name
$path
$owner
$data
$url
$type
$hash
$size
$contenttype
$id
$modified
$isfolder
$name
$path
$owner
$data
$url
$type
$hash
$size
$contenttype
TYPE_BINARY
TYPE_URL
PATH_ROOT
setMapPath()
setMapIsfolder()
getMapIsfolder()
getMapData()
setMapData()
getMapUrl()
setMapUrl()
getMapType()
setMapType()
getMapSize()
setMapSize()
getMapHash()
setMapHash()
getMapContenttype()
setMapContenttype()
$type
$_size
$_hash
$_contenttype
N/A
No private methods found
No private properties found
N/A

Constants

TYPE_BINARY

TYPE_BINARY ='BINARY'

TYPE_URL

TYPE_URL ='URL'

PATH_ROOT

PATH_ROOT ='.horde/kronolith/documents'

Properties

$id

$id :string

[TYPE_BINARY] Identifiant unique de la pièce jointe

Type

string

$modified

$modified :integer

[TYPE_BINARY] Timestamp de la modification de la pièce jointe

Type

integer

$isfolder

$isfolder :boolean

[TYPE_BINARY] Si l'objet est un dossier et non pas un fichier

Type

boolean

$name

$name :string

[TYPE_BINARY] Nom de la pièce jointe

Type

string

$path

$path :string

[TYPE_BINARY] Chemin vers la pièce jointe

Type

string

$owner

$owner :string

[TYPE_BINARY] Propriétaire de la pièce jointe

Type

string

$data

$data :string

Données encodées de la pièce jointe

Type

string

$url

$url :string

URL vers la pièce jointe

Type

string

$type

$type :\LibMelanie\Api\Melanie2\Attachment::TYPE_*

Type de la pièce jointe / Binaire ou URL (Binaire par défaut)

Type

\LibMelanie\Api\Melanie2\Attachment::TYPE_*

$hash

$hash :string

Lecture du HASH lié aux données de la pièce jointe (lecture seule)

Type

string

$size

$size :integer

Taille en octet de la pièce jointe binaire (lecture seule)

Type

integer

$contenttype

$contenttype :string

Content type de la pièce jointe (lecture seule)

Type

string

$id

$id :string

[TYPE_BINARY] Identifiant unique de la pièce jointe

Type

string

$modified

$modified :integer

[TYPE_BINARY] Timestamp de la modification de la pièce jointe

Type

integer

$isfolder

$isfolder :boolean

[TYPE_BINARY] Si l'objet est un dossier et non pas un fichier

Type

boolean

$name

$name :string

[TYPE_BINARY] Nom de la pièce jointe

Type

string

$path

$path :string

[TYPE_BINARY] Chemin vers la pièce jointe

Type

string

$owner

$owner :string

[TYPE_BINARY] Propriétaire de la pièce jointe

Type

string

$data

$data :string

Données encodées de la pièce jointe

Type

string

$url

$url :string

URL vers la pièce jointe

Type

string

$type

$type :\LibMelanie\Api\Mel\Attachment::TYPE_*

Type de la pièce jointe Binaire ou URL (Binaire par défaut)

Type de la pièce jointe / Binaire ou URL (Binaire par défaut)

Type

\LibMelanie\Api\Mel\Attachment::TYPE_*

$hash

$hash :string

Lecture du HASH lié aux données de la pièce jointe (lecture seule)

Type

string

$size

$size :integer

Taille en octet de la pièce jointe binaire (lecture seule)

Type

integer

$contenttype

$contenttype :string

Content type de la pièce jointe (lecture seule)

Type

string

$id

$id :string

[TYPE_BINARY] Identifiant unique de la pièce jointe

Type

string

$modified

$modified :integer

[TYPE_BINARY] Timestamp de la modification de la pièce jointe

Type

integer

$isfolder

$isfolder :boolean

[TYPE_BINARY] Si l'objet est un dossier et non pas un fichier

Type

boolean

$name

$name :string

[TYPE_BINARY] Nom de la pièce jointe

Type

string

$path

$path :string

[TYPE_BINARY] Chemin vers la pièce jointe

Type

string

$owner

$owner :string

[TYPE_BINARY] Propriétaire de la pièce jointe

Type

string

$data

$data :string

Données encodées de la pièce jointe

Type

string

$url

$url :string

URL vers la pièce jointe

Type

string

$type

$type :\LibMelanie\Api\Defaut\Attachment::TYPE_*

Type de la pièce jointe / Binaire ou URL (Binaire par défaut)

Type

\LibMelanie\Api\Defaut\Attachment::TYPE_*

$hash

$hash :string

Lecture du HASH lié aux données de la pièce jointe (lecture seule)

Type

string

$size

$size :integer

Taille en octet de la pièce jointe binaire (lecture seule)

Type

integer

$contenttype

$contenttype :string

Content type de la pièce jointe (lecture seule)

Type

string

$type

$type :\LibMelanie\Api\Defaut\Attachment::TYPE_*

Type de la pièce jointe Binaire ou URL (Binaire par défaut)

Type

\LibMelanie\Api\Defaut\Attachment::TYPE_*

$_size

$_size :integer

Taille de la pièce jointe

Type

integer

$_hash

$_hash :string

Hash des données

Type

string

$_contenttype

$_contenttype :string

ContentType de la pièce jointe

Type

string

Methods

__construct()

__construct()

Constructeur de l'objet

getDownloadURL()

getDownloadURL(): string

Méthode pour récupérer l'URL vers la pièce jointe Dans le cas d'une pièce jointe URL on récupère simplement l'URL Dans le cas d'une pièce jointe binaire, utilise l'url de téléchargement configuré

Returns

string

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 la pièce jointe, données comprises

Returns

boolean

exists()

exists(): boolean

Test si la pièce jointe existe

Returns

boolean

save()

save(): boolean

Sauvegarde la pièce jointe si elle est de type binaire

Returns

boolean

delete()

delete(): boolean

Supprime la pièce jointe binaire de la base

Returns

boolean

load()

load(): boolean

Chargement la pièce jointe, données comprises

Returns

boolean

exists()

exists(): boolean

Test si la pièce jointe existe

Returns

boolean

save()

save(): boolean

Sauvegarde la pièce jointe si elle est de type binaire

Returns

boolean

delete()

delete(): boolean

Supprime la pièce jointe binaire de la base

Returns

boolean

load()

load(): boolean

Chargement la pièce jointe, données comprises

Returns

boolean

exists()

exists(): boolean

Test si la pièce jointe existe

Returns

boolean

save()

save(): boolean

Sauvegarde la pièce jointe si elle est de type binaire

Returns

boolean

delete()

delete(): boolean

Supprime la pièce jointe binaire de la base

Returns

boolean

setMapPath()

setMapPath(string  $path)

Mapping path field

Parameters

string $path

setMapIsfolder()

setMapIsfolder(boolean  $isfolder)

Mapping isfolder field

Parameters

boolean $isfolder

getMapIsfolder()

getMapIsfolder()

Mapping isfolder field

getMapData()

getMapData()

Mapping data field

setMapData()

setMapData(string  $data): boolean

Mapping data field

Parameters

string $data

Throws

\LibMelanie\Api\Defaut\Exceptions\ObjectMelanieUndefinedException

Returns

boolean

getMapUrl()

getMapUrl()

Mapping url field

setMapUrl()

setMapUrl(string  $url): boolean

Mapping url field

Parameters

string $url

Throws

\LibMelanie\Api\Defaut\Exceptions\ObjectMelanieUndefinedException

Returns

boolean

getMapType()

getMapType(): \LibMelanie\Api\Defaut\Attachment::TYPE_*

Mapping type field

Throws

\LibMelanie\Api\Defaut\Exceptions\ObjectMelanieUndefinedException

Returns

\LibMelanie\Api\Defaut\Attachment::TYPE_*

setMapType()

setMapType(\LibMelanie\Api\Defaut\Attachment::TYPE_*  $type): boolean

Mapping type field

Parameters

\LibMelanie\Api\Defaut\Attachment::TYPE_* $type

Throws

\LibMelanie\Api\Defaut\Exceptions\ObjectMelanieUndefinedException

Returns

boolean

getMapSize()

getMapSize()

Mapping size field

setMapSize()

setMapSize(  $size)

Mapping size field

Parameters

$size

getMapHash()

getMapHash()

Mapping hash field

setMapHash()

setMapHash(  $hash)

Mapping hash field

Parameters

$hash

getMapContenttype()

getMapContenttype()

Mapping content type field

setMapContenttype()

setMapContenttype(  $contenttype)

Mapping content type field

Parameters

$contenttype