OviWiki - Contributions de l’utilisateur [fr]

API des tags

2009-02-22T15:35:44Z

Samzeb : /* Désassocier une référence */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Reference::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#bab_Reference::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

=Classe bab_ReferenceMgr=

Classe permettant la gestion d'association entre les tags et les références

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_ReferenceMgr::get($sTagName, bab_ReferenceFilters $oFilter = null)|get($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les références au tag.
|-
|public
|[[#bab_ReferenceMgr::getTagsByReference(bab_Reference $oReference)|getTagsByReference(bab_Reference $oReference)]]
|Retourne tous les tags vers la références.
|-
|public
|[[#bab_ReferenceMgr::add($sTagName, bab_Reference $oReference)|add($sTagName, bab_Reference $oReference)]]
|Associe un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::remove($sTagName, bab_Reference $oReference)|remove($sTagName, bab_Reference $oReference)]]
|Désassocie un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::removeByTag($sTagName)|removeByTag($sTagName)]]
|Supprime toutes les associations (référence) au tag.
|-
|public
|[[#bab_ReferenceMgr::removeByReference(bab_Reference $oReference)|removeByReference(bab_Reference $oReference)]]
|Supprime toutes les associations (référence) pour la référence.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)|getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les descriptions de références pour un tag en fonction du filtre.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptionsByReference(bab_Reference $oReference)|getReferencesDescriptionsByReference(bab_Reference $oReference)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::initIterator()|initIterator()]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpressionCriteria(bab_ReferenceFilters $oFilters)|getRegExpressionCriteria(bab_ReferenceFilters $oFilters)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpression(bab_ReferenceFilter $oFilter)|getRegExpression(bab_ReferenceFilter $oFilter)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::executeDeleteQuery($aWhereClauseItem)|executeDeleteQuery($aWhereClauseItem)]]
|.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$oIterator
|.
|}

API des tags

2009-02-22T15:35:28Z

Samzeb : /* Désassocier un tag à une référence */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Reference::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#bab_Reference::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

=Classe bab_ReferenceMgr=

Classe permettant la gestion d'association entre les tags et les références

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_ReferenceMgr::get($sTagName, bab_ReferenceFilters $oFilter = null)|get($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les références au tag.
|-
|public
|[[#bab_ReferenceMgr::getTagsByReference(bab_Reference $oReference)|getTagsByReference(bab_Reference $oReference)]]
|Retourne tous les tags vers la références.
|-
|public
|[[#bab_ReferenceMgr::add($sTagName, bab_Reference $oReference)|add($sTagName, bab_Reference $oReference)]]
|Associe un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::remove($sTagName, bab_Reference $oReference)|remove($sTagName, bab_Reference $oReference)]]
|Désassocie un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::removeByTag($sTagName)|removeByTag($sTagName)]]
|Supprime toutes les associations (référence) au tag.
|-
|public
|[[#bab_ReferenceMgr::removeByReference(bab_Reference $oReference)|removeByReference(bab_Reference $oReference)]]
|Supprime toutes les associations (référence) pour la référence.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)|getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les descriptions de références pour un tag en fonction du filtre.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptionsByReference(bab_Reference $oReference)|getReferencesDescriptionsByReference(bab_Reference $oReference)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::initIterator()|initIterator()]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpressionCriteria(bab_ReferenceFilters $oFilters)|getRegExpressionCriteria(bab_ReferenceFilters $oFilters)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpression(bab_ReferenceFilter $oFilter)|getRegExpression(bab_ReferenceFilter $oFilter)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::executeDeleteQuery($aWhereClauseItem)|executeDeleteQuery($aWhereClauseItem)]]
|.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$oIterator
|.
|}

API des tags

2009-02-22T15:34:15Z

Samzeb : /* Associer un tag à une référence */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/12';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Reference::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#bab_Reference::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

=Classe bab_ReferenceMgr=

Classe permettant la gestion d'association entre les tags et les références

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_ReferenceMgr::get($sTagName, bab_ReferenceFilters $oFilter = null)|get($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les références au tag.
|-
|public
|[[#bab_ReferenceMgr::getTagsByReference(bab_Reference $oReference)|getTagsByReference(bab_Reference $oReference)]]
|Retourne tous les tags vers la références.
|-
|public
|[[#bab_ReferenceMgr::add($sTagName, bab_Reference $oReference)|add($sTagName, bab_Reference $oReference)]]
|Associe un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::remove($sTagName, bab_Reference $oReference)|remove($sTagName, bab_Reference $oReference)]]
|Désassocie un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::removeByTag($sTagName)|removeByTag($sTagName)]]
|Supprime toutes les associations (référence) au tag.
|-
|public
|[[#bab_ReferenceMgr::removeByReference(bab_Reference $oReference)|removeByReference(bab_Reference $oReference)]]
|Supprime toutes les associations (référence) pour la référence.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)|getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les descriptions de références pour un tag en fonction du filtre.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptionsByReference(bab_Reference $oReference)|getReferencesDescriptionsByReference(bab_Reference $oReference)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::initIterator()|initIterator()]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpressionCriteria(bab_ReferenceFilters $oFilters)|getRegExpressionCriteria(bab_ReferenceFilters $oFilters)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpression(bab_ReferenceFilter $oFilter)|getRegExpression(bab_ReferenceFilter $oFilter)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::executeDeleteQuery($aWhereClauseItem)|executeDeleteQuery($aWhereClauseItem)]]
|.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$oIterator
|.
|}

API des tags

2009-02-22T15:06:09Z

Samzeb : /* Méthodes */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Reference::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#bab_Reference::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

=Classe bab_ReferenceMgr=

Classe permettant la gestion d'association entre les tags et les références

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_ReferenceMgr::get($sTagName, bab_ReferenceFilters $oFilter = null)|get($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les références au tag.
|-
|public
|[[#bab_ReferenceMgr::getTagsByReference(bab_Reference $oReference)|getTagsByReference(bab_Reference $oReference)]]
|Retourne tous les tags vers la références.
|-
|public
|[[#bab_ReferenceMgr::add($sTagName, bab_Reference $oReference)|add($sTagName, bab_Reference $oReference)]]
|Associe un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::remove($sTagName, bab_Reference $oReference)|remove($sTagName, bab_Reference $oReference)]]
|Désassocie un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::removeByTag($sTagName)|removeByTag($sTagName)]]
|Supprime toutes les associations (référence) au tag.
|-
|public
|[[#bab_ReferenceMgr::removeByReference(bab_Reference $oReference)|removeByReference(bab_Reference $oReference)]]
|Supprime toutes les associations (référence) pour la référence.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)|getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les descriptions de références pour un tag en fonction du filtre.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptionsByReference(bab_Reference $oReference)|getReferencesDescriptionsByReference(bab_Reference $oReference)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::initIterator()|initIterator()]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpressionCriteria(bab_ReferenceFilters $oFilters)|getRegExpressionCriteria(bab_ReferenceFilters $oFilters)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpression(bab_ReferenceFilter $oFilter)|getRegExpression(bab_ReferenceFilter $oFilter)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::executeDeleteQuery($aWhereClauseItem)|executeDeleteQuery($aWhereClauseItem)]]
|.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$oIterator
|.
|}

API des tags

2009-02-22T15:02:44Z

Samzeb : /* Classe bab_Reference */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Reference::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#bab_Reference::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

=Classe bab_ReferenceMgr=

Classe permettant la gestion d'association entre les tags et les références

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_ReferenceMgr::get($sTagName, bab_ReferenceFilters $oFilter = null)|get($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les références au tag.
|-
|public
|[[#bab_ReferenceMgr::getTagsByReference(bab_Reference $oReference)|getTagsByReference(bab_Reference $oReference)]]
|Retourne tous les tags vers la références.
|-
|public
|[[#bab_ReferenceMgr::add($sTagName, bab_Reference $oReference)|add($sTagName, bab_Reference $oReference)]]
|Associe un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::remove($sTagName, bab_Reference $oReference)|remove($sTagName, bab_Reference $oReference)]]
|Désassocie un tag à une référence.
|-
|public
|[[#bab_ReferenceMgr::removeByTag($sTagName)|removeByTag($sTagName)]]
|Supprime toutes les associations (référence) au tag.
|-
|public
|[[#bab_ReferenceMgr::removeByReference(bab_Reference $oReference)|removeByReference(bab_Reference $oReference)]]
|Supprime toutes les associations (référence) pour la référence.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)|getReferencesDescriptions($sTagName, bab_ReferenceFilters $oFilter = null)]]
|Retourne toutes les descriptions de références pour un tag en fonction du filtre.
|-
|public
|[[#bab_ReferenceMgr::getReferencesDescriptionsByReference(bab_Reference $oReference)|getReferencesDescriptionsByReference(bab_Reference $oReference)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::initIterator()|initIterator()]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpressionCriteria(bab_ReferenceFilters $oFilters)|getRegExpressionCriteria(bab_ReferenceFilters $oFilters)]]
|.
|-
|privé
|[[#bab_ReferenceMgr::getRegExpression(bab_ReferenceFilter $oFilter)|getRegExpression(bab_ReferenceFilter $oFilter)]]
|Retourne toutes les descriptions de références vers une référence.
|-
|privé
|[[#bab_ReferenceMgr::executeDeleteQuery($aWhereClauseItem)|executeDeleteQuery($aWhereClauseItem)]]
|.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$oIterator
|.
|}

API des tags

2009-02-22T14:48:23Z

Samzeb :

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

=Classe bab_Reference=

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct($sReference)
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#getLocation()::getGuid()|getGuid()]]
|Retourne l'identifiant de l'objet.
|-
|public
|[[#bab_Reference::getProtocol()|getProtocol()]]
|Retourne le protocol.
|-
|public
|[[#getLocation()::getLocation()|getLocation()]]
|Retourne l'emplacement.
|-
|public
|[[#bab_Reference::getModule()|getModule()]]
|Retourne le nom du module.
|-
|public
|[[#bab_Reference::getType()|getType()]]
|Retourne le type d'object.
|-
|public
|[[#bab_Reference::getObjectId()|getObjectId()]]
|Récupére l'identifiant de l'objet.
|-
|public static
|[[#bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)|makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject)]]
|Retourne une instance initialisé de l'object bab_Reference.
|-
|privé
|[[#bab_Reference::init($sReference)|init($sReference)]]
|Initialise la référence.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$sProtocol
|Le protocole.
|-
|privé
|$sLocation
|L'emplacement.
|-
|privé
|$sModule
|Le module.
|-
|privé
|$sType
|Le type de l'objet.
|-
|privé
|$iIdObject
|L'identifiant de l'objet.
|-
|privé
|$iGuid
|L'identifiant de l'instance.
|}

API des tags

2009-02-22T14:29:27Z

Samzeb : /* Récupération d'une descrition de référence à une référence */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une description de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:29:01Z

Samzeb : /* Récupération de toutes les descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération d'une descrition de référence à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oReference = new bab_Reference('ovidentia:///articles/draft/52');
$oRefMgr = new bab_ReferenceMgr();

$oReferenceDescription = $oRefMgr->getReferenceDescription($oReference);
if($oReferenceDescription instanceof IReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:23:16Z

Samzeb : /* Récupération de toutes les descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->getReferencesDescriptions($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:22:19Z

Samzeb : /* Récupération de toutes les références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:21:49Z

Samzeb : /* Récupération des descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération de toutes les références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReference)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sReference: ' . (string) $oReference . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:18:32Z

Samzeb : /* Récupération de toutes les descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:17:49Z

Samzeb : /* Récupération de tous les tags associés à une référence */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

==Récupération de toutes les descriptions de références à un tag==

require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->getReferencesDescriptions($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:12:54Z

Samzeb : /* Récupération des descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les descriptions de références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les descriptions de références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:08:22Z

Samzeb : /* Tester l'existance d'un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l\'identifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:07:52Z

Samzeb : /* Tester l'existance d'un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $sName . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $sName . ' dont l'iidentifiant est: ' . $iId . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:06:49Z

Samzeb : /* Mise à jour d'un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $iId . ' à été renommé avec succès, son nouveau nom est: ' . $sNewName . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' existe, son identifiant est: ' . $oTag->getId() . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' dont l'iidentifiant est: ' . $oTag->getId() . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T14:03:12Z

Samzeb : /* Récupération des descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $oTag->getId() . ' à été renommé avec succès, son nouveau nom est: ' . $oTag->getName() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' existe, son identifiant est: ' . $oTag->getId() . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' dont l'iidentifiant est: ' . $oTag->getId() . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a: ' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}
</source>

==Récupération de tous les tags associés à une référence==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$oReference = new bab_Reference('ovidentia:///files/file/22');
$oIterator = $oRefMgr->getTagsByReference($oReference);

echo 'Il y a: ' . $oIterator->count() . ' tag(s) associé(s) à la référence: ' . (string)$oReference . ' ';

foreach($oIterator as $oTag)
{
echo 'sTagName ' . $oTag->getName() . ' iIdTag ' . $oTag->getId() . ' sReference ' . (string)$oReference . ' ';
}
</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T13:53:45Z

Samzeb : /* Récupération des descriptions de références à un tag */

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $oTag->getId() . ' à été renommé avec succès, son nouveau nom est: ' . $oTag->getName() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' existe, son identifiant est: ' . $oTag->getId() . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' dont l'iidentifiant est: ' . $oTag->getId() . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a:' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles brouillons et les fichiers
{
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach(new bab_ReferenceFilter('', 'articles', 'draft'));
$oReferenceFilters->attach(new bab_ReferenceFilter('', 'files', 'file'));

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a:' . $oIterator->count() . ' références(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T13:50:38Z

Samzeb : ator

=Introduction=

L'API des tags est constituée de classes et d'interfaces permettant :
#La gestion des tags (création, modification, suppression, récupération)
#La gestion d'association de tags à des objets (articles, fichiers, ...)

=Gestion des tags=

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Création d'un tag==

La création un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->create($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été créé avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupération de tag(s)==

La récupération de tag peut être effectuée :
#Par son nom
#Par son identifiant
#Par un tableau d'identifiant

===Récupération d'un tag par son nom===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'Image';
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getByName($sTagName);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération d'un tag par son identifiant===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$oTag = $oTagMgr->getById($iId);
if($oTag instanceof bab_Tag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Récupération de tags par identifiants===

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$aIds = array(28, 52, 70);
$oTagMgr = new bab_TagMgr();

$oIterator = $oTagMgr->getByIds($aId);

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

===Mise à jour d'un tag===

La mise à jour d'un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28; //Identifiant du tag à mettre à jour
$sNewName = 'Images'; //Nouveau nom du tag
$oTagMgr = new bab_TagMgr();

if($oTagMgr->update($iId, $sNewName))
{
echo 'Le tag dont l'identifiant est: ' . $oTag->getId() . ' à été renommé avec succès, son nouveau nom est: ' . $oTag->getName() . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Suppression d'un tag==

La suppression un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$iId = 28;
$oTagMgr = new bab_TagMgr();

$bSuccess = $oTagMgr->delete($iId);
if(true === $bSuccess)
{
echo 'Le tag: ' . $iId . ' à été supprimé avec succès . ' ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Tester l'existance d'un tag==

Le test de l'existance d'un tag s'effectue :
#Avec le nom du tag
#Avec le nom du tag et son identifiant

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Est ce qu'un tag nommé xxx exite ?
$sName = 'Images';
if($oTagMgr->exist($sName))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' existe, son identifiant est: ' . $oTag->getId() . ' ';
}

//Est ce qu'un tag nommé xxx dont l'identifiant est yyy exite ?
$iId = 28;
if($oTagMgr->exist($sName, $iId))
{
echo 'Le tag nommé: ' . $oTag->getName() . ' dont l'iidentifiant est: ' . $oTag->getId() . ' existe ';
}
</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

==Récupérer tous les tags==

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oTagMgr = new bab_TagMgr();

//Récupère tous les tags ordonnés par les noms de manière ascendante
{
$oTagIterator = $oTagMgr->select()->orderAsc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

//Récupère tous les tags qui contiennent la chaine 'foo' ordonnés par les noms de manière descendante
{
$oTagIterator = $oTagMgr->select()->orderDesc('tag_name');

$oName = new BAB_Field('tag_name');
$oTagIterator->setCriteria($oName->like('foo'));

echo 'Nombre de tag récupéré: ' . $oIterator->Count() . ' ';

foreach($oIterator as $oTag)
{
echo 'Le tag: ' . $oTag->getName() . ' à été récupéré avec succès, son identifiant est: ' . $oTag->getId() . ' ';
}
}

</source>

La description de la classe bab_Tag se trouve [[#Classe bab_Tag|ici]]

=Gestion d'association de tags à des objets=

Les tags sont associés à des références, Ovidentia gère trois types de références:
#Les références vers les fichiers
#Les références vers les articles
#Les références vers les brouillons d'articles

Ci dessous la constitution d'une référence

{| class="prettytable"
|style="background:#E5E5E5"| '''Libellé''' ||style="background:#E5E5E5"| '''Description'''
|-
|protocole
|ovidentia://
|-
|emplacement
|local/ ou /
|-
|module
|nom de l'addon d'ovidentia ou de la fonctionnalité du noyau
|-
|type d'objet
|chaine de caractère
|-
|identifiant
|identifiant de l'objet (pour un type donné). Nombre entier ou chaine de caractère
|}

Ci dessous un exemple de références pour chaque type d'objet qu'OVIDENTIA gère

ovidentia:///files/file/2 (2 étant l'identifiant du fichier)

ovidentia:///articles/article/12 (12 étant l'identifiant de l'article)

ovidentia:///articles/draft/52 (52 étant l'identifiant du brouillon de l'article)

==Inclusion==

Tout d'abord il faut inclure le fichier
<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';
</source>

==Associer un tag à une référence==

L'association d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->add($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été ajoutée avec succès ';
}

//Référence vers l'article 2
$sProtocol = 'ovidentia';
$sLocation = ''; //valeur par défaut
$sModule = 'articles';
$sType = 'article';
$iIdObject = 2;
$oArticleReference = bab_Reference::makeReference($sProtocol, $sLocation, $sModule, $sType, $iIdObject);
if($oRefMgr->add($sTagName, $oArticleReference))
{
echo 'La référence: ' . (string) $oArticleReference . ' à été ajoutée avec succès ';
}

//Référence vers le brouillon de l'article 52
$sDraftArtReference = 'ovidentia:///articles/draft/52';
$oDraftArtReference = new bab_Reference($sDraftArtReference);
if($oRefMgr->add($sTagName, $oDraftArtReference))
{
echo 'La référence: ' . (string) $oDraftArtReference . ' à été ajoutée avec succès ';
}
</source>

==Désassocier un tag à une référence==

La désassociation d'un tag à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);
if($oRefMgr->remove($sTagName, $oFileReference))
{
echo 'La référence: ' . (string) $oFileReference . ' à été supprimée avec succès ';
}
</source>

==Désassocier toutes références à un tag==

La désassociation de toutes les référence à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();
$sTagName = 'Image';

if($oRefMgr->removeByTag($sTagName))
{
echo 'Toutes les références au tag: ' . $sTagName . ' ont été supprimées avec succès ';
}
</source>

==Désassocier une référence ==

La désassociation de tag(s) à une référence s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$oRefMgr = new bab_ReferenceMgr();

//Référence vers le fichier 12
$sFileReference = 'ovidentia:///files/file/2';
$oFileReference = new bab_Reference($sFileReference);

if($oRefMgr->removeByReference($oFileReference))
{
echo 'Toutes les références: ' . (string) $oFileReference . ' ont été supprimées avec succès ';
}
</source>

==Récupération des descriptions de références à un tag==

La récupération de descriptions de références à un tag s'effectue de la manière suivante:

<source lang="php">
require_once $babInstallPath . 'utilit/tagApi.php';

$sTagName = 'images'
$oRefMgr = new bab_ReferenceMgr();

//Récupération de toutes les références au tag 'image' sans filtre
{
$oIterator = $oRefMgr->get($sTagName);

echo 'Il y a:' . $oIterator->count() . ' références associées au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

//Récupération de toutes les références au tag 'image' sur les articles
{
$sLocation = ''; //Locale
$sModule = 'articles'; //Filtre sur les articles
$sType = ''; //Aucun filtre sur le type, on aurait pu mettre (article ou draft)

$oReferenceFilter = new bab_ReferenceFilter($sLocation, $sModule, $sType);
$oReferenceFilters = new bab_ReferenceFilters();

$oReferenceFilters->attach($oReferenceFilter);

$oIterator = $oRefMgr->get($sTagName, $oReferenceFilters);

echo 'Il y a:' . $oIterator->count() . ' fichier(s) associé(s) au tag: ' . $sTagName . ' ';
foreach($oIterator as $oReferenceDescription)
{
echo 'sTitle: ' . $oReferenceDescription->getTitle() . ' sDescription: ' . $oReferenceDescription->getDescription() . ' sUrl: ' . $oReferenceDescription->getUrl() . ' ';
}
}

</source>

=Classe bab_Tag=

La classe bab_Tag représente un tag. Un tag c'est un nom et un identifiant.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_Tag::getId()|getId()]]
|Retourne un entier dont la valeur est l'identifiant du tag.
|-
|public
|[[#bab_Tag::setId($iId)|setId($iId)]]
|Définit l'identifiant du tag.
|-
|public
|[[#bab_Tag::getName()|getName()]]
|Retourne une chaine de caractère dont la valeur est le nom du tag.
|-
|public
|[[#bab_Tag::setName($sName)|setName($sName)]]
|Définit le nom du tag.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$iId
|Identifiant du tag.
|-
|privé
|$sName
|Nom du tag.
|}

==bab_Tag::getId()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne l'identifiant du tag

===Description===
<source lang="php">
int bab_Tag::getId()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne l'identifiant du tag

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::setId($iId)==

(Ovidentia 7 >= 7.1.0)

Définie $iId comme identifiant du tag

===Description===
<source lang="php">
void bab_Tag::setId(int $iId)
</source>
Définie $iId comme identifiant du tag

===Liste de paramètres===

$iId
L'identifiant du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

==bab_Tag::getName()==

(Ovidentia 7 >= 7.1.0)

Cette méthode retourne le nom du tag

===Description===
<source lang="php">
string bab_Tag::getName()
</source>
===Liste de paramètres===

Cette fonction ne prend aucun paramètre

===Valeurs de retour===

Retourne le nom du tag

[[#Méthodes|retournez à la section méthode]]

==bab_Tag::setName($sName)==

(Ovidentia 7 >= 7.1.0)

Définie $sName comme nom

===Description===
<source lang="php">
void bab_Tag::setName(string $sName)
</source>
===Liste de paramètres===

$sName
Le nom du tag

===Valeurs de retour===

Aucune valeur n'est retournée.

[[#bab_Tag_Methode|retournez à la section méthode]]

=Classe bab_TagMgr=

La classe bab_TagMgr permet de gérer des tags.

==Constructeur==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|__construct()
|Construit un objet.
|}

==Méthodes==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|public
|[[#bab_TagMgr::create($sName)|create($sName)]]
|Crée un tag.
|-
|public
|[[#bab_TagMgr::update($iId, $sName)|update($iId, $sName)]]
|Met à jour le nom du tag.
|-
|public
|[[#bab_TagMgr::delete($iId)|delete($iId)]]
|Supprime un tag.
|-
|public
|[[#bab_TagMgr::getByName($sName)|getByName($sName)]]
|Récupére un tag par son nom.
|-
|public
|[[#bab_TagMgr::getById($iId)|getById($iId)]]
|Récupére un tag par son identifiant.
|-
|public
|[[#bab_TagMgr::getByIds($aId)|getByIds($aId)]]
|Récupére une liste de tags(itérateur) par un tableau d'identifiant.
|-
|public
|[[#bab_TagMgr::select()|select()]]
|Récupére la liste de tous les tags(itérateur).
|-
|public
|[[#bab_TagMgr::exist($sName, $iId = 0)|exist($sName, $iId = 0)]]
|Test l'existance d'un tag.
|-
|privé
|[[#bab_TagMgr::haveManagerRight()|haveManagerRight()]]
|Rétourne un valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|[[#bab_TagMgr::get($mixedValue)|get($mixedValue)]]
|Récupére un tag (bab_Tag) par son nom ou son identifiant.
|-
|privé
|[[#bab_TagMgr::initIterator()|initIterator()]]
|Retourne un bab_TagIterator.
|}

==Propriétés==

{| class="prettytable"
|style="background:#E5E5E5"| '''Accès''' ||style="background:#E5E5E5"| '''Nom''' ||style="background:#E5E5E5"| '''Description'''
|-
|privé
|$bManageThesaurus
|Valeur indiquant si l'utilisateur peut créer, modifier, supprimer des tags.
|-
|privé
|$oIterator
|Liste de bab_Tag.
|}

==bab_TagMgr::create($sName)==

(Ovidentia 7 >= 7.1.0)

Crée un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::create(string $sName)
</source>
Crée un tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$sName
Nom du tag à créer

===Valeurs de retour===

Un object bab_Tag est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::update($iId, $sName)==

(Ovidentia 7 >= 7.1.0)

Met à jour le nom du tag.

===Description===
<source lang="php">
bool bab_TagMgr::update(int $iId, string $sName)
</source>
Met à jour le nom du tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à mettre à jour
$sName
Nouveau nom du tag

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::delete($iId)==

(Ovidentia 7 >= 7.1.0)

Suppression d'un tag.

===Description===
<source lang="php">
bool bab_TagMgr::delete(int $iId)
</source>
Supprime un tag ainsi que toutes les associations (références) au tag.
Pour supprimer un tag il faut avoir le droit gérer.

===Liste de paramètres===

$iId
Identifiant du tag à supprimer

===Valeurs de retour===

True est retourné en cas de succès, sinon false est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByName($sName)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getByName(string $sName)
</source>
Récupére d'un tag.

===Liste de paramètres===

$sName
Nom du tag à supprimer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon nullest retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getById($iId)==

(Ovidentia 7 >= 7.1.0)

Récupére d'un tag.

===Description===
<source lang="php">
bab_Tag bab_TagMgr::getById(int $iId)
</source>
Récupére d'un tag.

===Liste de paramètres===

$iId
Identifiant du tag à récupérer

===Valeurs de retour===

Un objet bab_Tag est retourné en cas de succès, sinon null est retourné en cas d'erreur.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::getByIds($aId)==

(Ovidentia 7 >= 7.1.0)

Récupére une liste de tags.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::getByIds(array $aId)
</source>
Récupére une liste de tags.

===Liste de paramètres===

$aId
Tableau d'identiant de tag

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::select()==

(Ovidentia 7 >= 7.1.0)

Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.

===Description===
<source lang="php">
bab_TagIterator bab_TagMgr::select()
</source>
Selectionne tous les tags, retourne un itérateur sur lequel il est possible d'appliquer des opérations afin de filtrer le résultat.
Un exemple se trouve [[#ex_bab_TagMgr_select|ici]]

===Liste de paramètres===

Cette méthode ne prend aucun paramètre

===Valeurs de retour===

Un objet bab_TagIterator.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

==bab_TagMgr::exist($sName, $iId = 0)==

(Ovidentia 7 >= 7.1.0)

Retourne une valeur indiquant si un tag existe ou pas.

===Description===
<source lang="php">
bool bab_TagMgr::exist(string $sName [, int $iId = 0])
</source>
Retourne une valeur indiquant si un tag existe ou pas.

===Liste de paramètres===

$sName
Nom du tag pour lequel l'existance est à tester

$iId
Paramètre optionnel. Identifiant du tag pour lequel l'existance est à tester

===Valeurs de retour===

True si le tag existe, false si il n'existe pas.

[[#bab_TagMgr_Methodes|retournez à la section méthode]]

API des tags

2009-02-22T13:31:21Z

Samzeb :

API des tags

2009-02-22T13:29:26Z

Samzeb : /* Gestion d'association de tags à des objets */

API des tags

2009-02-22T13:21:41Z

Samzeb : /* Gestion d'association de tags à des objets */

API des tags

2009-02-22T13:15:22Z

Samzeb : /* Associer un tag à une référence */

API des tags

2009-02-22T13:14:33Z

Samzeb : /* Associer un tag à une référence */

API des tags

2009-02-22T13:14:07Z

Samzeb : /* Désassocier une référence */

API des tags

2009-02-22T13:13:07Z

Samzeb : /* Désassocier un tag à une référence */

API des tags

2009-02-22T13:07:22Z

Samzeb : /* Classe bab_Tag */

API des tags

2009-02-22T11:54:15Z

Samzeb : /* Associer un tag à une référence */

API des tags

2009-02-22T11:51:52Z

Samzeb :

API des tags

2009-02-22T11:36:14Z

Samzeb : /* Gestion d'association de tags à des objets */

API des tags

2009-02-22T11:15:43Z

Samzeb : /* Gestion d'association de tags à des objets */

API des tags

2009-02-22T11:15:01Z

Samzeb :

API des tags

2009-02-22T11:07:51Z

Samzeb : /* bab_TagMgr::exist($sName [, $iId = 0]) */

API des tags

2009-02-22T11:07:31Z

Samzeb : /* Description */

API des tags

2009-02-22T11:06:49Z

Samzeb :

API des tags

2009-02-22T11:01:25Z

Samzeb : /* Description */

API des tags

2009-02-22T11:00:10Z

Samzeb : /* Récupérer tous les tags */

API des tags

2009-02-22T10:58:21Z

Samzeb :

API des tags

2009-02-21T17:24:00Z

Samzeb : /* Méthodes */

API des tags

2009-02-21T17:20:11Z

Samzeb : /* Description */

API des tags

2009-02-21T17:19:04Z

Samzeb :

API des tags

2009-02-21T17:12:37Z

Samzeb :

API des tags

2009-02-21T12:47:45Z

Samzeb :

API des tags

2009-02-21T12:46:53Z

Samzeb :

API des tags

2009-02-21T12:45:38Z

Samzeb :

API des tags

2009-02-21T12:44:51Z

Samzeb : /* bab_Tag::create($sName) */

API des tags

2009-02-21T12:44:38Z

Samzeb : /* bab_Tag::update($iId, $sName) */

API des tags

2009-02-21T12:44:23Z

Samzeb : /* bab_Tag::delete($iId) */

API des tags

2009-02-21T12:44:07Z

Samzeb : /* bab_Tag::getByName($sName) */