Class class_admin

Description

The Base-Class for all other admin-classes

  • abstract:

Located in /admin/class_admin.php (line 15)


	
			
Direct descendents
Class Description
class_element_admin The base class for all page-elements
class_modul_dashboard_admin
class_modul_dashboard_admin_xml admin-class of the dashboard-module Serves xml-requests, mostly general requests e.g. changing a widgets position
class_modul_downloads_admin Admin class of the downloads-module. Used to sync the archives with the filesystem and to define file-properties
class_modul_downloads_admin_xml admin-class of the downloads-module Serves xml-requests, e.g. syncing an archive
class_modul_faqs_admin Admin class of the faqs-module. Responsible for editing faqs and organizing them in categories
class_modul_filemanager_admin Admin-Parts of the filemanager
class_modul_filemanager_admin_xml admin-class of the filemananger-module Serves xml-requests, currently to handle uploads
class_modul_folderview_admin This class provides a list-view of the folders created in the database / filesystem
class_modul_gallery_admin Admin class of the gallery-module. Used to sync the galleries with the filesystem and to define picture-properties
class_modul_gallery_admin_xml admin-class of the gallery-module Serves xml-requests, e.g. syncing a gallery
class_modul_guestbook_admin Admin class to handle all guestbook-stuff like creating guestbook, deleting posts, ...
class_modul_languages_admin Admin-class to manage all languages
class_modul_login_admin This class shows a little LoginScreen if the user is net yet loggedin
class_modul_navigation_admin Admin-class to manage all navigations
class_modul_navigation_admin_xml Admin-class to manage all navigations
class_modul_news_admin Admin class of the news-module. Responsible for editing news, organizing them in categories and creating feeds
class_modul_pages_admin This class handles the admin-sided management of the pages In this case, that are only the pages NOT yet the content
class_modul_pages_admin_xml admin-class of the pages-module Serves xml-requests, e.g. a list of available pages
class_modul_pages_content_admin This class is used to edit the content of a page. So, to create / delete / modify elements on a given page.
class_modul_postacomment_admin Admin class of the postacomment-module. Responsible for listing posts and organizing them
class_modul_right_admin This class handles the adminside of right-management
class_modul_stats_admin Admin-Part of the stats, generating all reports an handles requests to workers
class_modul_system_admin Class to handle infos about the system and to set systemwide properties
class_modul_system_admin_xml admin-class of the system-module Serves xml-requests, mostly general requests e.g. changing a records status or position in a list
class_modul_user_admin This class provides the user and groupmanagement
Variable Summary
Method Summary
class_admin __construct ([string $arrModul = array()], [string $strSystemid = ""])
void addValidationError (string $strField, string $strErrormessage)
void adminReload (string $strUrlToLoad)
bool flushPageFromPagesCache (string $strPagename)
string generateSystemid ()
string getAction ()
mixed getAllParams ()
string getArrModule (string $strKey)
int getEditDate ([string $strSystemid = ""])
string getHistory ([int $intPosition = 0])
string getLastEditUser ([string $strSystemid = ""])
mixed getModuleData (string $strName, [bool $bitCache = true])
string getModuleOutput ()
string getModuleSystemid (string $strModule)
object getObjRights ()
obj getObjText ()
string getOutputContent ()
void getOutputLogin ()
string getOutputMainNavi ()
string getParam (string $strKey)
mixed getPathArray ([string $strSystemid = ""], [string $strStopSystemid = ""])
string getPrevId ([string $strSystemid = ""])
int getStatus ([string $strSystemid = ""])
string getSystemid ()
mixed getSystemRecord ([string $strSystemid = ""])
string getText (string $strName, [string $strModule = ""], [string $strArea = ""])
void setAbsolutePosition (string $strIdToSet, int $intPosition)
void setArrModuleEntry (string $strKey, mixed $strValue)
bool setEditDate ([string $strSystemid = ""])
void setHistory ()
void setParam ( $strKey, mixed $mixedValue, string $strName)
void setPosition (string $strIdToShift, [string $strDirection = "upwards"])
bool setStatus ([string $strSystemid = ""])
void setStrTextBase (string $strTextbase)
bool setSystemid (string $strID)
void setTemplateArea (string $strArea)
bool validateForm ()
bool validateSystemid ( $strID, string $strtID)
Variables
mixed $arrModule (line 75)
  • access: protected
class_config $objConfig = null (line 23)

Instance of class_config

  • access: protected
class_db $objDB = null (line 29)

Instance of class_db

  • access: protected
class_rights $objRights = null (line 53)

Instance of class_rights

  • access: protected
class_session $objSession = null (line 41)

Instance of class_session

  • access: protected
class_template $objTemplate = null (line 47)

Instance of class_template

  • access: protected
class_toolkit_admin $objToolkit = null (line 35)

Instance of class_toolkit_admin

  • access: protected
mixed $strOutput (line 77)
  • access: protected
mixed $strTemplateArea (line 76)
  • access: protected
Methods
Constructor __construct (line 87)

Constructor

  • access: public
class_admin __construct ([string $arrModul = array()], [string $strSystemid = ""])
  • string $arrModul
  • string $strSystemid

Redefined in descendants as:
addValidationError (line 881)

Adds a validation error to the array of errors

  • access: public
void addValidationError (string $strField, string $strErrormessage)
  • string $strField
  • string $strErrormessage
adminReload (line 891)

Use this method to reload a specific url.

Use ONLY this method and DO NOT use header("Location: ...");

  • access: public
void adminReload (string $strUrlToLoad)
  • string $strUrlToLoad
flushCompletePagesCache (line 546)

Deletes the complete Pages-Cache

  • access: public
bool flushCompletePagesCache ()
flushPageFromPagesCache (line 557)

Removes one page from the cache

  • access: public
bool flushPageFromPagesCache (string $strPagename)
  • string $strPagename
generateSystemid (line 242)

Generates a new SystemID

  • return: The new SystemID
  • see: functions.php
  • final:
  • access: public
string generateSystemid ()
getAction (line 190)

returns the action used for the current request

  • final:
  • access: public
string getAction ()
getAllParams (line 180)

Returns the complete Params-Array

  • final:
  • access: public
mixed getAllParams ()
getArrModule (line 410)

Returns a value from the $arrModule array.

If the requested key not exists, returns ""

  • access: public
string getArrModule (string $strKey)
  • string $strKey
getEditDate (line 298)

Returns the time the record was last edited

  • access: public
int getEditDate ([string $strSystemid = ""])
  • string $strSystemid
getHistory (line 483)

Returns the URL at the given position (from HistoryArray)

  • access: protected
string getHistory ([int $intPosition = 0])
  • int $intPosition
getLanguageToWorkOn (line 906)

Loads the language to edit content

  • access: public
string getLanguageToWorkOn ()
getLastEditUser (line 286)

Returns the name of the user who last edited the record

  • access: public
string getLastEditUser ([string $strSystemid = ""])
  • string $strSystemid
getModuleData (line 371)

Returns the data for a registered module

  • access: public
mixed getModuleData (string $strName, [bool $bitCache = true])
  • string $strName
  • bool $bitCache
getModuleDescription (line 434)

Creates a text-based decription of the current module.

Therefore the text-entry module_description should be available.

  • since: 3.2.1
  • access: public
string getModuleDescription ()
getModuleOutput (line 574)

Returns the complete Template.

Collects all outputs and invokes the navi generation, ...

  • final:
  • access: public
string getModuleOutput ()
getModuleSystemid (line 381)

Returns the SystemID of a installed module

  • access: public
string getModuleSystemid (string $strModule)
  • string $strModule
getObjRights (line 252)

Returns the current instance of the class_rights

  • final:
  • access: public
object getObjRights ()
getObjText (line 524)

Returns the current Text-Object Instance

  • access: protected
obj getObjText ()
getOutputLogin (line 799)

Writes the SessionInfo, overwrite if needed

  • access: protected
void getOutputLogin ()
getOutputMainNavi (line 676)

Writes the Main Navi, overwrite if needed ;) Creates a list of all installed modules

  • access: protected
string getOutputMainNavi ()
getOutputModuleTitle (line 788)

Writes the ModuleTitle, overwrite if needed

  • access: protected
void getOutputModuleTitle ()

Redefined in descendants as:
getParam (line 167)

Returns a value from the params-Array

  • return: else ""
  • access: public
string getParam (string $strKey)
  • string $strKey
getPathArray (line 394)

Generates a sorted array of systemids, reaching from the passed systemid up until the assigned module-id

  • access: public
mixed getPathArray ([string $strSystemid = ""], [string $strStopSystemid = ""])
  • string $strSystemid
  • string $strStopSystemid
getPrevId (line 322)

Gets the Prev-ID of a record

  • access: public
string getPrevId ([string $strSystemid = ""])
  • string $strSystemid
getStatus (line 274)

Gets the status of a systemRecord

  • access: public
int getStatus ([string $strSystemid = ""])
  • string $strSystemid
getSystemid (line 231)

Returns the current SystemID

  • final:
  • access: public
string getSystemid ()
getSystemRecord (line 357)

Return a complete SystemRecord

  • access: public
mixed getSystemRecord ([string $strSystemid = ""])
  • string $strSystemid
getText (line 500)

Used to get Text out of Textfiles

  • access: public
string getText (string $strName, [string $strModule = ""], [string $strArea = ""])
  • string $strName
  • string $strModule
  • string $strArea
getValidationErrors (line 871)

Returns the array of validationErrors

  • access: public
mixed getValidationErrors ()
setAbsolutePosition (line 346)

Sets the position of systemid using a given value.

  • access: public
void setAbsolutePosition (string $strIdToSet, int $intPosition)
  • string $strIdToSet
  • int $intPosition
setArrModuleEntry (line 423)

Writes a key-value-pair to the arrModule

  • access: public
void setArrModuleEntry (string $strKey, mixed $strValue)
  • string $strKey
  • mixed $strValue
setEditDate (line 310)

Sets the current date as the edit-date of a system record

  • access: public
bool setEditDate ([string $strSystemid = ""])
  • string $strSystemid
setHistory (line 449)

Holds the last 5 URLs the user called in the Session Admin and Portal are seperated arrays, but don't worry anyway...

  • access: protected
void setHistory ()
setParam (line 157)

Writes a value to the params-array

  • access: public
void setParam ( $strKey, mixed $mixedValue, string $strName)
  • string $strName: Key
  • mixed $mixedValue: Value
  • $strKey
setPosition (line 336)

Sets the Position of a SystemRecord in the currect level one position upwards or downwards

  • access: public
void setPosition (string $strIdToShift, [string $strDirection = "upwards"])
  • string $strIdToShift
  • string $strDirection: upwards || downwards
setStatus (line 262)

Negates the status of a systemRecord

  • access: public
bool setStatus ([string $strSystemid = ""])
  • string $strSystemid
setStrTextBase (line 515)

Sets the textbase, so the module used to load texts

  • access: protected
void setStrTextBase (string $strTextbase)
  • string $strTextbase
setSystemid (line 204)

Sets the current SystemID

  • final:
  • access: public
bool setSystemid (string $strID)
  • string $strID
setTemplateArea (line 533)

Sets the current area in the template object to have it work as expected

  • access: protected
void setTemplateArea (string $strArea)
  • string $strArea
validateForm (line 821)

Method used to validate posted form-values.

NOTE: To work with this method, the derived class needs to implement a method "getRequiredFields()", returning an array of field to validate. The array returned by getRequiredFields() has to fit the format [fieldname] = type, whereas type can be one of string, number, email, folder, systemid

The array saved in $this->$arrValidationErrors return by this method is empty in case of no validation Errors, otherwise an array with the structure [nonvalidField] = text from objText is being created.

  • access: protected
bool validateForm ()
validateSystemid (line 221)

Checks a systemid for the correct syntax

bool validateSystemid ( $strID, string $strtID)
  • string $strtID
  • $strID

Documentation generated on Mon, 12 Apr 2010 21:19:55 +0200 by phpDocumentor 1.4.3