Skip to content

Latest commit

 

History

History
2726 lines (1958 loc) · 90.5 KB

README.md

File metadata and controls

2726 lines (1958 loc) · 90.5 KB
Raw

IMu API for PHP

At its core, IMu provides a set of Application Programming Interfaces (APIs).

Contents

Using The IMu API

The IMu API source code bundle for version 2.0 (or higher) is required to develop an IMu-based application. This bundle contains all the classes that make up the IMu PHP API. IMu API bundles are available from the IMu releases page.

In order to use the IMu PHP API, include IMu.php in the PHP code. For example, if the IMu API source code is installed in the directory /usr/local/lib/imu the following line would be added to the PHP code:

require_once '/usr/local/lib/imu/IMu.php';

The IMu.php file defines the IMu class. This class includes static members which contain information about the IMu installation. The class includes:

IMu::$lib - the path to the IMu PHP API files.
IMu::VERSION - the version of this IMu release.

The $lib member should also be used to simplify the requiring of other IMu library files, for example:

<?php
require_once IMu::$lib . '/Session.php';
?>

Test Program

Building this very simple IMu-based web page is a good test of whether the development environment has been set up properly for using IMu:

<?php
require_once '/usr/local/lib/imu/IMu.php';

printf('IMu version %s', IMu::VERSION);
exit(0);
?>

Exceptions

Many of the methods in the IMu library objects throw an exception when an error occurs. For this reason, code that uses IMu library objects should be surrounded with an try block.

The following code is a basic template for writing PHP programs that use the IMu library:

<?php
require_once '/usr/local/lib/imu/IMu.php';
// ⋯
try
{
    /* Create and use IMu objects
     * ⋯
     */
}
catch (Exception $e)
{
    /* Handle or report error
     * ⋯
     */
}
?>

Most IMu exceptions throw an IMuException object. The IMuException class is a subclass of the standard PHP Exception. In many cases your code can simply catch the standard Exception (as in this template). If more information is required about the exact IMuException thrown, see Exceptions.

NOTE:

Many of the examples that follow assume that code fragments have been surrounded with code structured in this way.

Connecting to an IMu Server

Most IMu based programs begin by creating a connection to an IMu server. Connections to a server are created and managed using IMu’s IMuSession class. Before connecting, both the name of the host and the port number to connect on must be specified. This can be done in one of three ways.

  1. The simplest way to create a connection to an IMu server is to pass the host name and port number to the IMuSession constructor and then call the connect method. For example:

    require_once '/usr/local/lib/imu/IMu.php';
require_once IMu::$lib . '/Session.php';
// ⋯
$session = new IMuSession('server.com', 12345);
$session->connect();

  2. Alternatively, pass no values to the constructor and then set the host and port properties (using the setHost and setPort methods) before calling connect:

    require_once '/usr/local/lib/imu/IMu.php';
require_once IMu::$lib . '/Session.php';
// ⋯
$session = new IMuSession();
$session->setHost("server.com");
$session->setPort(12345);
$session->connect();

  3. If either the host or port is not set, the IMuSession class default value will be used. These defaults can be overridden by setting the (static) class properties defaultHost and defaultPort:

    require_once '/usr/local/lib/imu/IMu.php';
require_once IMu::$lib . '/Session.php';
// ⋯
IMuSession::setDefaultHost('server.com');
IMuSession::setDefaultPort(12345);
$session = new IMuSession();
$session->connect();

    This technique is useful when planning to create several connections to the same server or when wanting to get a Handler object to create the connection automatically.

Handlers

Once a connection to an IMu server has been established, it is possible to create handler objects to submit requests to the server and receive responses.

NOTE:

When a handler object is created, a corresponding object is created by the IMu server to service the handler’s requests.

All handlers are subclasses of IMu’s IMuHandler class.

NOTE:

You do not typically create a IMuHandler object directly but instead use a subclass.

In this document we examine the most frequently used handler, IMuModule, which allows you to find and retrieve records from a single EMu module.

Accessing an EMu Module

The IMu API provides facilities to search, sort and retrieve information from records in any EMu module. This section contains the reference material for these facilities.

Searching a Module

A program accesses an EMu module (or table, the terms are used interchangeably) using the IMuModule class. The name of the table to be accessed is passed to the IMuModule constructor. For example:

require_once IMu::$lib . '/Module.php';
// ⋯
$parties = new IMuModule('eparties', $session);

This code assumes that a IMuSession object called session has already been created. If a IMuSession object is not passed to the IMuModule constructor, a session will be created automatically using the defaultHost and defaultPort class properties. See Connecting to an IMu server for details.

Once a IMuModule object has been created, it can be used to search the specified module and retrieve records.

Any one of the following methods can be used to search for records within a module:

The findKey Method

The findKey method searches for a single record by its key.

For example, the following code searches for a record with a key of 42 in the Parties module:

require_once IMu::$lib . '/Module.php';
// ⋯
$parties = new IMuModule('eparties', $session);
$hits = $parties->findKey(42);

The method returns the number of matches found, which is either 1 if the record exists or 0 if it does not.

The findKeys Method

The findKeys method searches for a set of key values. The keys are passed as an array of long integers:

$parties = new IMuModule('eparties', $session);
$keys = array(52, 42, 17);
$hits = $parties->findKeys(keys);

The findTerms Method

The findTerms method is the most flexible and powerful way to search for records within a module. It can be used to run simple single term queries or complex multi-term searches.

The terms are specified using a IMuTerms object. Once a IMuTerms object has been created, add specific terms to it (using the add method) and then pass the IMuTerms object to the findTerms method. For example, to specify a Parties search for records which contain a first name of “John” and a last name of “Smith”:

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

$search = new IMuTerms();
$search->add('NamFirst', 'John');
$search->add('NamLast', 'Smith');

$hits = $parties->findTerms($search);

There are several points to note:

  1. The first argument passed to the add method element contains the name of the column or an alias in the module to be searched.

  2. An alias associates a supplied value with one or more actual columns. Aliases are created using the addSearchAlias or addSearchAliases methods.

  3. The second argument contains the value to search for.

  4. Optionally, a comparison operator can be supplied as a third argument (see below examples). The operator specifies how the value supplied as the second argument should be matched.

    Operators are the same as those used in TexQL (see KE’s TexQL documentation for details). If not supplied, the operator defaults to “matches”.

    This is not a real TexQL operator, but is translated by the search engine as the most “natural” operator for the type of column being searched. For example, for text columns “matches” is translated as the contains TexQL operator and for integer columns it is translated as the = TexQL operator.

NOTE:

Unless it is really necessary to specify an operator, consider using the matches operator, or better still supplying no operator at all as this allows the server to determine the best type of search.

Examples

  1. To search for the name “Smith” in the last name field of the Parties module, the following term can be used:

    $search = new IMuTerms();
$search->add('NamLast', 'Smith');

  2. Specifying search terms for other types of columns is straightforward. For example, to search for records inserted on April 4, 2011:

    $search = new IMuTerms();
$search->add('AdmDateInserted', 'Apr 4 2011');

  3. To search for records inserted before April 4, 2011, it is necessary to add an operator:

    $search = new IMuTerms();
$search->add('AdmDateInserted', 'Apr 4 2011', '<');

  4. By default, the relationship between the terms is a Boolean AND. This means that to find records which match both a first name containing “John” and a last name containing “Smith” the IMuTerms object can be created as follows:

    $search = new IMuTerms();
$search->add('NamFirst', 'John');
$search->add('NamLast', 'Smith');

  5. IMuTerms object where the relationship between the terms is a Boolean OR can be created by passing the string value “OR” to the IMuTerms constructor:

    $search = new IMuTerms('OR');
$search->add('NamFirst', 'John');
$search->add('NamLast', 'Smith');

    This specifies a search for records where either the first name contains “John” or the last name contains “Smith”.

  6. Combinations of AND and OR search terms can be created. The addAnd method adds a new set of AND terms to the original IMuTerms object. Similarly the addOr method adds a new set of OR terms. For example, to restrict the search for a first name of “John” and a last name of “Smith” to matching records inserted before April 4, 2011 or on May 1, 2011, specify:

    $search = new IMuTerms();
$search->add('NamFirst', 'John');
$search->add('NamLast', 'Smith');
$dates = $search->addOr();
$dates->add('AdmDateInserted', 'Apr 4 2011', '<');
$dates->add('AdmDateInserted', 'May 1 2011');

  7. To run a search, pass the IMuTerms object to the findTerms method:

    $parties = new Module('eparties', $session);
$search = new IMuTerms();
$search->add('NamLast', 'Smith');
$hits = $parties->findTerms($search);

    As with other find methods, the return value contains the estimated number of matches.

  8. To use a search alias, call the addSearchAlias method to associate the alias with one or more real column names before calling findTerms. Suppose we want to allow a user to search the Catalogue module for keywords. Our definition of a keywords search is to search the SummaryData, CatSubjects_tab and NotNotes columns. We could do this by building an OR search:

    $keyword = '⋯';
// ⋯
$search = new IMuTerms('OR');
$search->add('SummaryData', $keyword);
$search->add('CatSubjects_tab', $keyword);
$search->add('NotNotes', $keyword);

    Another way of doing this is to register the association between the name keywords and the three columns we are interested in and then pass the name keywords as the column to be searched:

    $keyword = '⋯';
// ⋯
$catalogue = new IMu::Module('ecatalogue', $session);
$columns = array
(
    'SummaryData',
    'CatSubjects_tab',
    'NotNotes'
);
$catalogue->addSearchAlias('keywords', $columns);
// ⋯
$search = new IMuTerms();
$search->add('keywords', $keyword);
$catalogue->findTerms($search);

    An alternative to passing the columns as an array of strings is to pass a single string, with the column names separated by semi-colons:

    $keyword = '⋯';
// ⋯
$catalogue = new Module('ecatalogue', $session);
$columns = 'SummaryData;CatSubjects_tab;NotNotes';
$catalogue->addSearchAlias('keywords', $columns);
// ⋯
$search = new IMuTerms();
$search->add('keywords', $keyword);
$catalogue->findTerms($search);

    The advantage of using a search alias is that once the alias is registered a simple name can be used to specify a more complex OR search.

  9. To add more than one alias at a time, build an associative array of names and columns and call the addSearchAliases method:

    $aliases = array
(
    'keywords' => 'SummaryData;CatSubjects_tab;NotNotes',
    'title' => 'SummaryData;TitMainTitle'
);
$module->addSearchAliases($aliases);

The findWhere Method

With the findWhere method it is possible to submit a complete TexQL where clause:

$parties = new Module('eparties', $session);
$where = "NamLast contains 'Smith'";
$hits = $parties->findWhere($where);

Although this method provides complete control over exactly how a search is run, it is generally better to use findTerms to submit a search rather than building a where clause. There are (at least) two reasons to prefer findTerms over findWhere:

  1. Building the where clause requires the code to have detailed knowledge of the data type and structure of each column. The findTerms method leaves this task to the server.

    For example, specifying the term to search for a particular value in a nested table is straightforward. To find Parties records where the Roles nested table contains Artist, findTerms simply requires:

    $search->add('NamRoles_tab', 'Artist');

    On the other hand, the equivalent TexQL clause is:

    exists(NamRoles_tab where NamRoles contains 'Artist');

    The TexQL for double nested tables is even more complex.

  2. More importantly, findTerms is more secure.

    With findTerms a set of terms is submitted to the server which then builds the TexQL where clause. This makes it much easier for the server to check for terms which may contain SQL-injection style attacks and to avoid them.

    If your code builds a where clause from user-entered data so it can be run using findWhere, it is much more difficult, if not impossible, for the server to check and avoid SQL-injection. The responsibility for checking for SQL-injection becomes yours.

Number of Matches

All of the find methods return the number of matches found by the search. For findKey and findKeys this number is always the exact number of matches found. The number returned by findTerms and findWhere is best thought of as an estimate.

This estimate is almost always correct but because of the nature of the indexing used by the server’s data engine (Texpress) the number can sometimes be an over-estimate of the real number of matches. This is similar to the estimated number of hits returned by a Google search.

Sorting

The sort Method

The IMuModule class sort method is used to order a set of matching records once the search of a module has been run.

Arguments

This sort method takes two arguments:

  • columns

    The columns argument is used to specify the columns by which to sort the result set. The value of the argument can be either a string or a reference to an array of strings. Each string can be a simple column name or a set of column names, separated by semi-colons or commas.

    Each column name can be preceded by a + (plus) or - (minus or dash). A leading + indicates that the records should be sorted in ascending order. A leading - indicates that the records should be sorted in descending order.

    NOTE:

    If a sort order (“+” or “-”) is not given, the sort order defaults to ascending.

  • flags

    The flags argument is used to pass one or more flags to control the way the sort is carried out. As with the columns argument, the flags argument can be a string or a reference to an array of strings. Each string can be a single flag or a set of flags separated by semi-colons or commas.

    The following flags control the type of comparisons used when sorting:

    • word-based

      Sort disregards white spaces (more than the one space between words). As of Texpress 9.0, word-based sorting no longer disregards punctuation. For example:

      Traveler's           Inn

      will be sorted as

      Traveler's Inn

    • full-text

      Sort includes all punctuation and white spaces. For example:

      Traveler's           Inn

      will be sorted as

      Traveler's           Inn

      and will therefore differ from

      Traveler's Inn

    • compress-spaces

      Sort includes punctuation but disregards all white space (with the exception of a single space between words). For example:

      Traveler's           Inn

      will be sorted as

      Traveler's Inn

      NOTE:

      If none of these flags are included, the comparison defaults to word-based.

    The following flags modify the sorting behaviour:

    • case-sensitive

      Sort is sensitive to upper and lower case. For example:

      Melbourne gallery

      will be sorted separately to

      Melbourne Gallery

    • order-insensitive

      Values in a multi-value field will be sorted alphabetically regardless of the order in which they display. For example, a record which has the following values in the NameRoles_tab column in this order:

      1. Collection Manager
      2. Curator
      3. Internet Administrator

      and another record which has the values in this order:

      1. Internet Administrator
      2. Collection Manager
      3. Curator

      will be sorted the same.

    • null-low

      Records with empty columns will be placed at the start of the result set rather than at the end.

    • extended-sort

      Values that include diacritics will be sorted separately to those that do not. For example:

      entrée

      will be sorted separately to

      entree

    The following flags can be used when generating a summary of the sorted records:

    • report

      A summary of the sort is generated. The summary report is a hierarchically structured object that summarises the number of unique values contained in the sort columns. See Return Value and Example for a description and illustration of the returned structure.

    • table-as-text

      All data from multi-valued columns will be treated as a single value (joined by line break characters) in the summary results array. For example, for a record which has the following values in the NamRoles_tab column:

      Collection Manager, Curator, Internet Administrator

      the summary will include statistics for a single value:

      Collection Manager Curator Internet Administrator

      Thus the number of values in the summary results display will match the number of records.

      If this option is not included, each value in a multi-valued column will be treated as a distinct value in the summary. Thus there may be many more values in the summary results than there are records.

For example:

  1. Sort parties by first name (ascending):

    $parties = new Module('eparties', $session);
$search = new IMuTerms();
$search->add('NamLast', 'Smith');
$hits = $parties->findTerms($search);

$parties->sort('NamFirst');

  2. Sort parties by title (ascending) and then first name (descending):

    $sort = array
(
    'NamTitle',
    '-NamFirst'
);
$parties->sort($sort);

  3. Run a case-sensitive sort of parties by title (ascending) and then first name (descending):

    $sort = array
(
    'NamTitle',
    '-NamFirst'
);
$flags = array
(
    'case-sensitive'
);
$parties->sort($sort, $flags);

Return Value

The sort method returns null unless the report flag is used.

If the report flag is used, the sort method returns an array representing a list of distinct terms associated with the primary column in the sorted result set.

Each element in the array is an associative array. The associative array contains three elements which describe the term:

  • value

    A string that is the distict value itself.

  • count

    An integer specifying the number of records in the result set which have the value.

  • list

    A nested array that holds the values for secondary sorts within the primary sort.

This is illustrated in the following example.

Example

This example shows a three-level sort by title, last name (descending) and first name on a set of Parties records:

$parties = new Module('eparties', $session);

$terms = new IMuTerms('or');
$terms->add('NamLast', 'Smith');
$terms->add('NamLast', 'Wood');

$hits = $parties->findTerms($terms);

$sort = array
(
    'NamTitle',
    '-NamLast',
    'NamFirst'
);
$flags = array
(
    'full-text',
    'report'
);
$report = $parties->sort($sort, $flags);
showSummary($report, 0);
exit(0);

function showSummary($report, $indent)
{
    $prefix = '';
    for ($i = 0; $i < $indent; $i++)
        $prefix .= '  ';

    foreach ($report as $term)
    {
        $value = $term['value'];
        $count = $term['count'];
        printf("%s%s (%d)\n", $prefix, $value, $count);

		if (isset($term['list']))
        	showSummary($term['list'], $indent + 1);
    }
}

This displays the distinct terms (and their counts) for the primary sort key (title). Nested under each primary key is the set of distinct terms and counts for the secondary key (last name) and nested under each secondary key is the set of distinct terms and counts for the tertiary key (first name):

Mr (2)
  Wood (1)
    Gerard (1)
  SMITH (1)
    Ian (1)
Ms (1)
  ECCLES-SMITH (1)
    Kate (1)
Sir (1)
  Wood (1)
    Henry (1)
 (3)
  Wood (1)
    Grant (1)
  Smith (2)
    Sophia (1)
    William (1)

If another sort key was specified its terms would be nested under the tertiary key and so on.

NOTE:

In the example above some of the records do not have a value for the primary sort key (title). By default these values are sorted after any other values. They can be sorted before other values using the null-low flag.

Getting Information from Matching Records

The fetch Method

The IMuModule class fetch method is used to get information from the matching records once the search of a module has been run. The server maintains the set of matching records in a list and the fetch method can be used to retrieve any information from any contiguous block of records in the list.

Arguments

The fetch method has four arguments:

  • flag

  • offset

    Together the flag and offset arguments define the starting position of the block of records to be fetched. The flag argument is a string and must be one of:

    • start
    • current
    • end

    The “start” and “end” flags refer to the first record and the last record in the matching set. The “current” flag refers to the position of the last record fetched by the previous call to the fetch method. If the fetch method has not been called, “current” refers to the first record in the matching set.

    The offset argument is an integer. It adjusts the starting position relative to the value of the flag argument. A positive value for offset specifies a start after the position specified by flag and a negative value specifies a start before the position specified by flag.

    For example, calling fetch with a flag of “start” and offset of 3 will return records starting from the fourth record in the matching set. Specifying a flag of “end” and an offset of -8 will return records starting from the ninth last record in the matching set.

    To retrieve the next record after the last returned by the previous fetch, you would pass a flag of “current” and an offset of 1.

  • count

    The count argument specifies the maximum number of records to be retrieved.

    Passing a count value of 0 is valid. This causes fetch to change the current record without actually retrieving any data.

    Using a negative value for count is also valid. This causes fetch to return all the records in the matching set from the starting position (specified by flag and offset).

  • columns

    The optional columns argument is used to specify which columns should be included in the returned records. The argument can be either a string or a reference to an array of strings. In its simplest form each string contains a single column name, or several column names separated by semi-colons or commas.

    The value of the columns argument can be more than simple column names. See the section on Specifying Columns for details.

For example:

  1. Retrieve the first record from the start of a set of matching records:

    $parties = new Module('eparties', $session);
$columns = 'NamFirst,NamLast';
$result = $parties->fetch('start', 0, 1, $columns);

    The columns argument can also be specified as an array reference:

    $parties = new Module('eparties', $session);
$columns = array
(
    'NamFirst',
    'NamLast'
);
$result = $parties->fetch('start', 0, 1, $columns);

  2. Return all of the results in a matching set:

    $parties = new Module('eparties', $session);
$columns = array
(
    'NamFirst',
    'NamLast'
);
$result = $parties->fetch('start', 0, -1, $columns);

  3. Change the current record to the next record in the set of matching records without retrieving any data:

    $parties->fetch('current', 1, 0);

  4. Retrieve the last record from the end of a set of matching records:

    $parties = new Module('eparties', $session);
$columns = array
(
    'NamFirst',
    'NamLast'
);
$result = $parties->fetch('end', 0, 1, $columns);

Return Value

The fetch method returns records requested in an IMuModuleFetchResult object. It contains three members:

  • count

    The number of records returned by the fetch request.

  • hits

    The estimated number of matches in the result set. This number is returned for each fetch because the estimate can decrease as records in the result set are processed by the fetch method.

  • rows

    A reference to an array containing the set of records requested. Each element of the rows array is itself a reference to a hash. Each hash contains entries for each column requested.

For example, retrieve the count & hits properties and iterate over all of the returned records using the rows property:

$columns = array
(
    'NamFirst',
    'NamLast'
);
$result = $parties->fetch('start', 0, 2, $columns);
$count = $result->count;
$hits = $result->hits;

print("Count: $count\n");
print("Hits: $hits\n");
print("Rows:\n");
foreach ($result->rows as $row)
{
    $rowNum = $row['rownum'];
    $irn = $row['irn'];
    $firstName = $row['NamFirst'];
    $lastName = $row['NamLast'];
    printf("  %d. %s, %s (%d)\n", $rowNum, $lastName, $firstName, $irn);
}

This will produce output similar to the following:

Count: 2
Hits: 4
Rows:
  1. ECCLES-SMITH, Kate (100573)
  2. SMITH, Ian (100301)

Specifying Columns

This section specifies the values that can be included or used as the columns arguments to the IMuModule class fetch method.

Atomic Columns

These are simple column names of the type already mentioned, for example:

NamFirst

The values of atomic columns are returned as strings:

$columns = array
(
    'NamFirst'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $first = $row['NamFirst'];
    // ⋯
}

Nested Tables

Nested tables are columns that contain a list of values. They are specified similarly to atomic columns:

NamRoles_tab

The values of nested tables are returned as an array. Each array member is a string that corresponds to a row from the nested table:

$columns = array
(
    'NamRoles_tab'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $roles = $row['NamRoles_tab'];
    foreach ($roles as $role)
    {
        // ⋯
    }
}

Columns From Attached Records

An attachment is a link between a record in a module and a record in the same or another module. The columns from an attached record can be specified by first specifying the attachment column and then the column to retrieve from the attached record:

SynSynonymyRef_tab.SummaryData

Multiple columns can be specified from the attached record:

SynSynonymyRef_tab.(NamFirst,NamLast)

The return values of columns from attached records depends on the type of the attachment column. If the attachment column is atomic then the column values are returned as an associative array. If the attachment column is a nested table the values are returned as an array. Each array member is an associative array containing the requested column values for each attached record:

$columns = array
(
    'SynSynonymyRef_tab.(NamFirst,NamLast)'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $synonymies = $row['SynSynonymyRef_tab'];
    foreach ($synonymies as $synonymy)
    {
        $first = $synonymy['NamFirst'];
        $last = $synonymy['NamLast'];
        // ⋯
    }
}

Columns Grom Reverse Attachments

A reverse attachment allows you to specify columns from other records in the same module or other modules that have the current record attached to a specified column.

For example:

  1. Retrieve the TitMainTitle (Main Title) column for all Catalogue records that have the current Parties record attached to their CreCreatorRef_tab (Creator) column:

    <ecatalogue:CreCreatorRef_tab>.TitMainTitle

  2. Retrieve the NarTitle (Title) column for all Narratives records that have the current Narrative record attached to their HieChildNarrativesRef_tab (Child Narratives) column:

    <enarratives:HieChildNarrativesRef_tab>.NarTitle

Multiple columns can be specified from the reverse attachment record:

<ecatalogue:CreCreatorRef_tab>.(TitMainTitle,TitObjectCategory)

Reverse attachments are returned as an array. Each array member is an associative array containing the requested column values from each record from the specified module (The Catalogue module in the example below) that has the current record attached to the specified column (The CreCreatorRef_tab column in the example below):

$columns = array
(
    '<ecatalogue:CreCreatorRef_tab>.(TitMainTitle,TitObjectCategory)'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $objects = $row['ecatalogue:CreCreatorRef_tab'];
    foreach ($objects as $object)
    {
        $title = $object['TitMainTitle'];
        $category = $object['TitObjectCategory'];
        // ⋯
    }
}

Grouped Nested Tables

A set of nested table columns can be grouped by specifying them between square brackets.

For example, to group the Contributors and their Role from the Narratives module:

[NarContributorRef_tab.SummaryData,NarContributorRole_tab]

Each corresponding rows of the supplied nested tables are returned as a single table row in the returned results. By default, the group is given a name of group1, group2 and so on. This group name can be changed by prefixing the grouped columns with an alternative name:

contributors=[NarContributorRef_tab.SummaryData,NarContributorRole_tab]

The grouped nested tables are returned as an array. Each array member is an associative array containing corresponding rows from the nested tables:

$columns = array
(
    '[NarContributorRef_tab.SummaryData,NarContributorRole_tab]'
);
$result = $narratives->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $groupedRows = $row['group1'];
    foreach ($groupedRows as $groupedRow)
    {
        /* NarContributorRef_tab is an attachment column. */
        $contributor = $groupedRow['NarContributorRef_tab'];
        $summary = $contributor['SummaryData'];
        $role = $groupedRow['NarContributorRole_tab'];
        // ⋯
    }
}

Virtual Columns

Virtual columns are columns that do not actually exist in the EMu table being accessed. Instead, the IMu server interprets the request for the column and builds an appropriate response. Certain virtual columns can only be used in certains modules as follows:

The following virtual columns can be used in any EMu module:

  • insertedTimeStamp

    Returns the insertion date and time of the record using the format YYY-MM-DDThh:mm:ss, for example "1999-12-31T23:59:59". This is similar to the ISO8601 date format except the time zone designator is not included.

  • modifiedTimeStamp

    Returns the modification date and time of the record using the format YYYY-MM-DDThh:mm:ss.

    $columns = array
(
    'insertedTimeStamp',
    'modifiedTimeStamp'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $inserted = $row['insertedTimeStamp'];
    $modified = $row['modifiedTimeStamp'];
    # ⋯
}

The following virtual columns can be used in any EMu module except Multimedia:

  • application

    Returns information about the preferred application multimedia attached to a record.

    NOTE:

    Currently the preferred multimedia is the same as the first entry in the list returned by the applications virtual column. However, future versions of EMu may allow other multimedia to be flagged as preferred, in which case the application column will return information for the preferred multimedia, rather than the first one.

  • applications

    Returns information about all of the application multimedia attached to a record.

  • audio

    Returns information about the preferred audio multimedia attached to a record.

  • audios

    Returns information about all of the audio multimedia attached to a record.

  • image

    Returns information about the preferred image multimedia attached to a record.

  • images

    Returns information about all of the image multimedia attached to a record.

  • multimedia

    Returns information about all of the multimedia attached to a record.

  • video

    Returns information about the preferred video multimedia attached to a record.

  • videos

    Returns information about all of the video multimedia attached to a record.

See Multimedia for more information.

The following virtual columns can only be used in the Multimedia module:

  • master

    Returns information about the master multimedia file.

  • resolutions

    Returns information about all multimedia resolutions.

  • resource

    Returns minimal information about the master multimedia file including an open file handle to a temporary copy of the multimedia file.

  • resource

    Returns minimal information about the master multimedia file including an open file handle to a temporary copy of the multimedia file.

  • resources

    The same as the resource virtual column except that information and file handles are supplied for all multimedia files.

  • supplementary

    Returns information about all supplementary multimedia files.

  • thumbnail

    Returns information about the multimedia thumbnail.

See Multimedia for more information.

The following virtual column can only be used in the Narratives module:

  • trails

    Returns information about the position of current Narratives record in the narratives hierarchy.

The following virtual column can only be used in the Collection Descriptions module:

  • extUrlFull_tab

Fetch Sets

A fetch set allows you to pre-register a group of columns by a single name. That name can then be passed to the fetch method to retrieve the specified columns.

Fetch sets are useful if the fetch method will be called several times with the same set of columns because:

  • The required columns do no have to be specified every time the fetch method is called. This is useful when maintaining state.

  • Every time the fetch method is called the IMu server must parse the supplied columns and check them against the EMu schema. For complex column sets, particularly those involving several references or reverse references, this can take time.

The IMuModule class addFetchSet method is used to register a set of columns. This method takes two arguments:

  • name

    The name to use for the column set. The value of this argument can be passed to any call to the fetch method and the set of columns specified by the columns argument will be returned.

  • columns

    The set of columns to be associated with the name argument.

The IMuModule class addFetchSets method is similar except that multiple sets can be registered at one time.

The results are returned as if you had supplied the columns directly to the fetch method.

For example:

  1. Add a single fetch set using the addFetchSet method:

    $columns = array
(
    'NamFirst',
    'NamLast',
    'NamRoles_tab'
);
$parties->addFetchSet('person_details', $columns);

  2. Add multiple fetch sets using the addFetchSets method:

    $sets = array
(
    'person_details' => array('NamFirst', 'NamLast', 'NamRoles_tab'),
    'organisation_details' =>
        array('NamOrganisation', 'NamOrganisationAcronym')
);
$module->addFetchSets($sets);

  3. Retrieve a fetch set using the fetch method:

    $result = $parties->fetch('start', 0, 1, 'person_details');
foreach ($result->rows as $row)
{
    $first = $row['NamFirst'];
    $last = $row['NamLast'];

    $roles = $row['NamRoles_tab'];
    foreach ($roles as $role)
    {
        // ⋯
    }
}

    WARNING:

    The fetch set name must be the only value passed as the fetch method columns argument. This may be revised in a future version of the IMu API.

Renaming columns

Columns can be renamed in the returned results by prefixing them with an alternative name:

first_name=NamFirst

The value of the specified column is now returned using the alternative name:

$columns = array
(
    'first_name=NamFirst'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $first = $row['first_name'];
    # ⋯
}

Alternative names can be supplied to other column specifications as well:

roles=NamRoles_tab

synonyms=SynSynonymyRef_tab.(NamFirst,NamLast)

objects=<ecatalogue:CreCreatorRef_tab>.(TitMainTitle,TitObjectCategory)

Alternative names can also be used for any columns specified between round brackets or square brackets:

SynSynonymyRef_tab.(first_name=NamFirst,last_name=NamLast)

contributors=[contributor=NarContributorRef_tab.SummaryData,role=NarContributorRole_tab]

Alternative names can also be supplied in fetch sets:

$columns = array
(
    'first_name=NamFirst',
    'last_name=NamLast',
    'roles=NamRoles_tab'
);
$parties->addFetchSet('person_details', $columns);

Example

In this example we build a simple PHP based web page to search the Parties module by last name and display the full set of results.

First build the search page, which is a plain HTML form:

<head>
  <title>Party Search</title>
</head>
<body>
  <form action="a-simple-example.php">
    <p>Enter a last name to search for (e.g. Smith):</p>
    <input type="text" name="name"/>
    <input type="submit" value="Search"/>
  </form>
</body>

Next build the results page, which runs the search and displays the results:

<?php
require_once dirname(__FILE__) . '/../../lib/IMu.php';
require_once IMu::$lib . '/Module.php';
require_once IMu::$lib . '/Session.php';
require_once IMu::$lib . '/Terms.php';

if (! isset($_GET['name']) || $_GET['name'] == '')
{
	header('HTTP/1.1 400 Bad Request');
	print("missing 'name' parameter\r\n");
	exit(1);
}
$name = $_GET['name'];

$terms = new IMuTerms();
$terms->add('NamLast', $name);

$session = new Session('imu.mel.kesoftware.com', 40136);
$module = new Module('eparties', $session);
$hits = $module->findTerms($terms);

$columns = array
(
	'NamFirst',
	'NamLast'
);
$results = $module->fetch('start', 0, -1, $columns);
?>
<!DOCTYPE html>
<html>
<head>
<title>IMu PHP API - A Simple Example</title>
</head>
<body>
<p>Number of matches: <?php echo $results->hits ?></p>
<table>
<?php
    /* Display each match in a separate row in a table */
    foreach ($results->rows as $row)
    {
?>
    <tr>
        <td><?php echo $row['rownum'] ?></td>
        <td><?php echo $row['NamFirst'], ' ', $row['NamLast'] ?></td>
    </tr>
<?php
    }
?>
</table>
</body>
</html>

In this example the name parameter entered via the HTML search page is submitted to the PHP script. The script searches for parties records that have the entered value as a last name and display the parties first and last names in an HTML table.

Multimedia

The IMu API provides a number of special mechanisms to handle access to the multimedia stored in the EMu DBMS. These machanisms fall into three rough categories:

  1. Mechanisms to select Multimedia module records that are attached to another module. This is covered in the Multimedia Attachments section.
  2. Mechanisms to select multimedia files from a Multimedia module record. This is covered in the Multimedia Files and Filters sections.
  3. Mechanisms to apply modifications to multimedia files. This is covered in the Modifiers section.

It is important to note that a single record in the EMu DBMS can have multiple Multimedia module records associated with it. Each Multimedia module record can have multiple multimedia files associated with it. The seperate mechanisms for handling multimedia access can be composed so that it is possible to, for example:

  • Select a specific Multimedia module record from a group of attached Multimedia module records.
  • Select a specific multimedia file from the selected Multimedia record.
  • Apply a modification to the selected multimedia file.

Multimedia Attachments

Information about the multimedia attached to an EMu record from any module (except the Multimedia module itself) can be retrieved using the IMuModule class fetch method by specifying one of the following virtual columns.

The following virtual columns return information about a single multimedia attachment of the current record. The information is returned as a associative array:

  • application
  • audio
  • image
  • video

The following virtual columns return information about a set of multimedia attachments of the current record. The information is returned as an array. Each array member is an associative array containing the information for a single multimedia attachment from the set:

  • applications
  • audios
  • images
  • multimedia
  • videos

All of these virtual columns return the irn, type and format of the Multimedia record attached to the current record. They also act as reference columns to the Multimedia module. This means that other columns from the Multimedia module (including virtual columns) can also be requested from the corresponding Multimedia record, for example:

  1. Include the title for all attached multimedia:

    multimedia.MulTitle

  2. Include the title for all attached images:

    images.MulTitle

  3. Include details about the master multimedia file for all attached images (using the virtual Multimedia module column master):

    images.master

  4. Include multiple columns for all attached images:

    images.(master,MulTitle,MulDescription)

  5. Include and rename multiple columns for all attached images:

    images.(master,title=MulTitle,description=MulDescription)

Example

This example shows the retrieval of the base information and the title for all multimedia images attached to a parties record:

$columns = array
(
    'images.MulTitle'
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    foreach ($row['images'] as $image)
    {
        $irn = $image['irn'];
        $type = $image['type'];
        $format = $image['format'];
        $title = $image['MulTitle'];

        printf("irn %d: %s - %s/%s\n", $irn, $title, $type, $format);
    }
}

This will produce output similar to the following:

irn 100105: Signature of Luciano Pavarotti - image/jpeg
irn 100096: Luciano Pavarotti - image/gif
irn 100100: Luciano Pavarotti with Celine Dion - image/gif
irn 100101: Luciano Pavarotti with Natalie Cole - image/gif
irn 100102: Luciano Pavarotti with the Spice Girls - image/gif

Multimedia Files

Similarly, information about the multimedia files associated with a Multimedia module record can be retrieved using the IMuModule class fetch method by specifying one of the following virtual columns.

The following virtual columns return information about a single multimedia file from the current Multimedia record. The information is returned as a associative array.

  • master
  • resource
  • thumbnail

The following virtual columns return information about a set of multimedia files of the current Multimedia record. The information is returned as an array. Each array member is a associative array containing the information for a single multimedia file from the set:

  • resolutions
  • resources
  • supplementary

The master, thumbnail, resolutions and supplementary virtual columns all return the same type of information. That information differs for image and non-image multimedia as follows:

For non-image multimedia they return:

  • fileSize

    The size of the file in bytes.

  • identifier

    The name of the multimedia file.

  • index

    An integer that specifies the multimedia files position in the list of the master, thumbnail, resolutions and supplementary (in that order) multimedia files numbered from 0.

  • kind

    The kind (master, thumbnail, resolution, or supplementary) of the multimedia.

  • md5Checksum

    The MD5 checksum of the multimedia file.

  • md5Sum

    The same as md5Checksum (included for backwards compatibility).

  • mimeFormat

    The media format.

  • mimeType

    The media type.

  • size

    The same as fileSize (included for backwards compatibility).

For image multimedia they return all of the values specified for non-image multimedia and also include:

  • bitsPerPixel

    The colour depth of the image.

  • colourSpace

    The colour space of the image.

  • compression

    The type of compression used on the image.

  • height

    The height of the image in pixels.

  • imageType

    The type classification of the image. For example:

    • Bilevel: Specifies a monochrome image.

    • ColorSeparation: Specifies a grayscale image.

    • Grayscale: Specifies a grayscale image.

    • GrayscaleMatte: Specifies a grayscale image with opacity.

    • Palette: Specifies a indexed color (palette) image.

    • PaletteMatte: Specifies a idexed color (palette) image with opacity.

    • TrueColor: Specifies a truecolor image.

    • TrueColorMatte: Specifies a truecolor image with opacity.

    Some more information can be found here

  • numberColours

    The number of colours in the image.

  • numberPages

    The number of images within the main image - a feature that is supported only in certain file types, e.g. TIFF.

  • planes

    The number of planes in an image.

  • quality

    An integer value from 1 to 100 that indicates the quality of the image. A lower value indicates a lower image quality and higher compression and a higher value indicates a higher image quality but a lower compression. Only applicable to JPEG and MPEG image formats.

  • resolution

    The resolution of the image in PPI.

  • width

    The width of the image in pixels.

The resource and resources virtual columns both return the same type of information as follows:

  • identifier

    The name of the multimedia file.

  • mimeType

    The media type.

  • mimeFormat

    The media format.

  • size

    The size of the file in bytes.

  • file

    A file handle. This provides a read-only handle to a temporary copy of the multimedia file. The temporary copy of the file is discarded when the handle is closed or destroyed.

NOTE:

If the resource column is specified with a filter, a modifier must also be provided in order for the file handle to be returned, eg:

'resources(height @ 200){resource:include}'

Modifier options include:

  1. resource:include - (will add the file handle to the data set returned)
  2. resource:only - (will replace the data set returned with the file handle)

  • height

    The height of the image in pixels.

  • width

    The width of the image in pixels.

Example

This example shows the retrieval of the multimedia title and resource information about all multimedia files for all multimedia images attached to a parties record:

$columns = array
(
    'images.(MulTitle,resources)',
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    foreach ($row['images'] as $image)
    {
        $irn = $image['irn'];
        $type = $image['type'];
        $format = $image['format'];
        $title = $image['MulTitle'];

        printf("irn %d: %s - %s/%s\n", $irn, $title, $type, $format);

        foreach ($image['resources'] as $resource)
        {
            $height = $resource['height'];
            $identifier = $resource['identifier'];
            $mimeFormat = $resource['mimeFormat'];
            $mimeType = $resource['mimeType'];
            $size = $resource['size'];
            $width = $resource['width'];

            printf("  %s: %s/%s - %dx%d - %d bytes\n", $identifier, $mimeType,
                $mimeFormat, $height, $width, $size);
        }
        print("\n");
    }
}

This will produce output similar to the following:

irn 100105: Signature of Luciano Pavarotti - image/jpeg
  signature.jpg: image/jpeg - 85x300 - 6535 bytes
  signature.thumb.jpg: image/jpeg - 25x90 - 1127 bytes

irn 100096: Luciano Pavarotti - image/gif
  LucianoPavarotti.gif: image/gif - 400x273 - 19931 bytes
  LucianoPavarotti.thumb.jpg: image/jpeg - 90x61 - 1354 bytes
  LucianoPavarotti.300x300.jpg: image/jpeg - 300x205 - 41287 bytes

irn 100100: Luciano Pavarotti with Celine Dion - image/gif
  PavarottiWithCelineDion.gif: image/gif - 400x381 - 66682 bytes
  PavarottiWithCelineDion.thumb.jpg: image/jpeg - 90x85 - 2393 bytes
  PavarottiWithCelineDion.300x300.jpg: image/jpeg - 300x286 - 76091 bytes

irn 100101: Luciano Pavarotti with Natalie Cole - image/gif
  PavarottiWithNatalieCole.gif: image/gif - 251x400 - 44551 bytes
  PavarottiWithNatalieCole.thumb.jpg: image/jpeg - 56x90 - 1768 bytes
  PavarottiWithNatalieCole.300x300.jpg: image/jpeg - 188x300 - 49698 bytes

irn 100102: Luciano Pavarotti with the Spice Girls - image/gif
  PavarottiWithSpiceGirls.gif: image/gif - 326x400 - 64703 bytes
  PavarottiWithSpiceGirls.thumb.jpg: image/jpeg - 73x90 - 2294 bytes
  PavarottiWithSpiceGirls.300x300.jpg: image/jpeg - 245x300 - 65370 bytes

The actual bytes of the multimedia file can be accessed using the file handle from the file value returned using the resource or resources virtual columns. We can use the file handle to copy the file from the IMu server:

$columns = array
(
    'image.resource',
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $image = $row['image'];
    $resource = $image['resource'];

    $name = $resource['identifier'];
    $temp = $resource['file'];

    $copy = fopen($name, 'wb');
    while (1)
    {
        $data = fread($temp, 4096); // read 4K at a time
        if ($data === false || strlen($data) == 0)
            break;
        fwrite($copy, $data);
    }
    fclose($copy);
}

This copies the multimedia file from the IMu server to a local file with the same name, in this case signature.jpg

Filters

While the Multimedia module virtual columns provide a reasonably fine-grained method for selecting specific multimedia files associated with a multimedia record, in some circumstances it is useful to have even more control over the selection of multimedia files, particularly when specifying the resolutions, resources or supplementary virtual columns.

Filters provide a mechanism to specify particular files associated with a multimedia record based on certain characteristics of the files. Filters consist of three parts; a name, a operator and a value. They are specified in round brackets after a virtual column:

column(name operator value);

Multiple values can be specified by separating each filter with a comma:

column(name operator value, name operator value);

  • name

    The filter name specifies the characteristic of the multimedia file to filter on. Unless noted otherwise the meaning of the filter names is as specified in Multimedia Files section.

    The following filter names can be used to filter any multimedia file:

    • fileSize (or size)
    • height
    • identifier
    • index
    • kind
    • mimeFormat (or format)
    • mimeType (or type)
    • width

    The following filter names can be used to filter multimedia image files:

    • bitsPerPixel
    • colourSpace
    • compression
    • imageType
    • md5Checksum (or md5sum)
    • numberColours
    • numberPages
    • planes
    • quality
    • resolution

    The following filter name can be used to filter supplementary multimedia files:

    • usage

      The value of the supplementary attributes usage (SupUsage_tab) column.

  • operator

    The operator specifies how the filter value should relate to the multimedia file characteristic specified by the filter name. The available values are:

    • ==

    Equals.

    Selects the multimedia files where the characteristic specified by the filter name is the same as the filter value.

    • !=

    Not equals.

    Selects the multimedia files where the characteristic specified by the filter name is not the same as the filter value.

    • <

    Less than.

    Selects the multimedia files where the characteristic specified by the filter name is less than the filter value. Only applies to numeric values.

    • >

    Greater than.

    Selects the multimedia files where the characteristic specified by the filter name is greater than the filter value. Only applies to numeric values.

    • <=

    Less than or equal to.

    Selects the multimedia files where the characteristic specified by the filter name is less that or equal to the filter value. Only applies to numeric values.

    • >=

    Greater than or equal to.

    Selects the multimedia files where the characteristic specified by the filter name is greater that or equal to the filter value. Only applies to numeric values.

    • @

    Closest to (also called best fit).

    Selects the single multimedia file where the characteristic specified by the filter name is closest to the filter value. Only applies to numeric values.

    • ^

    Closest to but greater than.

    Selects the single multimedia file where the characteristic specified by the filter name is closest to but greater than the filter value. Only applies to numeric values.

  • value

    The value to filter by. Any value can be used but, obviously, only certain values make sense for each filter. For example, if the fileSize filter is being used then only a numeric value is useful. Similarly, if the mimeType filter is being used then only a text value that corresponds to a valid MIME type is useful.

For example:

  1. Select multimedia resolutions with a width greater that 300 pixels:
resolutions(width > 300)
  1. Select the single multimedia resource with a width closest to 600:
resources(width @ 600)
  1. Select the thumbnail resource:
resources(kind == thumbnail)
  1. Specify multiple filters to select the single multimedia resource with a width and height closest to 600:
resources(width @ 600, height @ 600)

Example

This example shows the retrieval of the multimedia title and resource information about the single multimedia file with a width closest to 300 for all multimedia images attached to a parties record:

$columns = array
(
    'images.(MulTitle,resources(width @ 300))',
);
$result = $parties->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    foreach ($row['images'] as $image)
    {
        $irn = $image['irn'];
        $type = $image['type'];
        $format = $image['format'];
        $title = $image['MulTitle'];

        printf("irn %d: %s - %s/%s\n", $irn, $title, $type, $format);

        foreach ($image['resources'] as $resource)
        {
            $height = $resource['height'];
            $identifier = $resource['identifier'];
            $mimeFormat = $resource['mimeFormat'];
            $mimeType = $resource['mimeType'];
            $size = $resource['size'];
            $width = $resource['width'];

            printf("  %s: %s/%s - %dx%d - %d bytes\n", $identifier, $mimeType,
                $mimeFormat, $height, $width, $size);
        }
        print("\n");
    }
}

NOTE:

The only difference from the previous example is the inclusion of a filter on the resources Multimedia virtual column.

This will produce output similar to the following:

irn 100105: Signature of Luciano Pavarotti - image/jpeg
  signature.jpg: image/jpeg - 85x300 - 6535 bytes

irn 100096: Luciano Pavarotti - image/gif
  LucianoPavarotti.gif: image/gif - 400x273 - 19931 bytes

irn 100100: Luciano Pavarotti with Celine Dion - image/gif
  PavarottiWithCelineDion.300x300.jpg: image/jpeg - 300x286 - 76091 bytes

irn 100101: Luciano Pavarotti with Natalie Cole - image/gif
  PavarottiWithNatalieCole.300x300.jpg: image/jpeg - 188x300 - 49698 bytes

irn 100102: Luciano Pavarotti with the Spice Girls - image/gif
  PavarottiWithSpiceGirls.300x300.jpg: image/jpeg - 245x300 - 65370 bytes

Modifiers

While the IMu API provides a number of ways to select particular multimedia files from a Multimedia record sometimes none of the available files fulfill the required characteristics. Sometimes it is necessary to modify an existing multimedia file to achieve the desired result.

Modifiers provide a mechanism to convert multimedia images returned by the IMu server in a number of ways. The modifications are performed on-the-fly and do not affect the multimedia stored in the Multimedia database; they only apply to the temporary copy of multimedia returned by the IMU API. Modifiers consist of two parts; a name and a value seperated by a colon. They are specified in braces (curly brackets) after a resource or resources virtual column:

column{name:value}

Multiple values can be specified by seperating each filter with a comma:

column(…){name:value}

The supported values for name are:

  • checksum

    Include a checksum value with the resource (or resources) virtual column response. While this does not actually apply any modifications to a multimedia file it is useful when you require a checksum for multimedia that has had a modifier applied to it (cf. original multimedia).

    The allowed value parts are:

    • crc32

    Include a CRC32 checksum.

    • md5

    Include a MD5 checksum.

    When the checksum modifier is used the resource (or resources) virtual column response includes a checksum component.

  • format

    Specifies that the multimedia file should be converted to the specified format. If the multimedia is not already in the required format it is reformatted on-the-fly.

    The IMu server uses ImageMagick to process the image and the range of supported formats is very large. The complete list is available from: http://www.imagemagick.org/script/formats.php. Any of the supported formats can be used as the value part of this modifier.

  • resource

    Specifies that a multimedia file handle should be returned.

    The allowed value parts are:

    • include
    • only

  • height

    Specifies that the multimedia image file should be converted to the specified height (in pixels). If the Multimedia record contains a resolution with this height, this resolution is returned instead (i.e. no modification is applied). Otherwise the closest matching larger resolution is resized to the requested height on-the-fly.

    The allowed value parts are any numeric value specifying the height in pixels.

  • width

    Specifies that the multimedia image file should be converted to the specified width (in pixels). If the Multimedia record contains a resolution with this width, this resolution is returned instead (i.e. no modification is applied). Otherwise the closest matching larger resolution is resized to the requested width on-the-fly.

    The allowed value parts are any numeric value specifying the width in pixels.

  • aspectratio

    Controls whether the image’s aspect ratio should be maintained when both a height and a width modifier are specified. If set to no, the aspect ratio is not maintained. by default the aspect ratio is maintained.

    The allowed value parts are:

    • yes
    • no

NOTE:

Modifiers currently only apply to multimedia images and can only be specified after the Multimedia virtual resource or resources columns.

Only the resource or resources parts of the returned results are affected by modifiers. By design, all other response parts include the information for the original, unmodified multimedia.

For example:

  1. Specify a Base64 encoding modifier:
resource{encoding:base64}
  1. Include a CRC32 checksum in the response:
resource{checksum:crc32}
  1. Reformat the multimedia image to the gif format:
resource{format:gif}
  1. Resize the multimedia image to a height of 300 pixels:
resource{height:300}
  1. Resize the multimedia image to a width of 300 pixels:
resource{width:300}
  1. Resize the multimedia image to a height & width of 300 pixels and do not maintain aspect ratio:
resource{height:300, width:300, aspectratio:no}

Performance Issues

Modifying a multimedia file is computationally expensive, it should only be used when absolutely necessary. For example, it is better to use the filtering mechanism to select multimedia image files of the desired dimensions rather than modifying them to fit:

Good:

resource(height @ 300, width @ 300)

Not so good:

resource{height:300, width:300)

Obviously this only works if you have image file resolutions that are close to the desired dimensions.

Modifying a multimedia image file that is closer to the desired dimensions is less computationally expensive than modifying a larger image, so selecting the appropriate image prior to modification is preferable:

Good:

resource(height ^ 299, width ^ 299){height:300, width:300}

Not so good:

resource{height:300, width:300}

Example

This example shows the retrieval of the multimedia title and setting a format, width & height modifier to the resource information for the master multimedia image attached to a narratives record:

$columns = array
(
    'image.(MulTitle, resource{format:jpeg, height:600, width:600, checksum:md5})',
);
$result = $narratives->fetch('start', 0, 1, $columns);
foreach ($result->rows as $row)
{
    $image = $row['image'];
    $irn = $image['irn'];
    $type = $image['type'];
    $format = $image['format'];
    $title = $image['MulTitle'];

    printf("irn %d: %s - %s/%s\n", $irn, $title, $type, $format);

    $resource = $image['resource'];
    $height = $resource['height'];
    $identifier = $resource['identifier'];
    $mimeFormat = $resource['mimeFormat'];
    $mimeType = $resource['mimeType'];
    $size = $resource['size'];
    $width = $resource['width'];
    $checksum = $resource['checksum'];

    printf("  %s: %s/%s - %dx%d - %d bytes - %s\n", $identifier, $mimeType,
        $mimeFormat, $height, $width, $size, $checksum);
}

This will produce output similar to the following:

irn 165: Angus Young, AC/DC Jacket - image/tiff
  00033320.jpeg: image/jpeg - 599x401 - 77396 bytes - d94a9f46bd6274bcd20154bc513cf61f

The bytes of the modified multimedia can be accessed in the usual way via the resource response file value.

NOTE:

  • Only the resource response part has been affected by the modifier. The image response part still reports the format as tiff. This is by design.

  • Because the aspect ratio has been maintained the image does not have the exact height and width specified.

Maintaining State

One of the biggest drawbacks of the earlier example is that it fetches the full set of results at one time, which is impractical for large result sets. It is more practical to display a full set of results across multiple pages and allow the user to move forward or backward through the pages.

This is simple in a conventional application where a connection to the separate server is maintained until the user terminates the application. In a web implementation however, this seemingly simple requirement involves a considerably higher level of complexity due to the stateless nature of web pages. One such complexity is that each time a new page of results is displayed, the initial search for the records must be re-executed. This is inconvenient for the web programmer and potentially slow for the user.

The IMu server provides a solution to this. When a handler object is created, a corresponding object is created on the server to service the handler’s request: this server-side object is allocated a unique identifier by the IMu server. When making a request for more information, the unique identifier can be used to connect a new handler to the same server-side object, with its state intact.

The following example illustrates the connection of a second, independently created IMuModule object to the same server-side object:

// Create a module object as usual
$first = new Module('eparties', $session);

// Run a search - this will create a server-side object
$keys = array(1, 2, 3, 4, 5, 42);
$first->findKeys($keys);

// Get a set of results
$result1 = $first->fetch('start', 0, 2, 'SummaryData');

// Create a second module object
$second = new Module('eparties', $session);

/*
 * Attach it to the same server-side object as the first module. This is
 * the key step.
 */
$second->id = $first->id;

// Get a second set of results from the same search
$result2 = $second->fetch('current', 1, 2, 'SummaryData');

Although two completely separate IMuModule objects have been created, they are each connected to the same server-side object by virtue of having the same id property. This means that the second fetch call will access the same result set as the first fetch. Notice that a flag of current has been passed to the second call. The current state is maintained on the server-side object, so in this case the second call to fetch will return the third and fourth records in the result set.

While this example illustrates the use of the id property, it is not particularly realistic as it is unlikely that two distinct objects which refer to the same server-side object would be required in the same piece of code. The need to re-connect to the same server-side object when generating another page of results is far more likely. This situation involves creating a server-side IMuModule object (to search the module and deliver the first set of results) in one request and then re-connecting to the same server-side object (to fetch a second set of results) in a second request. As before, this is achieved by assigning the same identifier to the id property of the object in the second page, but two other things need to be considered.

By default the IMu server destroys all server-side objects when a session finishes. This means that unless the server is explicitly instructed not to do so, the server-side object may be destroyed when the connection from the first page is closed. Telling the server to maintain the server-side object only requires that the destroy property on the object is set to false before calling any of its methods. In the example above, the server would be instructed not to destroy the object as follows:

$module = new Module('eparties', $session);
$module->setDestroy(false);
$keys = array(1, 2, 3, 4, 5, 42);
$module->findKeys($keys);

The second point is quite subtle. When a connection is established to a server, it is necessary to specify the port to connect to. Depending on how the server has been configured, there may be more than one server process listening for connections on this port. Your program has no control over which of these processes will actually accept the connection and handle requests. Normally this makes no difference, but when trying to maintain state by re-connecting to a pre-existing server-side object, it is a problem.

For example, suppose there are three separate server processes listening for connections. When the first request is executed it connects, effectively at random, to the first process. This process responds to the request, creates a server-side object, searches the Parties module for the terms provided and returns the first set of results. The server is told not to destroy the object and passes the server-side identifier to another page which fetches the next set of results from the same search.

The problem comes when the next page connects to the server again. When the connection is established any one of the three server processes may accept the connection. However, only the first process is maintaining the relevant server-side object. If the second or third process accepts the connection, the object will not be found.

The solution to this problem is relatively straightforward. Before the first request closes the connection to its server, it must notify the server that subsequent requests need to connect explicitly to that process. This is achieved by setting the IMuSession object’s suspend property to true prior to submitting any request to the server:

$session = new Session('server.com', 12345);
$module = new Module('eparties', $session);
$session->setSuspend(true);
$module->findKeys($keys);

The server handles a request to suspend a connection by starting to listen for connections on a second port. Unlike the primary port, this port is guaranteed to be used only by that particular server process. This means that a subsequent page can reconnect to a server on this second port and be guaranteed of connecting to the same server process. This in turn means that any saved server-side object will be accessible via its identifier. After the request has returned (in this example it was a call to findKeys), the IMuSession object’s port property holds the port number to reconnect to:

$session->setSuspend(true);
$module->findKeys($keys);
$reconnect = $session->port;

Example

To illustrate we’ll modify the very simple results page of the earlier section to display the list of matching names in blocks of five records per page. We’ll provide simple Next and Prev links to allow the user to move through the results, and we will use some more GET parameters to pass the port we want to reconnect to, the identifier of the server-side object and the rownum of the first record to be displayed.

First build the search page, which is a plain HTML form:

<head>
  <title>Party Search</title>
</head>
<body>
  <form action="example.php">
    <p>Enter a last name to search for (e.g. S*):</p>
    <input type="text" name="name"/>
    <input type="submit" value="Search"/>
  </form>
</body>

Next build the results page, which runs the search and displays the results. The steps to build the search page are outlined in detail below.

  1. Create an IMuSession object. Then the port property is set to a standard value unless a port parameter has been passed in the URL.

    /*
* Create new session object.
*/
$session = new Session();
$session->setHost('imu.mel.kesoftware.com');

/* 
* Work out what port to connect to
*/
$port = 40136;
if (isset($_GET['port']))
    $port = $_GET['port'];
$session->setPort($port);

  2. Connect to the server and immediately set the suspend property to true to tell the server that we may want to connect again:

    /*
* Establish connection and tell the server we may want to re-connect
*/
$session->connect();
$session->setSuspend(1);

    This ensures the server listens on a new, unique port.

  3. Create the client-side IMuModule object and set its destroy property to false:

    /* 
* Create module object and tell the server not to destroy it.
*/
$module = new Module('eparties', $session);
$module->setDestroy(false);

    This ensures that the server will not destroy the corresponding server-side object when the session ends.

  4. If the URL included a name parameter, we need to do a new search. Alternatively, if it included an id parameter, we need to connect to an existing server-side object:

    /* If name is supplied, do new search. The search term is passed from
** search.html using GET
*/
if (isset($_GET['name']))
{
    $terms = new IMuTerms();
    $terms->add('NamLast', $_GET['name']);
    $module->findTerms($terms);
}
/* 
* Otherwise, if id is supplied reattach to existing server-side object
*/
else if (isset($_GET['id']))
{
    $module->id = $_GET['id'];
}
/*
* Otherwise, we can't process
*/
else
{
    header('HTTP/1.1 400 Bad Request');
    print("missing 'name' or 'id' parameter\r\n");
    exit(1);
}

  5. Build a list of columns to fetch:

    $columns = array
(
    'NamFirst',
    'NamLast'
);

  6. If the URL included a rownum parameter, fetch records starting from there. Otherwise start from record number 1:

    /*
* Work out which block of records to fetch
*/
$rownum = 1;
if (isset($_GET['rownum']))
    $rownum = $_GET['rownum'];

  7. Build the main page:

    /*
* Fetch next five records
*/
$results = $module->fetch('start', $rownum - 1, 5, $columns);
$hits = $results->hits;

/*
* Build the results page
*/
?>
<!DOCTYPE html>
<html>
<head>
<title>IMu PHP API - Maintaining State</title>
</head>
<body>
<p>Number of matches: <?php echo $hits ?></p>
<table>
<?php
// Display each match in a separate row in a table
foreach ($results->rows as $row)
{
?>
    <tr>
        <td><?php echo $row['rownum'] ?></td>
        <td><?php echo $row['NamFirst'], ' ', $row['NamLast'] ?></td>
    </tr>
<?php
}
?>
</table>
<?php

  8. Finally, add the Prev and Next links to allow the user to page backwards and forwards through the results. This is the most complicated part! First, to ensure that a connection is made to the same server and server-side object, add the appropriate port and id parameters to the link URL:

    /*
* Add the Prev and Next links
*/
$url = $_SERVER['PHP_SELF'];
$url .= '?port=' . $session->port;
$url .= '&id=' . $module->id;

  9. If the first record is not showing add a Prev link to allow the user to go back one page in the result set. Similarly, if the last record is not showing add a Next link to allow the user to go forward one page:

    $first = $results->rows[0];
if ($first['rownum'] > 1)
{
    $prev = $first['rownum'] - 5;
    if ($prev < 1)
        $prev = 1;
    $prev = $url . '&rownum=' . $prev;
?>
<a href="<?php echo $prev ?>">Prev</a>
<?php
}

$last = $results->rows[count($results->rows) - 1];
if ($last['rownum'] < $results->hits)
{
    $next = $last['rownum'] + 1;
    $next = $url . '&rownum=' . $next;
?>
<a href="<?php echo $next ?>">Next</a>
<?php
}
?>
</body>
</html>

Logging in to an IMu server

When an IMu based program connects to an IMu server it is given a default level of access to EMu modules.

It is possible for an IMu based program to override this level of access by explicitly logging in to the server as a registered user of EMu. This is done by using the IMuSession‘s login method. Once the login method has been called successfully the session remains authenticated until the logout method is called.

The login method

The login method is used to authenticate the program as a registered user of EMu. Once successfully authenticated access to EMu modules is at the level of the authenticated user rather than the default imuserver user.

Arguments

  • username

    The name of the user to login as. This must be the name of a registered EMu user on the system.

  • password

    The user’s password. This argument is optional and if it is not supplied it defaults to null.

    NOTE:

    Supplying a null password is uncommon but it is sometimes a valid thing to do. If the server receives a password of null it will try to authenticate the user using server-side methods such as verification against emu’s .rhosts file.

  • spawn

    A boolean value indicating whether the IMu server should create a separate process dedicated to handling this program’s requests. This argument is optional and if not supplied it defaults to true.

The logout method

The logout method relinquishes access as the previously authenticated user.

NOTE:

Logging in this way is very similar to logging into the same EMu environment using the EMu client. Access to records is controlled via record-level security.

WARNING:

Logging in causes the IMu server to start a new texserver process to handle all access to EMu module. This new texserver process will use a Texpress licence. The licence will not be freed until the logout method is called. See the server FAQ How does IMu use Texpress licences? for more information.

Updating an EMu Module

The IMuModule class provides methods for inserting new records and for updating or removing existing records in any EMu module.

NOTE:

By default these operations are restricted by the IMu server. Typically access to these operations is gained by logging in to the IMu server. See the allow-updates entry of the server configuration for more information.

The insert Method

The insert method is used to add a new record to the module.

Arguments

The method takes two arguments:

  • values

    The values argument specifes any data values to be inserted into the newly created record.

    The data values should be an associative array. The indexes of the array must be column names.

  • columns

    The columns argument is used to specify which columns should be returned once the record has been created. The value of the column is specified in exactly the same way as in the fetch method. See the section on Specifying Columns for details.

    NOTE:

    It is very common to include irn as one of the columns to be returned. This gives a way of getting the key of the newly created record.

Return Value

The method returns an associative array. This associative array contains an entry for each column requested. This is identical to the associative array returned for each row as part of the fetch method.

Example

$parties = new Module('eparties', $session);

/* Specify the values to insert.
*/
$values = array
(
    'NamFirst' => 'Chris',
    'NamLast' => 'Froome',
    'NamOtherNames_tab' => array
    (
        'Christopher',
        'Froomey'
    )
);

/* Specify the column values to return after inserting.
*/
$columns = array
(
    'irn',
    'NamFirst',
    'NamLast',
    'NamOtherNames_tab'
);

/* Insert the new record.
*/
try
{
    $result = $parties->insert($values, $columns);
}
catch (Exception $e)
{
    print("Error: $e\n");
    exit(1);
}

/* Output the returned values.
*/
$irn = $result['irn'];
$first = $result['NamFirst'];
$last = $result['NamLast'];
$others = $result['NamOtherNames_tab'];

printf("%s, %s (%d)\n", $last, $first, $irn);
print("Other names:\n");
foreach ($others as $other)
{
    print("\t$other\n");
}
exit(0);

If inserting of records is permitted this will produce output similar to the following:

Froome, Chris (435)
Other names:
	Christopher
	Froomey

If inserting of records is denied by the server this will produce output similar to the following:

Error: ModuleUpdatesNotAllowed (authenticated,default) [500]

The update Method

The update method is used to modify one or more existing records. This method operates very similarly to the fetch method. The only difference is a values argument which contains a set of values to be applied to each specified record.

Arguments

The method takes five arguments:

  • flag

  • offset

  • count

    These arguments are identical to those used by the fetch method. They define the starting position and size of the block of records to be updated.

  • values

    The values argument specifies the columns to be updated in the specified block of records. The values argument must be a hash reference. The keys of the hash must be column names.

    This is the same as the values argument for the insert method.

  • columns

    The columns argument is used to specify which columns should be returned once the record has been created. The value of the column is specified in exactly the same way as in the fetch method. See the section on Specifying Columns for details.

    This is the same as the columns argument for the insert method.

Return Value

The update method returns an IMuModuleFetchResult object (the same as the fetch method). It contains the values for the selected block of records after the updates have been applied.

Example

/* Find all parties records that have a first name of "Chris" and a last name
** of "Froome".
*/
$parties = new Module('eparties', $session);
$terms = new IMuTerms();
$terms->add('NamFirst', 'Chris');
$terms->add('NamLast', 'Froome');
$parties->findTerms($terms);

/* Specify the column to update and the new value.
*/
$values = array
(
    'NamFirst' => 'Christopher',
);

/* Specify the column values to return after updating.
*/
$columns = array
(
    'irn',
    'NamFirst',
    'NamLast'
);

/* Run the update.
*/
try
{
    $result = $parties->update('start', 0, -1, $values, $columns);
}
catch (Exception $e)
{
    print("Error: $e\n");
    exit(1);
}

/* Output the returned values.
*/
print("Count: $result->count\n");
print("Hits: $result->hits\n");
print("Rows:\n");
foreach ($result->rows as $row)
{
    $rowNum = $row['rownum'];
    $irn = $row['irn'];
    $first = $row['NamFirst'];
    $last = $row['NamLast'];

    printf("\t%d. %s, %s (%d)\n", $rowNum, $last, $first, $irn);
}
exit(0);

If updating records is allowed the example will produce output similar to the following:

Count: 1
Hits: 1
Rows:
	1. Froome, Christopher (435)

The remove Method

The remove method is used to remove one or more existing records.

Arguments

The method takes three arguments:

  • flag

  • offset

  • count

    These arguments define the starting position and size of the block of records to be removed. They are identical to those used by the fetch and update methods.

Return Value

The method returns an integer that specifies the number of records that were removed.

Example

/* Find all parties records that have a first name of "Christopher" and a last
** name of "Froome".
*/
$parties = new Module('eparties', $session);
$terms = new IMuTerms();
$terms->add('NamFirst', 'Christopher');
$terms->add('NamLast', 'Froome');
$parties->findTerms($terms);

/* Remove all of the matching records.
*/
try
{
    $result = $parties->remove('start', 0, -1);
}
catch (Exception $e)
{
    print("Error: $e\n");
    exit(1);
}
print("Removed $result record(s)\n");
exit(0);

If removing records is allowed the example will produce output similar to the following:

Removed 1 record(s)

Exceptions

When an error occurs, the IMu PHP API throws an exception. The exception is an IMuException object. This is a subclass of PHP‘s standard Exception class.

For simple error handling all that is usually required is to catch the exception and report the exception as a string:

try
{
    // ⋯
}
catch (Exception $e)
{
    echo "Error: $e";
    exit(1);
}

The IMuException class overrides the Exception classes __toString method (which is called “magically” when the object is used as a string) and returns an error message.

To handle specific IMu errors it is necessary to check the exception is an IMuException object before using it. The IMuException class includes a property called id. This is a string and contains the internal IMu error code for the exception. For example, you may want to catch the exception raised when an Session objects connect method fails and try to connect to an alternative server:

$mainServer = 'server1.com';
$alternativeServer = 'server2.com';
$session = new Session;
$session->host = $mainServer;
try
{
    $session->connect();
}
catch (IMuException $e)
{
    // Check for specific SessionConnect error
    if ($e->id != 'SessionConnect')
    {
        echo "Error: $e";
        exit(1);
    }
    $session->host = $alternativeServer;
    try
    {
        $session->connect();
    }
    catch (Exception $e)
    {
        echo "Error: $e";
        exit(1);
    }
}
/*
 * By the time we get to here the session is connected to either the main
 * server or the alternative.
 */