phpDocumentor ModuleWriting
[ class tree: ModuleWriting ] [ index: ModuleWriting ] [ all elements ]

Class: Devices

Source Location: /devices/devices.php

Class Devices

Class Overview

The Devices class holds a list of all devices the CAT knows about

Located in /devices/devices.php [line 16]



		
				Author(s):
		
		
		
Information Tags:
License:  http://ticker.eduroam.lu/cat/LICENSE

Methods

[ Top ]
Method Summary
static array   listDevices()   Each device is defined as a three-element array within this array

[ Top ]
Methods
static method listDevices  [line 30]

  static array listDevices( )

Each device is defined as a three-element array within this array

  • 'display' is the name shown on the GUI button
  • 'directory' is the subdirectory of devices directory, where the device module resides
  • 'module' is the name of the module class, the same name with .php added will be used as the name of the main include file for the module
  • 'sign' if defined points to an external program which will sign a file. The first argument of this program must be the
input file name, the second - the signed file filename.


API Tags:
Return:  the device modules
Access:  public
Example:  file listing


[ Top ]

Documentation generated on Fri, 05 Aug 2011 15:56:30 +0200 by phpDocumentor 1.4.3