IMuModule

require_once IMu::$lib . '/Module.php';

Depuis : 1.0

Description

Permet d'accéder à un module EMu.

Constructeurs

Constructeur

Détails

__construct($table, $session)

__construct(string $table [, IMuSession $session = null])

Crée un objet qui peut être utilisé pour accéder à un module EMu.

Si le paramètre $session est null, une nouvelle session est créée automatiquement en utilisant les valeurs defaultHost et defaultPort de la classe IMuSession.

Paramètres :

$table (string)

Nom du module EMu auquel il faut accéder.

$session (IMuSession)

Un objet Session à utiliser pour communiquer avec le serveur IMu.

La valeur par défaut est null si elle n'est pas fournie.

Propriétés

Propriété

Détails

table

Le nom de la table associée à l'objet IMuModule.

Type :

string

Getter:

string getTable()

 

Méthodes

Méthode

Détails

addFetchSet($name, $columns)

int addFetchSet(string $name, mixed $columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de fetch( ).

Paramètres :

$name (string)

Nom logique à associer à l'ensemble de colonnes.

$columns (mixed)

Une string ou un tableau de strings contenant les noms des colonnes à utiliser lorsque $name est passé à fetch( ). Chaque string peut contenir un ou plusieurs noms de colonnes, séparés par un semi-colon ou un comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

addFetchSets($sets)

int addFetchSets(array $sets)

Associe plusieurs ensembles de colonnes à des noms logiques sur le serveur.

C’est l’équivalent d’appeler addFetchSet( ) pour chaque entrée de la Map, mais c’est plus efficace.

Paramètres :

$sets (array)

Un tableau associatif contenant des correspondances entre les noms et les ensembles de colonnes.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

addSearchAlias($name, $columns)

int addSearchAlias(string $name, mixed $columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à findTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres :

$name (string)

Nom logique à associer à l'ensemble de colonnes.

$columns (mixed)

Une string ou un tableau de strings contenant les noms des colonnes à utiliser lorsque $name est passé à findTerms( ).

Chaque string peut contenir un ou plusieurs noms de colonnes, séparés par un semi-colon ou un comma.

Retourne :

int

Le nombre d'alias (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

addSearchAliases($aliases)

int addSearchAliases(array $aliases)

Associe plusieurs ensembles de colonnes à des noms logiques sur le serveur.

C’est l’équivalent d’appeler addSearchAlias( ) pour chaque entrée de la Map, mais c’est plus efficace.

Paramètres :

$aliases (array)

Un tableau associatif contenant un ensemble de correspondances entre un nom et un ensemble de colonnes.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

addSortSet($name, $keys)

int addSortSet(string $name, mixed $keys)

Associe plusieurs ensembles de colonnes à des noms logiques sur le serveur.

Le nom peut être utilisé à la place d’une liste de clés de tri lors du tri du jeu de résultats actuel à l’aide de sort( ).

Paramètres :

$name (string)

Nom logique à associer à l'ensemble de colonnes.

$keys (mixed)

Une string ou un tableau de strings contenant les noms des clés à utiliser lorsque $name est passé à sort( ). Chaque string peut contenir un ou plusieurs noms de clés, séparés par un semi-colon ou un comma.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

addSortSets($sets)

int addSortSets(array $sets)

Associe plusieurs ensembles de clés de tri à des noms logiques sur le serveur.

C’est l’équivalent d’appeler addSortSet( ) pour chaque entrée de la liste, mais c’est plus efficace.

Paramètres :

$sets (array)

Un tableau associatif contenant un ensemble de correspondances entre un nom et un ensemble de clés.

Retourne :

int

Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

 

fetch($flag, $offset, $count, $columns)

IMuModuleFetchResult fetch(string $flag, int $offset, int $count [, mixed $columns = null])

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres :

$flag (string)

La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end

$offset (int)

La position par rapport à $flag à partir de laquelle commencer la récupération.

$count (int)

Le nombre d’enregistrements à récupérer. Un $count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un $count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.

$columns (mixed)

Une string ou un tableau de strings contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant addFetchSet( ). Chaque string peut contenir un ou plusieurs noms de colonnes, séparés par un semi-colon ou un comma.

Si ce paramètre n’est pas fourni, aucune donnée de colonne n’est renvoyée. Les résultats incluront toujours la pseudo-colonne rownum pour chaque enregistrement récupéré.

La valeur par défaut est null si elle n'est pas fournie.

Retourne :

IMuModuleFetchResult Un objet IMuModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

fetchHierarchy($key, $parent)

fetchHierarchy(int $key, string $parent)

Récupère une hiérarchie d’enregistrements autour de l’enregistrement dont la valeur de clé est $key.

Paramètres :

$key (int)

La clé de l’enregistrement à partir duquel commencer à construire la hiérarchie.

$parent (string)

Le nom de la colonne qui contient le champ de fichier jointe parent.

Retourne :

findKey($key)

int findKey(int $key)

Recherche un enregistrement avec la valeur clé $key.

Paramètres :

$key (int)

Clé de l’enregistrement recherché.

Retourne :

int

Le nombre d'enregistrements trouvés. Ce sera soit 1 si l’enregistrement a été trouvé, soit 0 s’il n’a pas été trouvé.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

findKeys($keys)

int findKeys(array $keys)

Recherche les enregistrements avec des valeurs clés dans le tableau $keys.

Paramètres :

$keys (array)

La liste des clés recherchées.

Retourne :

int

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

findTerms($terms)

int findTerms(mixed $terms)

Recherche les enregistrements qui correspondent aux termes de recherche spécifiés dans $terms.

Paramètres :

$terms (mixed)

Les termes de recherche.

Retourne :

int

Une estimation du nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

findWhere($where)

int findWhere(string $where)

Recherche les enregistrements qui correspondent à la clause TexQL WHERE.

Paramètres :

$where (string)

La clause TexQL WHERE à utiliser.

Retourne :

int

Une estimation du nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

restoreFromFile($file)

int restoreFromFile(string $file)

Restaure un ensemble d’enregistrements à partir d’un fichier sur la machine serveur qui contient une liste de clés, une par ligne.

Paramètres :

$file (string)

Le fichier sur la machine serveur contenant les clés.

Retourne :

int

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

restoreFromTemp($file)

int restoreFromTemp(string $file)

Restaure un ensemble d’enregistrements à partir d’un fichier temporaire sur la machine serveur qui contient une liste de clés, une par ligne.

Fonctionne de la même manière que restoreFromFile( ) sauf que le paramètre file est relatif au répertoire temporaire du serveur.

Paramètres :

$file (string)

Le fichier sur la machine serveur contenant les clés.

Retourne :

int

Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

sort($keys, $flags)

ModuleSortResult sort(mixed $keys [, mixed $flags = null])

Trie le jeu de résultats en cours à l’aide des clés de tri dans $keys. Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres :

$keys (mixed)

Une string ou un tableau de strings contenant la liste des clés de tri. Chaque string peut contenir un ou plusieurs noms de clés, séparés par un semi-colon ou un comma.

$flags (mixed)

Une string ou un tableau de strings contenant un ensemble d’indicateurs spécifiant le comportement du tri. Chaque string peut contenir un ou plusieurs indicateurs, séparés par un semi-colon ou un comma.

La valeur par défaut est null si elle n'est pas fournie.

Retourne :

ModuleSortResult

Un tableau contenant les informations du rapport si l’indicateur report a été spécifié. Sinon, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.