Manuel de référence

# Classe SmartElementManager

La classe SmartElementManager permet de créer et récupérer des Smart Elements. Elle hérite également de la classe SEManager qui, contrairement à SmartElementManager, n'effectue aucun contrôle sur les Smart Elements. Voir Smart Element contrôlé et non-contrôlé pour plus d'information

# Liste des méthodes

# getDocument

SmartElement getDocument(string|int $documentIdentifier,
                         bool $latest = true,
                         bool $useCache = true)

Cette méthode permet de récupérer un objet SmartElement

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Par défaut, latest est égal à true. dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

useCache (bool)

Permet d'activer/désactiver l'utilisation du cache. Par défaut, l'utilisation du cache est activée (useCache = true).

# Valeur de retour

  • Si le Smart Element demandé n'existe pas ou n'est pas trouvé, alors la méthode retourne la valeur null.
  • Si le Smart Element est trouvé et latest est égal à true, la dernière révision de l'objet SmartElement correspondant est alors retournée.
  • Si le Smart Element est trouvé et latest est égal à false, seul un identifiant numérique peut être renseigné, et la méthode renvoie l'objet SmartElement correspondant.
  • Si le Smart Element est trouvé et useCache est égal à true, la méthode renvoie l'objet SmartElement correspondant du cache, s'il existe; sinon, elle renvoie celui de la base de donnée.

# Erreurs / Exceptions

Dans le cas où il y'a une erreur d'accès à la base de données, une exception Anakeen\Core\DocManager\Exception est levée.

# Exemple

  • Récupérer le Smart Element de la Smart Structure IUSER:
use Anakeen\SmartElementManager;

$user = SmartElementManager::getDocument("IUSER");

$result["user"][] = [
  "id" => $user->name,
  "text" => $user->getTitle(),
  "imageUrl" => $user->getIcon("", 15),
  "canCreate" => !$user->control("icreate")
];
var_export($result);
  • Résultat:
array(
  'user' => array(
    0 => array(
      'id' => 'IUSER',
      'text' => 'Utilisateur',
      'imageUrl' => '/api/v2/images/assets/sizes/15x15c/se-iuser.png',
      'canCreate' => true
    )
  )
);

# getRawDocument

string[] getRawDocument(string|int $documentIdentifier,
                            bool $latest = true)

Cette méthode permet de récupérer les informations du Smart Element directement depuis la base de données.

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

latest (bool)

permet de récupérer la dernière révision du Smart Element. par défaut, latest est égal à true. dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

# Valeur de retour

  • Si le Smart Element demandé n'existe pas ou n'est pas trouvé, alors la méthode retourne un tableau vide.
  • Si le Smart Element est trouvé et latest est égal à true, les informations de la dernière révision de l'objet SmartElement correspondant sont alors retournées dans un tableau.
  • Si le Smart Element est trouvé et latest est égal à false, seul un identifiant numérique peut être renseigné, et la méthode renvoie les informations du SmartElement correspondant dans un tableau.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer les informations du Smart Element de la Smart Structure IUSER:
use Anakeen\SmartElementManager;

$user = SmartElementManager::getRawDocument("IUSER");
var_export($user);
  • Résultat:
array(
  'id' => '128',
  'owner' => '1',
  'title' => 'Utilisateur',
  'revision' => '0',
  'initid' => '128',
  'fromid' => '0',
  'doctype' => 'C',
  'locked' => '0',
  'allocated' => null,
  'icon' => 'se-iuser.png',
  'lmodify' => 'Y',
  'profid' => '2300',
  'usefor' => 'N',
  'mdate' => '2019-06-1111: 00: 41.015937',
  'version' => null,
  'cdate' => '2019-02-2715: 17: 43.251415',
  'comment' => null,
  'classname' => 'Anakeen\\SmartStructures\\Iuser\\IUserHooks',
  'state' => null,
  'wid' => null,
  'fieldvalues' => '{
          "ccvid": 1019,
          "schar": "S",
          "cfldid": 0,
          "dfldid": 0,
          "maxrev": 0,
          "cprofid": 1947,
          "methods": "",
          "tagable": ""
    }',
  'postitid' => null,
  'fallid' => null,
  'cvid' => null,
  'name' => 'IUSER',
  'dprofid' => '0',
  'views' => '{
          2
    }',
  'prelid' => null,
  'atags' => '{
          "vendor": "Anakeen"
    }',
  'confidential' => null,
  'ldapdn' => null,
  'cprofid' => '1947',
  'dfldid' => null,
  'cfldid' => null,
  'ccvid' => '1019',
  'cfallid' => '1946',
  'ddocid' => null,
  'methods' => null,
  'defaultvalues' => '{
          "us_status": "A",
          "us_loginfailure": "0"
    }',
  'schar' => 'S',
  'param' => '{
          "us_defaultgroup": "GDEFAULT"
    }',
  'genversion' => null,
  'maxrev' => null,
  'usedocread' => null,
  'tagable' => null,
  'configuration' => null
);

# createDocument

SmartElement createDocument(string|int $structureIdentifier,
                            bool $useDefaultValues = true)

Cette méthode permet de créer un objet SmartElement d'une Smart Structure.

Avertissements

Le Smart Element n'est pas encore enregistré dans la base de données et ne possède pas encore d'identifiant.

# Liste des paramètres

structureIdentifier (string|int)

Identifiant (numérique ou nom logique) de la Smart Structure.

useDefaultValues (bool)

Créer un objet SmartElement d'une Smart Structure avec les valeurs par défaut des paramètres. Par défaut, useDefaultValues est égal à true.

# Valeur de retour

Cette méthode retourne un objet SmartElement, initialisé avec les valeurs par défaut si useDefaultValues est valué à true.

# Erreurs / Exceptions

Si une erreur se produit lors de l'initialisation du Smart Element, une exception Anakeen\Exception est levée.

# Exemple

  • Créer un utilisateur TestName:
use Anakeen\SmartElementManager;

$d = SmartElementManager::createDocument("IUSER");
$d->setAttributeValue(User::us_lname, "TestName");
$d->setAttributeValue(User::us_login, "TestLogin");
$d->store();
$el = SmartElementManager::getDocumentProperties($d->id, []);
var_export($el);
  • Résultat:
array(
       "id": "2316",
       "owner": "1",
       "icon": "se-iuser.png",
       "title": "TestName",
       "revision": "0",
       "version": null,
       "initid": "2316",
       "fromid": "128",
       "doctype": "F",
       "locked": "0",
       "allocated": null,
       "lmodify": "Y",
       "profid": "2316",
       "usefor": "N",
       "cdate": "2019-06-27 11:27:56.778043",
       "mdate": "2019-06-27 11:27:57.112038",
       "comment": null,
       "classname": null,
       "state": null,
       "wid": null,
       "postitid": null,
       "cvid": "1019",
       "name": null,
       "dprofid": "1947",
       "atags": null,
       "prelid": null,
       "confidential": null,
       "ldapdn": null
)

# getFamily

SmartStructure getFamily(string|int $familyIdentifier,
                         bool $useCache = true)

Cette méthode permet de récupérer un object SmartStructure via son identifiant.

# Liste des paramètres

familyIdentifier (string|int)

Identifiant (numérique ou nom logique) de la Smart Structure.

useCache (bool)

Permet d'activer/désactiver l'utilisation du cache. Par défaut, l'utilisation du cache est activée (useCache = true).

# Valeur de retour

  • Si la Smart Structure demandée n'existe pas ou n'est pas trouvée, alors la méthode retourne null.
  • Si la Smart Structure est trouvée et useCache est égal à true, la méthode renvoie l'objet SmartStructure correspondant du cache, s'il existe; sinon, elle renvoie la Smart Structure de la base de données.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer l'identifiant de la Smart Structure `IUSER":
use Anakeen\SmartElementManager;

$f = SmartElementManager::getFamily("IUSER");
print("identifiant de la Smart Structure = %s", $f->id);
  • Résultat
identifiant de la Smart Structure = 128

# getInitIdFromIdOrName

int|null getInitIdFromIdOrName(string|int $name)

Cette méthode permet de récupérer l'identifiant initial d'un Smart Element à partir du nom logique.

# Liste des paramètres

name (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

# Valeur de retour

Si un Smart Element est trouvé, alors la méthode retourne son identifiant initial; sinon, la méthode retourne null.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer l'identifiant initial de TST_DDUI_USER1:
use Anakeen\SmartElementManager;

$initId = SmartElementManager::getInitIdFromIdOrName("TST_DDUI_USER1");
print("identifiant initial de TEST_DDUI_USER1 = %d", $initId);
  • Résultat:
identifiant initial de TEST_DDUI_USER1 = 1986

# getInitIdFromName

int|null getInitIdFromName(string $name)

Cette méthode permet de récupérer l'identifiant initial d'un Smart Element à partir du nom logique.

# Liste des paramètres

name (string)

Nom logique du Smart Element.

# Valeur de retour

  • Si un Smart Element est trouvé, alors la méthode retourne son identifiant initial; sinon, la méthode retourne null.
  • Si le paramètre name est de type int, alors la méthode retourne null.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer l'identifiant initial de TST_DDUI_USER1:
use Anakeen\SmartElementManager;

$initId = SmartElementManager::getInitIdFromName("TST_DDUI_USER1");
print("identifiant initial de TST_DDUI_USER1 = %d", $initId);
  • Résultat:
identifiant initial de TST_DDUI_USER1 = 1986

# getRevisedDocumentId

int|null getRevisedDocumentId(int $initid, int $revision)

Cette méthode permet de récupérer l'identifiant d'une révision d'un Smart Element.

# Liste des paramètres

initid (string|int)

Identifiant (numérique ou nom logique) d'un Smart Element.

reviison (int)

Numéro de la révision.

# Valeur de retour

Si un Smart Element est trouvé, alors la méthode retourne son identifiant; sinon, la méthode retourne null.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.
  • Dans le cas où le Smart Element n'est pas trouvé via son nom logique, une exception Anakeen\Exception est levée.

# Exemple

  • Récupérer l'id de la seconde révision du Smart Element identifié 2316
use Anakeen\SmartElementManager;

$id = SmartElementManager::getRevisedDocumentId(2316, 2);
$rev = SmartElementManager::getDocument($id, false);
print("identifiant de la seconde révision du Smart Element = %s", $rev);
  • Résultat:
identifiant de la seconde révision du Smart Element = NULL

INFO

La méthode renvoie null car il n'existe qu'une seule révision du Smart Element 2316.

# initializeDocument

SmartElement initializeDocument(string|int $structureIdentifier)

Cette méthode permet d'initialiser un objet SmartElement.

# Liste des paramètres

structureIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

# Valeur de retour

Cette méthode renvoie l'objet SmartElement initialisé.

# Erreurs / Exceptions

Si la SmartStructure identifiée par structureIdentifier n'est pas trouvée ou n'existe pas, une exception Anakeen\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::initializeDocument("IUSER");

# requireFamilyClass

void requireFamilyClass(int $familyId)

Cette méthode inclut la classe PHP de la Smart Structure.

# Liste des paramètres

familyId (int)

Identifiant (numérique) de la Smart Structure.

# Erreurs / Exceptions

Si l'identifiant renseigné n'est pas un identifiant numérique, alors une exception Anakeen\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;
SmartElementManager::requireFamilyClass("IUSER");

# createTemporaryDocument

SmartElement createTemporaryDocument(string|int $familyIdentifier, bool $useDefaultValues = true)

Cette méthode crée un objet SmartElement temporaire.

Avertissements

Le Smart Element n'est pas enregistré en base de donnée et ne possède ni identifiant, ni profil.
Le Smart Element sera détruit par la suite.

# Liste des paramètres

familyIdentifier (string|int)

Identifiant (numérique ou nom logique) de la Smart Structure parente.

useDefaultValues (bool)

Créer un objet SmartElement d'une Smart Structure avec les valeurs par défaut des paramètres. par défaut, useDefaultValues est égal à true.

# Valeur de retour

Cette méthode retourne un objet SmartElement.

# Erreurs / Exceptions

  • Si la Smart Structure n'est pas trouvée ou n'existe pas, une exception Anakeen\Exception est levée.
  • Si l'initialisation du Smart Element n'aboutit pas, une exception Anakeen\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

try {
    $doc = SEManager::createTemporaryDocument("IUSER");
} catch (\Anakeen\Core\DocManager\Exception $exception) {
    throw $exception
}

# getDocumentFromRawDocument

SmartElement getDocumentFromRawDocument(array $rawDocument)

Cette méthode permet créer un objet SmartElement depuis les valeurs des Smart Fields du Smart Element.

Avertissements

Aucun appel à la base de données n'est effectué pour récupérer les valeurs des Smart Fields.

# Liste des paramètres

rawDocument (array)

tableau associatif des valeurs des Smart Fields du Smart Element.

# Valeur de retour

Cette méthode retourne un objet SmartElement.

# Erreurs / Exceptions

  • Si l'identifiant du Smart Element brut n'est pas trouvé ou est inexistant, une exception Anakeen\Exception est levée.
  • Si une erreur se produit lors de l'initialisation du Smart Element, une exception Anakeen\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$rawD = array(
    'id'=>'128',
    'owner'=>'1',
    'title'=>'Utilisateur',
    'revision'=>'0',
    'initid'=>'128',
    'fromid'=>'0',
    'doctype'=>'C',
    'locked'=>'0',
    'allocated'=>NULL,
    'icon'=>'se-iuser.png',
    'lmodify'=>'Y',
    'profid'=>'2300',
    'usefor'=>'N',
    'mdate'=>'2019-06-1111: 00: 41.015937',
    'version'=>NULL,
    'cdate'=>'2019-02-2715: 17: 43.251415',
    'comment'=>NULL,
    'classname'=>'Anakeen\\SmartStructures\\Iuser\\IUserHooks',
    'state'=>NULL,
    'wid'=>NULL,
    'fieldvalues'=>'{
          "ccvid": 1019,
          "schar": "S",
          "cfldid": 0,
          "dfldid": 0,
          "maxrev": 0,
          "cprofid": 1947,
          "methods": "",
          "tagable": ""
    }',
    'postitid'=>NULL,
    'fallid'=>NULL,
    'cvid'=>NULL,
    'name'=>'IUSER',
    'dprofid'=>'0',
    'views'=>'{
          2
    }',
    'prelid'=>NULL,
    'atags'=>'{
          "vendor": "Anakeen"
    }',
    'confidential'=>NULL,
    'ldapdn'=>NULL,
    'cprofid'=>'1947',
    'dfldid'=>NULL,
    'cfldid'=>NULL,
    'ccvid'=>'1019',
    'cfallid'=>'1946',
    'ddocid'=>NULL,
    'methods'=>NULL,
    'defaultvalues'=>'{
          "us_status": "A",
          "us_loginfailure": "0"
    }',
    'schar'=>'S',
    'param'=>'{
          "us_defaultgroup": "GDEFAULT"
    }',
    'genversion'=>NULL,
    'maxrev'=>NULL,
    'usedocread'=>NULL,
    'tagable'=>NULL,
    'configuration'=>NULL,
)
$d = SmartElementManager::getDocumentFromRawDocument($rawD);
var_export($d);

# getTitle

string|null getTitle( string|int $documentIdentifier, bool $latest = true)

Cette méthode permet de récupérer le titre brut du Smart Element.

# Liste des paramètres

documentIdenfitier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Par défaut, latest est égal à true. Dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

# Valeur de retour

Cette méthode retourne null si le Smart Element est inexistant ou pas trouvé. Elle retourne une chaîne de caractères contenant le titre sur Smart Element dans le cas contrainre.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer le titre du Smart Element 2316:
use Anakeen\SmartElementManager;

$title = SmartElementManager::getTitle("TST_DDUI_USER1);
print("titre du Smart Element TST_DDUI_USER1 = %s", $title);
  • Résultat:
titre du Smart Element TST_DDUI_USER1 = GrandJean

# getDocumentProperties

array getDocumentProperties(string|int $documentIdentifier,
                            array $returnProperties,
                            bool $latest = true)

Cette méthode récupère les propriétés du Smart Element directement depuis la base de données.

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

returnProperties (array)

Tableau de propriétés à retourner. Note: si le tableau est vide, toutes les propriétés sont retournées.

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Par défaut, latest est égal à true. Dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

# Valeur de retour

  • Si le Smart Element n'est pas trouvé ou est inexistant, alors la méthode retourne null; sinon, elle retourne un tableau de propriétés.
    Note: les propriétés présentes dans le tableau sont définies dans le paramètre returnProperties.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer toutes les propriétés du Smart Element TST_DDUI_USER1:
use Anakeen\SmartElementManager;

$doc = SmartElementManager::getDocumentProperties("TST_DDUI_USER1", []);
var_export($doc);
  • Résultat:
array(
    "id": "1986",
    "owner": "1",
    "icon": "se-iuser.png",
    "title": "Grand Jean",
    "revision": "0",
    "version": null,
    "initid": "1986",
    "fromid": "128",
    "doctype": "F",
    "locked": "0",
    "allocated": null,
    "lmodify": "Y",
    "profid": "1986",
    "usefor": "N",
    "cdate": "2019-02-27 15:19:05.830858",
    "mdate": "2019-06-11 11:00:51.208222",
    "comment": null,
    "classname": null,
    "state": null,
    "wid": null,
    "postitid": null,
    "cvid": "1019",
    "name": "TST_DDUI_USER1",
    "dprofid": "1947",
    "atags": null,
    "prelid": "1982",
    "confidential": null,
    "ldapdn": null
),
  • Récupérer seulement quelques propriétés du Smart Element TST_DDUI_USER1:
use Anakeen\SmartElementManager;

$doc = SmartElementManager::getDocumentProperties("TST_DDUI_USER1", ["id", "owner", "fromid", "name"]);
var_export($doc);
  • Résultat:
array(
    "id": "1986",
    "owner": "1",
    "fromid": "128",
    "name": "TST_DDUI_USER1"
),

# getRawValue

string getRawValue(string|int $documentIdentifier,
                   string $dataIdentifier,
                   bool $latest = true,
                   bool $useCache = true)

Cette méthode retourne la valeur d'un Smart Field ou d'une propriété du Smart Element directement depuis la base de données.

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

dataIdentifier (string)

Identifiant du Smart Field ou de la propriété.

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Par défaut, latest est égal à true. Dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

useCache (bool)

Permet d'activer/désactiver l'utilisation du cache. Par défaut, l'utilisation du cache est activée (useCache = true).

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, alors la méthode renvoie null,
  • Si la requête à la base de données aboutit à un résultat null, la méthode renverra une chaîne de caractères vide,
  • Si la requête à la base de données aboutit à un résultat false, la méthode renverra null,
  • Sinon elle renverra la valeur du Smart Field ou de la propriété demandé(e).

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception Anakeen\Database\Exception est levée.

# Exemple

  • Récupérer le nom de famille de l'utilisateur TST_DDUI_USER1:
use Anakeen\SmartElementManager;

$doc = SmartElementManager::getRawValue("TST_DDUI_USER1", "us_lname");
print("le nom de famille de TST_DDUI_USER1 = %s", $doc);
  • Résultat
le nom de famille de TST_DDUI_USER1 = Grand

# getRawData

array|null getRawData(string|int $documentIdentifier,
                      array $dataIdentifiers,
                      bool $latest = true,
                      bool $useCache = true)

Cette méthode récupère les valeurs brutes d'un Smart Element.

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

dataIdentifiers (array)

Tableau d'identifiants de Smart Field ou de propriétés

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Par défaut, latest est égal à true. Dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

useCache (bool)

Permet d'activer/désactiver l'utilisation du cache. Par défaut, l'utilisation du cache est activée (useCache = true).

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, alors la méthode renvoie null,
  • Si le Smart Element existe, alors la méthode retourne un tableau indexé par les identifiants de SmartFields ou propriétés avec leurs valeurs.

# Erreurs / Exceptions

Dans le cas où une erreur se produit au niveau de la base de données, une exception Anakeen\Database\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getRawData("TST_DDUI_USER1", ["id", "fromid", "name", "us_lname", "us_mail", "us_login"]);
var_export($doc);
  • Résultat:
array(
    "id": "1986",
    "fromid": "128",
    "name": "TST_DDUI_USER1",
    "us_lname": "Grand",
    "us_mail": "gj@example.net",
    "us_login": "zoo.user1"
),

# getIdentifier

int getIdentifier(string|int $documentIdentifier, bool $latest)

Cette méthode retourne l'identifiant numérique du Smart Element.

# Liste des paramètres

documentIdentifier (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

latest (bool)

Permet de récupérer la dernière révision du Smart Element. Si latest est égal à true, alors la dernière révision du Smart Element sera retournée. Dans le cas où, latest est égal à false, seul un identifiant numérique peut être renseigné.

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, alors la méthode retourne 0,
  • Sinon, l'identifiant numérique du Smart Element est retourné.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getIdentifier("TST_DDUI_USER1", true);
print("l'identifiant numérique de TST_DDUI_USER1 = %d", $doc);
  • Résultat:
l'identifiant numérique de TST_DDUI_USER1 = 1986

# getIdFromName

int getIdFromName(string $documentName)

Cette méthode récupère l'identifiant de la dernière révision du Smart Element.

# Liste des paramètres

documentName (string)

Nom logique du Smart Element.

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, la méthode renvoie 0,
  • Sinon la méthode renvoie l'identifiant numérique du Smart Element.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.
  • Dans le cas où documentName n'est pas une chaîne de caractères, une exception Anakeen\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getIdFromName("TST_DDUI_USER1");
print("l'identifiant numérique de TST_DDUI_USER1 = %d", $doc);
  • Résultat:
l'identifiant numérique de TST_DDUI_USER1 = 1986

# getNameFromId

string|null getNameFromId(int $documentId)

Cette méthode retourne le nom logique du Smart Element correspondant à l'identifiant documentId.

# Liste des paramètres

documentId (int)

Identifiant numérique du Smart Element.

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, la méthode retourne null,
  • Sinon la méthode retourne la chaîne de caractères contenant le nom logique du Smart Element.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getNameFromId(1986);
print("le nom logique du Smart Element 1986 = %s" , $doc);
  • Résultat:
le nom logique du Smart Element 1986 = "TST_DDUI_USER1"

# getFamilyIdFromName

int getFamilyIdFromName(string $famName, $reset = false)

Cette méthode récupère l'identifiant numérique de la Smart Structure dont fait référence famName

# Liste des paramètres

famName (string)

Nom de la Smart Structure.

reset (bool)

Permet d'activer/désactiver la réinitialisation de la requête. Si reset est égal à true alors la méthode effectue une requête sur la base de données; sinon, la méthode récupère l'identifiant de la Smart Structure dans le cache.

# Valeur de retour

  • Si la Smart Structure n'existe pas ou n'est pas trouvée, la méthode retourne 0,
  • sinon, la méthode retourne l'identifiant numérique de la Smart Structure correspondant à famName.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getFamilyIdFromName("IUSER");
print("l'identifiant numérique de la Smart Structure IUSER = %d", $doc);
  • Résultat:
l'identifiant numérique de la Smart Structure IUSER = 128

# getFromId

int|null getFromId(string|int $documentId)

Cette méthode récupère l'identifiant de la Smart Structure associée à un Smart Element.

# Liste des paramètres

documentId (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

# Valeur de retour

  • Si le Smart Element n'est pas trouvé ou n'existe pas, la méthode retourne null;
  • sinon, la méthode retourne l'identifiant numérique de la Smart Structure associée au Smart Element.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getFromId("TST_DDUI_USER1");
print("l'identifiant numérique de la Smart Structure associée à TST_DDUI_USER1 = %d", $doc);
  • Résultat:
l'identifiant numérique de la Smart Structure associée à TST_DDUI_USER1 = 128

# getFromName

string|null getFromName(string|int $documentId)

Cette méthode retourne le nom de la Smart Structure associée au Smart Element.

# Liste des paramètres

documentId (string|int)

Identifiant (numérique ou nom logique) du Smart Element.

# Valeur de retour

  • Si le Smart Element n'existe pas ou n'est pas trouvé, la méthode retourne null,
  • sinon, la méthode retourne le nom de la Smart Structure associée.

# Erreurs / Exceptions

  • Dans le cas où une erreur se produit au niveau de la base de données, une exception \Anakeen\Database\Exception est levée.

# Exemple

use Anakeen\SmartElementManager;

$doc = SmartElementManager::getFromName("TST_DDUI_USER1");
print("le nom de la Smart Structure associée à TST_DDUI_USER1 = %s", $doc);
  • Résultat:
le nom de la Smart Structure associée à TST_DDUI_USER1 = IUSER

←