phpDocumentor ModuleWriting
[ class tree: ModuleWriting ] [ index: ModuleWriting ] [ all elements ]
ModuleWriting
Packages:
Developer
Configuration
ModuleWriting

Tutorials/Manuals:
Package-level: Files:
DeviceConfig.php
devices-template.php
Linux.php
TestModule.php
Vista7.php
W8.php
WindowsCommon.php

Classes:
DeviceConfig
Devices
Device_Linux
Device_TestModule
Device_Vista7
Device_W8
WindowsCommon

Element index for package ModuleWriting

Package indexes

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ o ] [ p ] [ s ] [ t ] [ v ] [ w ] [ _ ]

_

_

__construct
in file W8.php, method Device_W8::__construct()
__construct
in file Vista7.php, method Device_Vista7::__construct()
__construct
in file TestModule.php, method Device_TestModule::__construct()
    Constructs a Device object.
__construct
in file Linux.php, method Device_Linux::__construct()
__construct
in file DeviceConfig.php, method DeviceConfig::__construct()
    device module constructor should be defined by each module, but if it is not, then here is a default one
a

a

$attributes
in file DeviceConfig.php, variable DeviceConfig::$attributes
    Array passing all options to the device module.
c

c

$code_page
in file WindowsCommon.php, variable WindowsCommon::$code_page
combineLogo
in file WindowsCommon.php, method WindowsCommon::combineLogo()
compileNSIS
in file WindowsCommon.php, method WindowsCommon::compileNSIS()
copyFile
in file DeviceConfig.php, method DeviceConfig::copyFile()
    Copy a file from the module location to the temporary directory.
d

d

$device_id
in file DeviceConfig.php, variable DeviceConfig::$device_id
    The string identifier of the device (don't show this to users)
DeviceConfig.php
procedural page DeviceConfig.php
DeviceConfig
in file DeviceConfig.php, class DeviceConfig
    This class defines the API for CAT module writers.
Devices
in file devices-template.php, class Devices
    The Devices class holds a list of all devices the CAT knows about
devices-template.php
procedural page devices-template.php
Device_Linux
in file Linux.php, class Device_Linux
    This class creates Linux installers. It supports NetworkManager and raw wpa_supplicant files.
Device_TestModule
in file TestModule.php, class Device_TestModule
    This is the main implementation class of the module
Device_Vista7
in file Vista7.php, class Device_Vista7
Device_W8
in file W8.php, class Device_W8
dumpAttibutes
in file DeviceConfig.php, method DeviceConfig::dumpAttibutes()
    dumps attributes for debugging purposes
e

e

echo_nsi
in file WindowsCommon.php, function echo_nsi()
    function to escape double quotes in a special NSI-compatible way
f

f

$FPATH
in file DeviceConfig.php, variable DeviceConfig::$FPATH
    stores the path to the temporary working directory for a module instance
g

g

getPreferredEapType
in file DeviceConfig.php, method DeviceConfig::getPreferredEapType()
    Selects the preferred eap method based on profile EAP configuration and device EAP capabilities
i

i

$installerBasename
in file DeviceConfig.php, variable DeviceConfig::$installerBasename
    This string should be used by all installer modules to set the installer file basename.
l

l

$lang
in file WindowsCommon.php, variable WindowsCommon::$lang
$LANGS
in file WindowsCommon.php, variable WindowsCommon::$LANGS
$lang_index
in file DeviceConfig.php, variable DeviceConfig::$lang_index
    the string referencing the language (index ot the Config::$LANGUAGES array).
Linux.php
procedural page Linux.php
listDevices
in file devices-template.php, method Devices::listDevices()
    Each device is defined as a sub-array within this array
m

m

$module_path
in file DeviceConfig.php, variable DeviceConfig::$module_path
    stores the path to the module source location and is used by copyFile and translateFile the only reason for it to be a public variable ies that it is set by the DeviceFactory class module_path should not be used by module drivers.
msInfoFile
in file WindowsCommon.php, method WindowsCommon::msInfoFile()
o

o

$Options
in file devices-template.php, variable Devices::$Options
    This array lists available configuration options for local device management.
$options
in file DeviceConfig.php, variable DeviceConfig::$options
    See devices-template.php for a list of available options
p

p

prepareInstallerLang
in file WindowsCommon.php, method WindowsCommon::prepareInstallerLang()
s

s

$selected_eap
in file DeviceConfig.php, variable DeviceConfig::$selected_eap
    optimal EAP method selected given profile and device
$sign
in file DeviceConfig.php, variable DeviceConfig::$sign
    the path to the profile signing program
$signer
in file DeviceConfig.php, variable DeviceConfig::$signer
$specialities
in file DeviceConfig.php, variable DeviceConfig::$specialities
    array of specialities - will be displayed on the admin download as "footnote"
$support_email_substitute
in file DeviceConfig.php, variable DeviceConfig::$support_email_substitute
    This string will be shown if no support email was configured by the admin
$support_url_substitute
in file DeviceConfig.php, variable DeviceConfig::$support_url_substitute
    This string will be shown if no support URL was configured by the admin
saveCertificateFiles
in file DeviceConfig.php, method DeviceConfig::saveCertificateFiles()
    Save certificate files in either DER or PEM format
setup
in file DeviceConfig.php, method DeviceConfig::setup()
    Set up working environment for a device module
signInstaller
in file WindowsCommon.php, method WindowsCommon::signInstaller()
sprint_nsi
in file WindowsCommon.php, function sprint_nsi()
t

t

TestModule.php
procedural page TestModule.php
translateFile
in file DeviceConfig.php, method DeviceConfig::translateFile()
    Copy a file from the module location to the temporary directory aplying translation.
translateString
in file DeviceConfig.php, method DeviceConfig::translateString()
v

v

Vista7.php
procedural page Vista7.php
w

w

W8.php
procedural page W8.php
WindowsCommon.php
procedural page WindowsCommon.php
WindowsCommon
in file WindowsCommon.php, class WindowsCommon
    This class defines common functions needed by all Windows installers
writeDeviceInfo
in file W8.php, method Device_W8::writeDeviceInfo()
writeDeviceInfo
in file DeviceConfig.php, method DeviceConfig::writeDeviceInfo()
    prepare usage information for the installer every device module should override this method
writeDeviceInfo
in file Vista7.php, method Device_Vista7::writeDeviceInfo()
writeDeviceInfo
in file Linux.php, method Device_Linux::writeDeviceInfo()
writeDeviceInfo
in file TestModule.php, method Device_TestModule::writeDeviceInfo()
    prepare module desctiption and usage information
writeInstaller
in file DeviceConfig.php, method DeviceConfig::writeInstaller()
    placeholder for the main device method
writeInstaller
in file W8.php, method Device_W8::writeInstaller()
writeInstaller
in file Linux.php, method Device_Linux::writeInstaller()
writeInstaller
in file Vista7.php, method Device_Vista7::writeInstaller()
writeInstaller
in file TestModule.php, method Device_TestModule::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
Documentation generated on Wed, 08 Apr 2015 07:12:46 +0000 by phpDocumentor 1.4.4