Docs For Class ApplicationRepositoryEntry

Description

An entry of an application repository

This class parses "appinfo.xml" files that contain meta data which can be used to present a list of applications to the user in a nice way.

Located in /phpsatk-lib/global/org.eenterphace.sat.app.repository/application.repository.entry.php (line 36)

Variable Summary

string $description

string $displayname

string $icon_href

int $menuprecedence

string $name

string $path

array[array[string=>string]] $quicklinks

Method Summary

ApplicationRepositoryEntry __construct (string $path)

Variables

string $description (line 80)

A description what the application does

The content of a <description> block. Plain text please.

access: public

string $displayname (line 61)

The application's title

The content of a <display> block.

access: public

string $icon_href (line 71)

A URL to a icon presenting this application

Applications can provide their icons in "<sat-local>/files/<app>/appicon.png" if no icon is present the default icon will be chosen.

access: public

int $menuprecedence = 50 (line 110)

Controlls where the application show be shown in a application menu

The value will be read from a <menuprecedence> node. A higher value will mean that the application will be shown earlier. Default is 50.

access: public

string $name (line 52)

The application's name

This name is the short (directory name) of the application

access: public

string $path (line 43)

Path to the application

access: public

array[array[string=>string]] $quicklinks = array() (line 100)

An array of quicklinks to common actions a user might want to choose

The array contains associative arrays of 'path' - the path to refer to - and 'caption' - a descriptive title for this link.

These links are gathered from a <quicklinks> block which may contain multiple <link> elements, where an attribute 'path' provides the path and the node's content will be the title.

     <quicklinks>
   <link path="/foo/bar">Do something here</link>
  </quicklinks>

access: public

Methods

Constructor __construct (line 122)

Parses the appinfo.xml file for a given application

If the given application does not provide an appinfo.xml file the default values will be used and the displayname set to the short-name of the application.

access: public

ApplicationRepositoryEntry __construct (string $path)

string $path: Path to the application