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

Class: Device_RedirectDev

Source Location: /devices/redirect_dev/RedirectDev.php

Class Device_RedirectDev

Class Overview

This class defines the API for CAT module writers.

A device is a fairly abstract notion. In most cases it represents a particular operating system or a set of operationg systems like MS Windows Vista and newer.

The purpose of this class is to preapare a setup for the device configurator, collect all necessary information from the database, taking into account limitations, that a given device may present (like a set of supported EAP methods).

All that is required from the device module is to produce a conigurator file and pass its name back to the API.

Located in /devices/redirect_dev/RedirectDev.php [line 4]

DeviceConfig
   |
   --Device_RedirectDev
Author(s): Information Tags:

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From DeviceConfig

DeviceConfig::$attributes
DeviceConfig::$device_id
DeviceConfig::$FPATH
DeviceConfig::$installerBasename
DeviceConfig::$lang_index
DeviceConfig::$module_path
DeviceConfig::$options
DeviceConfig::$selected_eap
DeviceConfig::$sign
DeviceConfig::$signer
DeviceConfig::$specialities
DeviceConfig::$support_email_substitute
DeviceConfig::$support_url_substitute

Inherited From DeviceConfig

DeviceConfig::__construct()
device module constructor should be defined by each module, but if it is not, then here is a default one
DeviceConfig::copyFile()
Copy a file from the module location to the temporary directory.
DeviceConfig::dumpAttibutes()
dumps attributes for debugging purposes
DeviceConfig::getPreferredEapType()
Selects the preferred eap method based on profile EAP configuration and device EAP capabilities
DeviceConfig::saveCertificateFiles()
Save certificate files in either DER or PEM format
DeviceConfig::setup()
Set up working environment for a device module
DeviceConfig::translateFile()
Copy a file from the module location to the temporary directory aplying translation.
DeviceConfig::translateString()
DeviceConfig::writeDeviceInfo()
prepare usage information for the installer every device module should override this method
DeviceConfig::writeInstaller()
placeholder for the main device method

[ Top ]
Method Summary
Device_RedirectDev   __construct()   Constructs a Device object.
void   writeDeviceInfo()  

[ Top ]
Methods
Constructor __construct  [line 16]

  Device_RedirectDev __construct( string $device  )

Constructs a Device object.

It is CRUTCIAL that the constructor sets $this->supportedEapMethods to an array of methods available for the particular device.

  1. function __construct({
  2.       $this->supportedEapMethods  array(EAP::$EAP_NONE);
  3.       debug(4,"RedirectEx called");
  4.     }

Parameters:
string   $device:  a pointer to a device module, which must be an index of one of the devices defined in the Devices array in devices.php.

API Tags:
Access:  public

Information Tags:
Final:  not to be redefined

Redefinition of:
DeviceConfig::__construct()
device module constructor should be defined by each module, but if it is not, then here is a default one

[ Top ]
writeDeviceInfo  [line 20]

  void writeDeviceInfo( )


API Tags:
Access:  public


Redefinition of:
DeviceConfig::writeDeviceInfo()
prepare usage information for the installer every device module should override this method

[ Top ]

Documentation generated on Thu, 16 Apr 2015 10:26:08 +0000 by phpDocumentor 1.4.4