Docs For Class Core

Class Core_Archon

Description

abstract:

Located in /packages/core/lib/archon.inc.php (line 2)

Variable Summary

string $ArchonURL

Configuration[] $Configuration

int $CopyrightYear

mixed $db

boolean $Disabled

string $Error

object $MemoryCache

array $Packages

string $ProductName

string $ReleaseDate

string $RootDirectory

mixed $ScriptName

Security $Security

string $Version

Method Summary

void addAdministrativeUIFunction (string $FunctionName, string $AddedFunctionName)

boolean addAdministrativeWidget (integer $PackageID, $WidgetCode, $FunctionName, string $WidgetName, string $Description, string $UtilityCode, string $PackageVersion, string[] $Extensions, boolean $InputFile[optional])

boolean addDatabaseImportUtility (integer $PackageID, string $UtilityCode, string $PackageVersion, string[] $Extensions, [ $InputFile = true], string $UtilityName, string $Description, boolean $InputFile[optional])

void addPackageDependency (string $Package, string $DependsUpon, [string $DependsUponVersion = 0.01])

void addPackageEnhancement (string $Package, string $Enhances, [string $EnhancesVersion = 0.01])

boolean addPublicSearchFunction (string $FunctionName, [integer $DisplayOrder = 0])

boolean clearCacheObjectEntry ( $ClassName, $ID, string $Table)

boolean clearCacheTableEntry (string $Table)

unknown clearError ()

mixed createConsensusVariable (mixed $var1, mixed $var2)

float[] createFloatArrayFromString (string $String)

integer[] createNumericArrayFromString (string $String)

string[] createSearchWordArray (string $String)

string createStringFromLanguageArray (Language[] $arrLanguages, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], string $Delimiter[optional], integer $MakeIntoLink[optional])

void declareError (string $Error)

string[] getAllAdminThemes ()

object[][] getAllDatabaseImportUtilities ()

string[] getAllIncomingFileLocations ()

string[] getAllIncomingFiles ()

Language[] getAllLanguages ()

Module[] getAllModules ([ $LanguageID = 0], [ $ExcludeDisabledPackages = true])

Package[] getAllPackages ([ $LanguageID = 0], [ $ExcludeDisabledPackages = true], integer $LanguageID[optional], boolean $ExcludeDisabledPackages[optional])

Phrase[] getAllPhrases ()

PhraseType[] getAllPhraseTypes ()

Session[] getAllSessions ([ $ActivityTimeLimit = 0])

string[][] getAllTemplates ()

string[] getAllThemes ()

Usergroup[] getAllUsergroups ()

User[] getAllUsers ()

string getJavascriptTags (string $Filename, [string[] $GETData = array()])

integer getLanguageIDFromString (string $String)

string getLatestArchonVersion ()

void getLatestPackageVersionFromAPRCode (string $APRCode)

integer getModuleIDFromScript (string $Script)

integer getPackageIDFromAPRCode (string $APRCode)

integer getPermissionsForUser (integer $UserID, integer $ModuleID)

integer getPermissionsForUsergroup (integer $UsergroupID, integer $ModuleID)

Phrase getPhrase (string $PhraseName, $PackageID, $ModuleID, $PhraseTypeID, [ $LanguageID = 0], integer $PhraseTypeID[optional], integer $LanguageID[optional])

integer getPhraseTypeIDFromString (string $String)

User[] getUserArrayFromIDArray (integer[] $arrIDs)

Usergroup[] getUsergroupArrayFromIDArray (integer[] $arrIDs)

integer getUsergroupIDFromName (string $Usergroup)

integer getUserIDFromLogin (string $Login)

mixed getUsersForUsergroup (integer $ID)

void initialize ()

boolean loadObject (object $Object, string $Table)

$ClassName[] loadTable (string $Table, string $ClassName, [ $OrderBy = NULL], [ $Condition = NULL], string $OrderBy[optional], string $Condition[optional])

array loadTemplates (string $TemplateSet)

void log (string $TableName, integer $ID)

string processPhrase (string $Phrase)

void redirect ([string $Location = NULL])

Language[] searchLanguages (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

ModificationLogEntry[] searchModificationLogEntries (string $SearchQuery, [string $OrderByColumn = 'Timestamp'], [integer $OrderByDirection = DESCENDING], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

Phrase[] searchPhrases (string $SearchQuery, [ $PackageID = 0], [ $ModuleID = NULL], [ $PhraseTypeID = 0], [ $LanguageID = 0], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $PhraseTypeID[optional], integer $LanguageID[optional], integer $Limit[optional], integer $Offset[optional])

$ClassName[] searchTable (string $SearchQuery, string|string[] $Tables, string|string[] $Fields, string $ClassName, [ $OrderBy = NULL], [ $AdditionalConditionsAND = NULL], [ $AdditionalConditionsOR = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], string $OrderBy[optional], string $AdditionalConditionsAND[optional], string $AdditionalConditionsOR[optional], integer $Limit[optional], integer $Offset[optional])

void sendMessage (string $Message)

void sendMessageAndRedirect (string $Message, [string $Location = NULL])

Classification[] setMixinMethodParameters ( $ClassName, $MixinClassName, $Method, [ $Callback = NULL], [ $MixOrder = MIX_AFTER], integer $ID)

Variables

string $ArchonURL = 'http://www.archon.org/' (line 2935)

Contains the URL to The Archon Project website.

access: public

Configuration[] $Configuration = NULL (line 2944)

Contains and array of Configuration objects, each of which represents a configuration directive in the Configuration table.

access: public

int $CopyrightYear = 2008 (line 2951)

Contains the most recent year of Archon development.

access: public

mixed $db = NULL (line 2953)

access: public

boolean $Disabled = false (line 2963)

When this variable is set to true, Archon is disabled to the public.

Typically there is no reason to modify this variable directly, as there is a configuration directive that will disable Archon as well.

access: public

string $Error = NULL (line 2971)

If an error occurs within the API, this value will be set to a text description of the error.

access: public

object $MemoryCache = NULL (line 2976)

access: public

array $Packages = array() (line 2981)

access: public

string $ProductName = 'Archon' (line 2986)

access: public

string $ReleaseDate = '2008.07.17' (line 2991)

access: public

string $RootDirectory = NULL (line 2996)

access: public

mixed $ScriptName = NULL (line 2999)

access: public

Security $Security = NULL (line 3004)

access: public

string $Version = NULL (line 3011)

Contains the version of the Archon codebase.

access: public

Methods

addAdministrativeUIFunction (line 10)

Adds additional user interface function for extending functionality of other user interface functions

access: public

void addAdministrativeUIFunction (string $FunctionName, string $AddedFunctionName)

string $FunctionName: function being extended
string $AddedFunctionName

addAdministrativeWidget (line 36)

Adds an administrative widget

access: public

string $WidgetName
string $Description
string $UtilityCode
integer $PackageID
string $PackageVersion
string[] $Extensions
boolean $InputFile[optional]
$WidgetCode
$FunctionName

addDatabaseImportUtility (line 81)

Adds a database import utility

access: public

string $UtilityName
string $Description
integer $PackageID
string $UtilityCode
string $PackageVersion
string[] $Extensions
boolean $InputFile[optional]
$InputFile

addPackageDependency (line 118)

Adds a package dependency

First two parameters are the APRCodes of the Packages

access: public

void addPackageDependency (string $Package, string $DependsUpon, [string $DependsUponVersion = 0.01])

string $Package
string $DependsUpon
string $DependsUponVersion

addPackageEnhancement (line 146)

Adds a package enhancement

First two parameters are the APRCodes of the Packages

access: public

void addPackageEnhancement (string $Package, string $Enhances, [string $EnhancesVersion = 0.01])

string $Package
string $Enhances
string $EnhancesVersion

addPublicSearchFunction (line 171)

Adds a search function for use in Archon's public search page

access: public

boolean addPublicSearchFunction (string $FunctionName, integer $DisplayOrder)

string $FunctionName
integer $DisplayOrder

clearCacheObjectEntry (line 200)

Clears Memory Cache of the entry denoted by $Table

access: public

boolean clearCacheObjectEntry ( $ClassName, $ID, string $Table)

string $Table
$ClassName
$ID

clearCacheTableEntry (line 217)

Clears Memory Cache of the entry denoted by $Table

access: public

boolean clearCacheTableEntry (string $Table)

string $Table

clearError (line 231)

Returns the value of $_ARCHON->Error and empties it.

access: public

unknown clearError ()

createConsensusVariable (line 258)

Fully traverses two variables and returns a "consensus" variable

If the argument variables are objects or arrays, the function will return a variable of the same type with any member variables that are not equal in both set to variables set to the value specified by MULTIPLE_VALUES.

Note that this function is unable to precisely compare objects that have private member variables, since it cannot access them.

access: public

mixed createConsensusVariable (mixed $var1, mixed $var2)

mixed $var1
mixed $var2

createFloatArrayFromString (line 420)

Takes a string representing a range or list of floats and creates and array containing all numbers the string represents.

access: public

float[] createFloatArrayFromString (string $String)

string $String

createNumericArrayFromString (line 377)

Takes a string representing a range or list of numbers and creates and array containing all numbers the string represents.

access: public

integer[] createNumericArrayFromString (string $String)

string $String

createSearchWordArray (line 479)

Creates an array of words and phrases parsed from a query string

Note: The strings in the returned array all have their slashes stripped.

access: public

string[] createSearchWordArray (string $String)

string $String

createStringFromLanguageArray (line 545)

Creates an formatted string from an array of Language objects

access: public

string createStringFromLanguageArray (Language[] $arrLanguages, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], string $Delimiter[optional], integer $MakeIntoLink[optional])

Language[] $arrLanguages
string $Delimiter[optional]
integer $MakeIntoLink[optional]
$Delimiter
$MakeIntoLink

declareError (line 575)

Appends new error onto list of previous errors.

access: public

void declareError (string $Error)

string $Error

getAllAdminThemes (line 597)

Returns any array of installed admin themes.

The names of installed themes are derived from the directory names under adminthemes/

return: array of theme names
access: public

string[] getAllAdminThemes ()

getAllDatabaseImportUtilities (line 636)

Returns any array of Database import utilities.

Note: Only import utilities in packages which are installed and enabled will be added to the returned array

The first dimension is the PackageID The second dimension is the "Utility Code" defined by the import utility

access: public

object[][] getAllDatabaseImportUtilities ()

getAllIncomingFileLocations (line 671)

Returns an array of incoming file's names and locations

If no 'serverfiles' are specified, it will return all files in the incoming directory Otherwise, it returns only the serverfiles in the incoming directory.

return: of file locations
access: public

string[] getAllIncomingFileLocations ()

getAllIncomingFiles (line 724)

Returns any array of Incoming Files.

The names of installed Incoming Files are derived from the directory names under incoming/

return: array of file contents
access: public

string[] getAllIncomingFiles ()

getAllLanguages (line 764)

Retrieves all Languages from the database

The returned array of Language objects is sorted by LanguageLong and has IDs as keys.

access: public

Language[] getAllLanguages ()

getAllModules (line 781)

Retrieves all Modules from the database

The returned array of Module objects is sorted by Package, Module and has IDs as keys.

access: public

Module[] getAllModules ( $LanguageID, [ $ExcludeDisabledPackages = true])

$LanguageID
$ExcludeDisabledPackages

getAllPackages (line 868)

Retrieves all Packages from the database

The returned array of Package objects is sorted by Package and has IDs as keys.

access: public

Package[] getAllPackages ( $LanguageID, [ $ExcludeDisabledPackages = true], integer $LanguageID[optional], boolean $ExcludeDisabledPackages[optional])

integer $LanguageID[optional]
boolean $ExcludeDisabledPackages[optional]
$LanguageID
$ExcludeDisabledPackages

getAllPhrases (line 919)

Retrieves all Phrases from the database

The returned array of Phrase objects is sorted by Phrase and has IDs as keys.

access: public

Phrase[] getAllPhrases ()

getAllPhraseTypes (line 936)

Retrieves all Phrase Types from the database

The returned array of PhraseType objects is sorted by PhraseType and has IDs as keys.

access: public

PhraseType[] getAllPhraseTypes ()

getAllSessions (line 953)

Retrieves all Sessions from the database

The returned array of Session objects is sorted by Name and has IDs as keys.

access: public

Session[] getAllSessions ( $ActivityTimeLimit)

$ActivityTimeLimit

getAllTemplates (line 980)

Returns any array of installed templates.

The names of installed templates are derived from the directory names under templates/

return: array of template names
access: public

string[][] getAllTemplates ()

getAllThemes (line 1014)

Returns any array of installed themes.

The names of installed themes are derived from the directory names under themes/

return: array of theme names
access: public

string[] getAllThemes ()

getAllUsergroups (line 1048)

Retrieves all Usergroups from the database

The returned array of Usergroup objects is sorted by Usergroup and has IDs as keys.

access: public

Usergroup[] getAllUsergroups ()

getAllUsers (line 1074)

Retrieves all Users from the database

The returned array of User objects is sorted by Login and has IDs as keys.

access: public

User[] getAllUsers ()

getJavascriptTags (line 1108)

Return <script> tags to open javascript files label with $Filename from all enabled packages.

access: public

string getJavascriptTags (string $Filename, [string[] $GETData = array()])

string $Filename
string[] $GETData

getLanguageIDFromString (line 1157)

Returns LanguageID value when passed the string value for a container type.

access: public

integer getLanguageIDFromString (string $String)

string $String

getLatestArchonVersion (line 1180)

Returns the version of the latest of Archon

access: public

string getLatestArchonVersion ()

getLatestPackageVersionFromAPRCode (line 1194)

Returns the version number for the latest update of the package

access: public

void getLatestPackageVersionFromAPRCode (string $APRCode)

string $APRCode

getModuleIDFromScript (line 1210)

Returns ModuleID value when passed the module script string.

access: public

integer getModuleIDFromScript (string $Script)

string $Script

getPackageIDFromAPRCode (line 1233)

Return PackageID value when passed the package aprcode string.

access: public

integer getPackageIDFromAPRCode (string $APRCode)

string $APRCode

getPermissionsForUser (line 1258)

Retrives permissions for a specified user and module

access: public

integer getPermissionsForUser (integer $UserID, integer $ModuleID)

integer $UserID
integer $ModuleID

getPermissionsForUsergroup (line 1330)

Retrives permissions for a specified usergroup and module

access: public

integer getPermissionsForUsergroup (integer $UsergroupID, integer $ModuleID)

integer $UsergroupID
integer $ModuleID

getPhrase (line 1392)

Retrieves Phrase for Phrase specified by PhraseName and PhraseTypeID

access: public

Phrase getPhrase (string $PhraseName, $PackageID, $ModuleID, $PhraseTypeID, $LanguageID, integer $PhraseTypeID[optional], integer $LanguageID[optional])

string $PhraseName
integer $PhraseTypeID[optional]
integer $LanguageID[optional]
$PackageID
$ModuleID
$PhraseTypeID
$LanguageID

getPhraseTypeIDFromString (line 1478)

Returns PhraseTypeID value when passed the string value for a phrase type.

access: public

integer getPhraseTypeIDFromString (string $String)

string $String

getUserArrayFromIDArray (line 1512)

Retrieves an array containing User objects for each ID in $arrIDs

access: public

User[] getUserArrayFromIDArray (integer[] $arrIDs)

integer[] $arrIDs

getUsergroupArrayFromIDArray (line 1569)

Retrieves an array containing Usergroup objects for each ID in $arrIDs

access: public

Usergroup[] getUsergroupArrayFromIDArray (integer[] $arrIDs)

integer[] $arrIDs

getUsergroupIDFromName (line 1620)

Return UsergroupID value when passed the usergroup's name string.

access: public

integer getUsergroupIDFromName (string $Usergroup)

string $Usergroup

getUserIDFromLogin (line 1646)

Returns UserID value when passed the user's login string.

access: public

integer getUserIDFromLogin (string $Login)

string $Login

getUsersForUsergroup (line 1675)

Returns an array of User objects that belong to the specified Usergroup

access: public

mixed getUsersForUsergroup (integer $ID)

integer $ID

initialize (line 1696)

Initializes Archon for use

access: public

void initialize ()

loadObject (line 2078)

Loads argument object with information from the database

access: public

boolean loadObject (object $Object, string $Table)

object $Object
string $Table

loadTable (line 2654)

Loads all rows from a table into an array of objects

Returns an array of $ClassName objects which is sorted by $OrderBy and has IDs as keys.

If the objects are nested, loadTable will also connect Parents.

access: public

$ClassName[] loadTable (string $Table, string $ClassName, [ $OrderBy = NULL], [ $Condition = NULL], string $OrderBy[optional], string $Condition[optional])

string $Table
string $ClassName
string $OrderBy[optional]
string $Condition[optional]
$OrderBy
$Condition

loadTemplates (line 2136)

Loads Templates according to named Template Set

return: with container types for keys and file contents for container type as values
access: public

array loadTemplates (string $TemplateSet)

string $TemplateSet

log (line 2240)

Adds entry in modification log

void log (string $TableName, integer $ID)

string $TableName
integer $ID

processPhrase (line 2281)

Processes phrase and translates as necessary.

access: public

string processPhrase (string $Phrase)

string $Phrase

redirect (line 2353)

Redirects user to specified location.

access: public

void redirect ([string $Location = NULL])

string $Location

searchLanguages (line 2435)

Searches the Language database

access: public

Language[] searchLanguages (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
integer $Limit[optional]
integer $Offset[optional]
$Limit
$Offset

searchModificationLogEntries (line 2453)

Searches the ModificationLogEntry database

access: public

ModificationLogEntry[] searchModificationLogEntries (string $SearchQuery, [string $OrderByColumn = 'Timestamp'], [integer $OrderByDirection = DESCENDING], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
string $OrderByColumn
integer $OrderByDirection
integer $Limit[optional]
integer $Offset[optional]
$Limit
$Offset

searchPhrases (line 2488)

Searches the Phrase database

access: public

Phrase[] searchPhrases (string $SearchQuery, $PackageID, [ $ModuleID = NULL], $PhraseTypeID, $LanguageID, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $PhraseTypeID[optional], integer $LanguageID[optional], integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
integer $PhraseTypeID[optional]
integer $LanguageID[optional]
integer $Limit[optional]
integer $Offset[optional]
$PackageID
$ModuleID
$PhraseTypeID
$LanguageID
$Limit
$Offset

searchTable (line 2747)

Searches the a table in the database

Note: The first value it $Tables will be the table from which the object data will be loaded

access: public

$ClassName[] searchTable (string $SearchQuery, string|string[] $Tables, string|string[] $Fields, string $ClassName, [ $OrderBy = NULL], [ $AdditionalConditionsAND = NULL], [ $AdditionalConditionsOR = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, string $OrderBy[optional], string $AdditionalConditionsAND[optional], string $AdditionalConditionsOR[optional], integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
string|string[] $Tables
string|string[] $Fields
string $ClassName
string $OrderBy[optional]
string $AdditionalConditionsAND[optional]
string $AdditionalConditionsOR[optional]
integer $Limit[optional]
integer $Offset[optional]
$OrderBy
$AdditionalConditionsAND
$AdditionalConditionsOR
$Limit
$Offset

sendMessage (line 2523)

Sends message to user via the message frame.

access: public

void sendMessage (string $Message)

string $Message

sendMessageAndRedirect (line 2584)

Sends message to user via the message frame and redirects to specified location.

access: public

void sendMessageAndRedirect (string $Message, [string $Location = NULL])

string $Message
string $Location

setMixinMethodParameters (line 2600)

Sets parameters for a Mixin Method

Classification[] setMixinMethodParameters ( $ClassName, $MixinClassName, $Method, [ $Callback = NULL], [ $MixOrder = MIX_AFTER], integer $ID)

integer $ID
$ClassName
$MixinClassName
$Method
$Callback
$MixOrder

Documentation generated on Thu, 14 Aug 2008 20:21:03 -0500 by phpDocumentor 1.3.1