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

file listing

  1. <?php
  2. /**
  3.  * This file contains the Devices class.
  4.  *
  5.  * @package ModuleWriting
  6.  */
  7. /**
  8.  * The Devices class holds a list of all devices the CAT knows about
  9.  * 
  10.  * @author Tomasz Wolniewicz <twoln@umk.pl>
  11.  * 
  12.  * @license http://ticker.eduroam.lu/cat/LICENSE
  13.  * 
  14.  * @package ModuleWriting
  15.  */
  16. class Devices{
  17.  
  18. /**
  19.  * Each device is defined as a three-element array within this array
  20.  *
  21.  * - 'display' is the name shown on the GUI button
  22.  * - 'directory' is the subdirectory of devices directory, where the device module resides
  23.  * - '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
  24.  * - 'sign' if defined points to an external program which will sign a file. The first argument of this program must be the
  25.  * input file name, the second - the signed file filename.
  26.  *
  27.  * @example devices/devices.php file listing
  28.  * @return array the device modules
  29.  */
  30. public static function listDevices({
  31.     return array(
  32.  'vista'=>array(
  33.    'display'=>_("MS Windows Vista and newer"),
  34.    'directory'=>'ms_vista_plus',
  35.    'module'=>'Vista7',
  36.    'sign'=>'/opt/local/GN3/CAT/ms_windows_sign'
  37.    ),
  38.     
  39.  'mobileconfig'=>array(
  40.     'display'=>_("Apple mobile devices and Mac OS X Lion"),
  41.     'directory'=>'apple_mobileconfig',
  42.     'module'=>'mobileconfig',
  43.     'sign'=>'/opt/local/GN3/CAT/mobileconfig_sign'
  44.     ),
  45.  
  46.  'welcomeletter'=>array(
  47.     'display'=>_("Welcome Letter"),
  48.     'directory'=>'welcomeletter',
  49.     'module'=>'welcomeletter'
  50.    ),
  51.     
  52.  'test'=>array(
  53.     'display'=>_("Test"),
  54.     'directory'=>'test_module',
  55.     'module'=>'TestModule'
  56.    ),
  57. );
  58. }
  59. }
  60. ?>

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