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

Element index for package Developer

Package indexes

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ] [ x ] [ _ ]

_

_

__clone
in file Options.php, method Options::__clone()
    Prevent cloning - this is a singleton.
__clone
in file DBConnection.php, method DBConnection::__clone()
    Implemented for safety reasons only. Cloning is forbidden and will tell the user so.
__construct
in file Profile.php, method Profile::__construct()
    Class constructor for existing profiles (use IdP::newProfile() to actually create one). Retrieves all attributes and supported EAP types from the DB and stores them in the priv_ arrays.
__construct
in file User.php, method User::__construct()
    Class constructor. The required argument is a user's persistent identifier as was returned by the authentication source.
__construct
in file welcomeletter.php, method Device_welcomeletter::__construct()
__construct
in file UserManagement.php, method UserManagement::__construct()
    Class constructor. Nothing special to be done when constructing.
__construct
in file macosx.php, method Device_macosx::__construct()
    this array holds the list of EAP methods supported by this device
__construct
in file DeviceFactory.php, method DeviceFactory::__construct()
    The constructor of the device factory.
__construct
in file Federation.php, method Federation::__construct()
    Constructs a Federation object.
__construct
in file IdP.php, method IdP::__construct()
    Constructs an IdP object based on its details in the database.
__construct
in file CAT.php, method CAT::__construct()
    Constructor sets the language by calling set_lang
__construct
in file mobileconfig.php, method Device_mobileconfig::__construct()
    this array holds the list of EAP methods supported by this device
a

a

addAdminToIdp
in file UserManagement.php, method UserManagement::addAdminToIdp()
    Adds a new administrator to an existing IdP
addAttribute
in file User.php, method User::addAttribute()
    This function adds a new attribute to the user. The attribute is stored persistently in the database immediately; however the priv_attributes array is not updated. To see the new attributes via getAttributes(), re-instantiate the object.
addAttribute
in file IdP.php, method IdP::addAttribute()
    Adds an attribute for the IdP instance into the database. Multiple instances of the same attribute are supported.
addAttribute
in file Profile.php, method Profile::addAttribute()
    adds an attribute to this profile
addSupportedEapMethod
in file Profile.php, method Profile::addSupportedEapMethod()
    register new supported EAP method for this profile
AVAILABLE
in file Profile.php, constant AVAILABLE
availableOptions
in file Options.php, method Options::availableOptions()
    This function lists all known options. If called with the optional parameter $class_name, only options of that class are returned, otherwise the full set of all known attributes.
b

b

beginFlushAttributes
in file User.php, method User::beginFlushAttributes()
    This function deletes most attributes in this profile immediately, and marks the rest (file-based attributes) for later deletion.
beginFlushAttributes
in file Profile.php, method Profile::beginFlushAttributes()
    deletes all attributes in this profile except the _file ones, these are reported as array.
beginFlushAttributes
in file IdP.php, method IdP::beginFlushAttributes()
    deletes all attributes in this profile except the _file ones, these are reported as array
c

c

calculateCommonHostSuffix
in file Helper.php, function calculateCommonHostSuffix()
CAT
in file CAT.php, class CAT
    Define some variables which need to be globally accessible and some general purpose methods
checkTokenValidity
in file UserManagement.php, method UserManagement::checkTokenValidity()
    Checks if a given invitation token exists and is valid in the invitations database returns a string with the following values:
commitFlushAttributes
in file User.php, method User::commitFlushAttributes()
    This function deletes attributes from the database by their database row ID. Its typical (only) use is to take the return of beginFlushAttribute() and delete the attributes in there. It only deletes rows which actually belong to the instantiated user.
commitFlushAttributes
in file Profile.php, method Profile::commitFlushAttributes()
    after a beginFlushAttributes, deletes all attributes which are in the tobedeleted array
commitFlushAttributes
in file IdP.php, method IdP::commitFlushAttributes()
    after a beginFlushAttributes, deletes all attributes which are in the tobedeleted array
CAT.php
procedural page CAT.php
createIdPFromToken
in file UserManagement.php, method UserManagement::createIdPFromToken()
    This function creates a new IdP in the database based on a valid invitation token - or adds a new administrator to an existing one. The institution is created for the logged-in user (second argument) who presents the token (first argument). The tokens are created via createToken().
createToken
in file UserManagement.php, method UserManagement::createToken()
    Creates a new invitation token. The token's main purpose is to be sent out by mail. The function either can generate a token for a new administrator of an existing institution, or for a new institution. In the latter case, the institution only actually gets created in the DB if the token is actually consumed via createIdPFromToken().
d

d

$device
in file DeviceFactory.php, variable DeviceFactory::$device
    Contains the produced device instance
DBConnection.php
procedural page DBConnection.php
DeviceFactory.php
procedural page DeviceFactory.php
DBConnection
in file DBConnection.php, class DBConnection
    This class is a singleton for establishing a connection to the database
debug
in file Helper.php, function debug()
    write debug messages to the log
der2pem
in file X509.php, method X509::der2pem()
destroy
in file Profile.php, method Profile::destroy()
    Deletes the profile from database and uninstantiates itself.
destroy
in file IdP.php, method IdP::destroy()
    deletes the IdP and all its profiles
DeviceFactory
in file DeviceFactory.php, class DeviceFactory
    This factory instantiates a device module and makes it available in its member $device.
Device_macosx
in file macosx.php, class Device_macosx
    This is the main implementation class of the module
Device_mobileconfig
in file mobileconfig.php, class Device_mobileconfig
    This is the main implementation class of the module
Device_welcomeletter
in file welcomeletter.php, class Device_welcomeletter
    This is the main implementation class of the module
downloadFile
in file Helper.php, function downloadFile()
downloadStats
in file Federation.php, method Federation::downloadStats()
e

e

$EAP_NONE
in file EAP.php, variable EAP::$EAP_NONE
    NULL: no outer EAP, no inner EAP
EAP.php
procedural page EAP.php
EAP
in file EAP.php, class EAP
    Convenience functions for EAP types
eapDisplayName
in file EAP.php, method EAP::eapDisplayName()
    This function takes the EAP method in array representation (OUTER/INNER) and returns it in a custom format for the Linux installers (not numbers, but strings as values).
EAPMethodIdFromArray
in file EAP.php, method EAP::EAPMethodIdFromArray()
    Returns the (integer) row number in the database for a given EAP type.
error
in file Helper.php, function error()
exec
in file DBConnection.php, method DBConnection::exec()
    executes a query and triggers logging to the SQL audit log if it's not a SELECT
EXTERNAL_DB_SYNCSTATE_NOTSUBJECTTOSYNCING
in file IdP.php, constant EXTERNAL_DB_SYNCSTATE_NOTSUBJECTTOSYNCING
EXTERNAL_DB_SYNCSTATE_NOT_SYNCED
in file IdP.php, constant EXTERNAL_DB_SYNCSTATE_NOT_SYNCED
EXTERNAL_DB_SYNCSTATE_SYNCED
in file IdP.php, constant EXTERNAL_DB_SYNCSTATE_SYNCED
f

f

$FAST_GTC
in file EAP.php, variable EAP::$FAST_GTC
    EAP-FAST (GTC): Outer EAP type = 43, Inner EAP Type = 6
$federation
in file IdP.php, variable IdP::$federation
    The shortname of this IdP's federation
$FederationList
in file Federation.php, variable Federation::$FederationList
    all known federation, in an array with ISO short name as an index, and localised version of the pretty-print name as value.
Federation.php
procedural page Federation.php
FAST
in file EAP.php, constant FAST
Federation
in file Federation.php, class Federation
    This class represents an consortium federation.
fetch_raw_db_data
in file Helper.php, function fetch_raw_db_data()
flushAttributes
in file IdP.php, method IdP::flushAttributes()
    deletes all attributes of this IdP from the database
flushSupportedEapMethods
in file Profile.php, method Profile::flushSupportedEapMethods()
    Removes all supported EAP methods
g

g

getAttributes
in file IdP.php, method IdP::getAttributes()
    This function retrieves the IdP-wide attributes. If called with the optional parameter, only attribute values for the attribute name in $option_name are retrieved; otherwise, all attributes are retrieved.
getAttributes
in file User.php, method User::getAttributes()
    This function retrieves the known attributes of the user from the private member priv_attributes.
getAttributes
in file Profile.php, method Profile::getAttributes()
    Returns an array of the profile's attributes.
getCollapsedAttributes
in file Profile.php, method Profile::getCollapsedAttributes()
    prepare profile attributes for device modules Gets profile attributes taking into account the most specific level on which they may be defined as wel as the chosen language.
getEapMethodsinOrderOfPreference
in file Profile.php, method Profile::getEapMethodsinOrderOfPreference()
    Produces an array of EAP methods supported by this profile, ordered by preference
getExternalDBEntityDetails
in file IdP.php, method IdP::getExternalDBEntityDetails()
    Fetches information from the external database about this IdP
getExternalDBEntityDetails
in file Federation.php, method Federation::getExternalDBEntityDetails()
getExternalDBId
in file IdP.php, method IdP::getExternalDBId()
    Retrieves the external DB identifier of this institution. Returns FALSE if no ID is known.
getExternalDBSyncCandidates
in file IdP.php, method IdP::getExternalDBSyncCandidates()
    Performs a lookup in an external database to determine matching entities to this IdP. The business logic of this function is roaming consortium specific; if no match algorithm is known for the consortium, FALSE is returned.
getExternalDBSyncState
in file IdP.php, method IdP::getExternalDBSyncState()
getFreshness
in file Profile.php, method Profile::getFreshness()
    gets the last-modified timestamp (useful for caching "dirty" check)
getLocalisedValue
in file Helper.php, function getLocalisedValue()
    pick a proper value for a given language
getShowtime
in file Profile.php, method Profile::getShowtime()
    Checks if the profile is shown (showable) to end users
getUserDownloadStats
in file Profile.php, method Profile::getUserDownloadStats()
    Retrieve current download stats from database, either for one specific device or for all devices
GTC
in file EAP.php, constant GTC
h

h

Helper.php
procedural page Helper.php
i

i

$identifier
in file Profile.php, variable Profile::$identifier
    DB identifier of the profile
$identifier
in file User.php, variable User::$identifier
    This variable holds the user's persistent identifier. This is not a real name; it is just an opaque handle as was returned by the authentication source. It is comparable to an eduPersonTargetedId value (and may even be one).
$identifier
in file IdP.php, variable IdP::$identifier
    The row index of this IdP in the database
$identifier
in file Federation.php, variable Federation::$identifier
    Textual short-hand representation of this Federation
$institution
in file Profile.php, variable Profile::$institution
    DB identifier of the parent institution of this profile
$inst_name
in file Profile.php, variable Profile::$inst_name
    name of the parent institution of this profile in the current language
IdP.php
procedural page IdP.php
IdP
in file IdP.php, class IdP
    This class represents an Identity Provider (IdP).
INCOMPLETE
in file Profile.php, constant INCOMPLETE
incrementDownloadStats
in file Profile.php, method Profile::incrementDownloadStats()
    Log a new download for our stats
instance
in file Options.php, method Options::instance()
    Returns the handle to the (only) instance of this class.
invalidateToken
in file UserManagement.php, method UserManagement::invalidateToken()
    Invalidates a token so that it can't be used any more. Tokens automatically expire after 24h, but can be invalidated earlier, e.g. after having been used to create an institution. If the token doesn't exist in the DB or is already invalidated, nothing happens.
isAttributeAvailable
in file IdP.php, method IdP::isAttributeAvailable()
    This function returns the count of specific attributes in an IdP This function will not retreive the values attributes (particularly important for large blobs), it is mainly intended as a test for an attribute existance.
isEapTypeDefinitionComplete
in file Profile.php, method Profile::isEapTypeDefinitionComplete()
    Performs a sanity check for a given EAP type - did the admin submit enough information to create installers for him?
isFederationAdmin
in file User.php, method User::isFederationAdmin()
    This function checks whether a user is a federation administrator. When called without argument, it only checks if the user is a federation administrator of *any* federation. When given a parameter (ISO shortname of federation), it checks if the user administers this particular federation.
l

l

$lang_index
in file Profile.php, variable Profile::$lang_index
    current language
$lang_index
in file CAT.php, variable CAT::$lang_index
    language code for the language set by the constructor
$locale
in file CAT.php, variable CAT::$locale
    language display name for the language set by the constructor
lastID
in file DBConnection.php, method DBConnection::lastID()
    Retrieves the last auto-id of an INSERT. Needs to be called immediately after the corresponding exec() call
listAllIdentityProviders
in file Federation.php, method Federation::listAllIdentityProviders()
    Lists all identity providers in the database which have at least one profile adding information required by DiscoJuice.
listDevices
in file Profile.php, method Profile::listDevices()
    list all devices marking their availabiblity and possible redirects
listFederationAdmins
in file Federation.php, method Federation::listFederationAdmins()
listIdentityProviders
in file Federation.php, method Federation::listIdentityProviders()
    Lists all Identity Providers in this federation
listInstitutionsByAdmin
in file UserManagement.php, method UserManagement::listInstitutionsByAdmin()
    For a given persistent user identifier, returns an array of institution identifiers (not the actual objects!) for which this user is the/a administrator.
listKnownEAPTypes
in file EAP.php, method EAP::listKnownEAPTypes()
    This function retrieves all known EAP types from the database and returns them as an array
listPendingInvitations
in file UserManagement.php, method UserManagement::listPendingInvitations()
    Retrieves all pending invitations for an institution or for a federation.
listProfiles
in file IdP.php, method IdP::listProfiles()
    This function retrieves all registered profiles for this IdP from the database
listUnmappedExternalEntities
in file Federation.php, method Federation::listUnmappedExternalEntities()
m

m

$my_eap_methods
in file macosx.php, variable Device_macosx::$my_eap_methods
macosx.php
procedural page macosx.php
mobileconfig.php
procedural page mobileconfig.php
MSCHAP2
in file EAP.php, constant MSCHAP2
n

n

$name
in file Profile.php, variable Profile::$name
    name of the profile in the current language
$name
in file IdP.php, variable IdP::$name
    The name of this IdP in current locale.
newIdP
in file Federation.php, method Federation::newIdP()
    Creates a new IdP inside the federation.
newProfile
in file IdP.php, method IdP::newProfile()
    Adds a new profile to this IdP.
NONE
in file EAP.php, constant NONE
NOTCONFIGURED
in file Profile.php, constant NOTCONFIGURED
o

o

Options.php
procedural page Options.php
Options
in file Options.php, class Options
    The Options class contains convenience functions around option handling. It is implemented as a singleton to prevent excessive DB requests; its content never changes during a script run.
optionType
in file Options.php, method Options::optionType()
    This function returns the properties of a given attribute name. This currently means it returns its type and its flag field ("ML").
owner
in file IdP.php, method IdP::owner()
    This function retrieves an array of authorised users which can manipulate this institution.
p

p

$PEAP_MSCHAP2
in file EAP.php, variable EAP::$PEAP_MSCHAP2
    PEAP-MSCHAPv2: Outer EAP Type = 25, Inner EAP Type = 26
$PWD
in file EAP.php, variable EAP::$PWD
    PWD: Outer EAP type = 52, no inner EAP
Profile.php
procedural page Profile.php
PEAP
in file EAP.php, constant PEAP
    some constants. Will PHPDoc render these nicely?
pem2der
in file X509.php, method X509::pem2der()
    transform PEM formed certificate to DER format
prepShowtime
in file Profile.php, method Profile::prepShowtime()
    set the showtime and QR-user attributes if prepShowTime says that there is enough info *and* the admin flagged the profile for showing
printCountryList
in file CAT.php, method CAT::printCountryList()
    Prepares a list of countries known to the CAT.
processCertificate
in file X509.php, method X509::processCertificate()
    prepare PEM and DER formats, MD5 and SHA1 fingerprints and subject of the certificate
Profile
in file Profile.php, class Profile
    This class represents an EAP Profile.
profileCount
in file IdP.php, method IdP::profileCount()
    This function gets the profile count for a given IdP The count could be retreived from the listProfiles method but this is less expensive.
PWD
in file EAP.php, constant PWD
r

r

$realm
in file Profile.php, variable Profile::$realm
    realm of this profile (empty string if unset)
$root
in file CAT.php, variable CAT::$root
    stores the location of the root directory
readyForShowtime
in file Profile.php, method Profile::readyForShowtime()
    Checks if the profile has enough information to have something to show to end users. This does not necessarily mean that there's a fully configured EAP type - it is sufficient if a redirect has been set for at least one device.
removeAdminFromIdP
in file UserManagement.php, method UserManagement::removeAdminFromIdP()
    Deletes an administrator from the IdP. If the IdP and user combination doesn't match, nothing happens.
s

s

sendMailToUser
in file User.php, method User::sendMailToUser()
setAnonymousIDSupport
in file Profile.php, method Profile::setAnonymousIDSupport()
    Toggle anonymous outer ID support.
setExternalDBId
in file IdP.php, method IdP::setExternalDBId()
setRealm
in file Profile.php, method Profile::setRealm()
    Specifies the realm of this profile.
set_locale
in file CAT.php, method CAT::set_locale()
    Sets the gettext domain
splitCertificate
in file X509.php, method X509::splitCertificate()
    split a certificate file into components
t

t

$TLS
in file EAP.php, variable EAP::$TLS
    EAP-TLS: Outer EAP Type = 13, no inner EAP
$TTLS_GTC
in file EAP.php, variable EAP::$TTLS_GTC
    TTLS-GTC: Outer EAP type = 21, Inner EAP Type = 6
$TTLS_MSCHAP2
in file EAP.php, variable EAP::$TTLS_MSCHAP2
    TTLS-MSCHAP-v2: Outer EAP type = 21, Inner EAP Type = 26
$TTLS_PAP
in file EAP.php, variable EAP::$TTLS_PAP
    TTLS-PAP: Outer EAP type = 21, no inner EAP
testCache
in file Profile.php, method Profile::testCache()
    This function tests if the configurator needs to be regenerated (properties of the Profile may have changed since the last configurator generation).
TLS
in file EAP.php, constant TLS
TTLS
in file EAP.php, constant TTLS
u

u

$use_anon_outer
in file Profile.php, variable Profile::$use_anon_outer
    boolean value: should anonymous outer IDs be used or not?
User.php
procedural page User.php
UserManagement.php
procedural page UserManagement.php
UNAVAILABLE
in file Profile.php, constant UNAVAILABLE
updateCache
in file Profile.php, method Profile::updateCache()
    Updates database with new installler location
updateFreshness
in file IdP.php, method IdP::updateFreshness()
    This function sets the timestamp of last modification of the child profiles to the current timestamp. This is needed for installer caching: all installers which are on disk must be re-created if an attribute changes. This timestamp here is used to determine if the installer on disk is still new enough.
updateFreshness
in file Profile.php, method Profile::updateFreshness()
    update the last_changed timestamp for this profile
User
in file User.php, class User
    This class represents a known CAT User (i.e. an institution and/or federation adiministrator).
UserManagement
in file UserManagement.php, class UserManagement
    This class manages user privileges and bindings to institutions
uuid
in file Helper.php, function uuid()
    generates a UUID
w

w

welcomeletter.php
procedural page welcomeletter.php
writeAudit
in file CAT.php, method CAT::writeAudit()
    Writes an audit log entry to the audit log file. These audits are semantic logs; they don't record every single modification in the database, but provide a logical "who did what" overview. The exact modification SQL statements are logged automatically with writeSQLAudit() instead. The log file path is configurable in _config.php.
writeDeviceInfo
in file welcomeletter.php, method Device_welcomeletter::writeDeviceInfo()
writeDeviceInfo
in file mobileconfig.php, method Device_mobileconfig::writeDeviceInfo()
writeInstaller
in file welcomeletter.php, method Device_welcomeletter::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
writeInstaller
in file macosx.php, method Device_macosx::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
writeInstaller
in file mobileconfig.php, method Device_mobileconfig::writeInstaller()
    prepare a zip archive containing files and settings which normally would be used inside the module to produce an installer
writeSQLAudit
in file CAT.php, method CAT::writeSQLAudit()
    Write an audit log entry to the SQL log file. Every SQL statement which is not a simple SELECT one will be written to the log file. The log file path is configurable in _config.php.
x

x

X509.php
procedural page X509.php
X509
in file X509.php, class X509
    This class contains handling functions for X.509 certificates

Documentation generated on Wed, 08 Apr 2015 07:12:46 +0000 by phpDocumentor 1.4.4