IMuModule

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

Since: 1.0

Description

Provides access to an EMu module.

Constructors

Constructor

Details

__construct($table, $session)

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

Creates an object which can be used to access an EMu module.

If the $session parameter is null a new session is created automatically using the IMuSession class's defaultHost and defaultPort values.

Parameters:

$table (string)

Name of the EMu module to be accessed.

$session (IMuSession)

A Session object to be used to communicate with the IMu server.

Defaults to null if not supplied.

Properties

Property

Details

table

The name of the table associated with the IMuModule object.

Type:

string

Getter:

string getTable()

 

Methods

Method

Details

addFetchSet($name, $columns)

int addFetchSet(string $name, mixed $columns)

Associates a set of columns with a logical name on the server.

The name can be used instead of a column list when retrieving data using fetch( ).

Parameters:

$name (string)

The logical name to associate with the set of columns.

$columns (mixed)

A string or an array of strings containing the names of the columns to be used when $name is passed to fetch( ). Each string can contain one or more column names, separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

addFetchSets($sets)

int addFetchSets(array $sets)

Associates several sets of columns with logical names on the server.

This is the equivalent of calling addFetchSet( ) for each entry in the map but is more efficient.

Parameters:

$sets (array)

An associative array containing mappings between names and sets of columns.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

addSearchAlias($name, $columns)

int addSearchAlias(string $name, mixed $columns)

Associates a set of columns with a logical name on the server.

The name can be used when specifying search terms to be passed to findTerms( ). The search becomes the equivalent of an OR search involving the columns.

Parameters:

$name (string)

The logical name to associate with the set of columns.

$columns (mixed)

A string or an array of strings containing the names of the columns to be used when $name is passed tofindTerms( ).

Each string can contain one or more column names, separated by a semi-colon or a comma.

Returns:

int

The number of aliases (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

addSearchAliases($aliases)

int addSearchAliases(array $aliases)

Associates several sets of columns with logical names on the server.

This is the equivalent of calling addSearchAlias( ) for each entry in the map but is more efficient.

Parameters:

$aliases (array)

An associative array containing a set of mappings between a name and a set of columns.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

addSortSet($name, $keys)

int addSortSet(string $name, mixed $keys)

Associates several sets of columns with logical names on the server.

The name can be used instead of a sort key list when sorting the current result set using sort( ).

Parameters:

$name (string)

The logical name to associate with the set of columns.

$keys (mixed)

A string or an array of strings containing the names of the keys to be used when $name is passed to sort( ). Each string can contain one or more keys, separated by a semi-colon or a comma.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

If a server-side error occurred.

addSortSets($sets)

int addSortSets(array $sets)

Associates several sets of sort keys with logical names on the server.

This is the equivalent of calling addSortSet( ) for each entry in the list but is more efficient.

Parameters:

$sets (array)

An associative array containing a set of mappings between a name and a set of keys.

Returns:

int

The number of sets (including this one) registered on the server.

Throws:

IMuException

 

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

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

Fetches count records from the position described by a combination of flag and offset.

Parameters:

$flag (string)

The position to start fetching records from. Must be one of: start, current, end

$offset (int)

The position relative to $flag to start fetching from.

$count (int)

The number of records to fetch. A $count of 0 is permitted to change the location of the current record without returning any results. A $count of less than 0 causes all the remaining records in the result set to be returned.

$columns (mixed)

A string or an array of strings containing the names of the columns to be returned for each record or the name of a column set which has been registered previously using addFetchSet( ). Each string can contain one or more column, names, separated by a semi-colon or a comma.

If this parameter is not supplied, no column data is returned. The results will still include the pseudo-column rownum for each fetched record.

Defaults to null if not supplied.

Returns:

IMuModuleFetchResult An IMuModuleFetchResult object.

Throws:

IMuException

If a server-side error occurred.

fetchHierarchy($key, $parent)

fetchHierarchy(int $key, string $parent)

Fetches a hierarchy of records around the record with the key value of $key.

Parameters:

$key (int)

The key of the record to start building the hierarchy from.

$parent (string)

The name of the column which contains the parent attachment.

Returns:

findKey($key)

int findKey(int $key)

Searches for a record with the key value $key.

Parameters:

$key (int)

The key of the record being searched for.

Returns:

int

The number of records found. This will be either 1 if the record was found or 0 if not found.

Throws:

IMuException

If a server-side error occurred.

findKeys($keys)

int findKeys(array $keys)

Searches for records with key values in the array $keys.

Parameters:

$keys (array)

The list of keys being searched for.

Returns:

int

The number of records found.

Throws:

IMuException

If a server-side error occurred.

findTerms($terms)

int findTerms(mixed $terms)

Searches for records which match the search terms specified in $terms.

Parameters:

$terms (mixed)

The search terms.

Returns:

int

An estimate of the number of records found.

Throws:

IMuException

If a server-side error occurred.

findWhere($where)

int findWhere(string $where)

Searches for records which match the TexQL WHERE clause.

Parameters:

$where (string)

The TexQL WHERE clause to use.

Returns:

int

An estimate of the number of records found.

Throws:

IMuException

If a server-side error occurred.

restoreFromFile($file)

int restoreFromFile(string $file)

Restores a set of records from a file on the server machine which contains a list of keys, one per line.

Parameters:

$file (string)

The file on the server machine containing the keys.

Returns:

int

The number of records found.

Throws:

IMuException

If a server-side error occurred.

restoreFromTemp($file)

int restoreFromTemp(string $file)

Restores a set of records from a temporary file on the server machine which contains a list of keys, one per line.

Operates the same way as restoreFromFile( ) except that the file parameter is relative to the server's temporary directory.

Parameters:

$file (string)

The file on the server machine containing the keys.

Returns:

int

The number of records found.

Throws:

IMuException

If a server-side error occurred.

sort($keys, $flags)

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

Sorts the current result set by the sort keys in $keys. Each sort key is a column name optionally preceded by a + (for an ascending sort) or a - (for descending sort).

Parameters:

$keys (mixed)

A string or array of strings containing the list of sort keys. Each string can contain one or more keys, separated by a semi-colon or a comma.

$flags (mixed)

A string or array of strings containing a set of flags specifying the behaviour of the sort. Each string can contain one or more flags, separated by a semi-colon or a comma.

Defaults to null if not supplied.

Returns:

ModuleSortResult

An array containing the report information if the report flag has been specified. Otherwise the result will be null.

Throws:

IMuException

If a server-side error occurred.