Docs For Class class

Class class_portal

Description

Base class for all module-classes in the portal

abstract:

Located in /portal/class_portal.php (line 15)

Direct descendents

Class	Description
class_element_portal	Base Class for all portal-elements
class_modul_downloads_portal	Downloads Portal. Generates a list of available downloads
class_modul_faqs_portal	Portal-class of the faqs. Handles the printing of faqs lists / detail
class_modul_gallery_portal	Gallery Portal. Loads the thumbnails or detail-views
class_modul_guestbook_portal	Portal-class of the guestbook. Handles postings
class_modul_navigation_portal	Portal-part of the navigation. Creates the different navigation-views as sitemap or tree
class_modul_news_portal	Portal-class of the news. Handles thd printing of news lists / detail
class_modul_news_portal_xml	Portal-class of the news.
class_modul_pages_portal	Handles the loading of the pages - loads the elements, passes control to them and returns the complete page ready for output
class_modul_postacomment_portal	Portal-class of the postacomment. Handles the printing of postacomment lists / detail
class_modul_postacomment_portal_xml	Portal-class of the postacomment-module Serves xml-requests, e.g. saves a sent comment
class_modul_rating_portal_xml	Portal-class of the rating-module Serves xml-requests, e.g. saves a sent rating
class_modul_search_portal	Portal-Class of the search module. Does all the searching in the database
class_modul_search_portal_xml	Portal-class of the search.
class_modul_stats_portal	Portal-Class of the stats module. Invokes the logging of requests to the database
class_formular_kontakt	Portal-Class to provide a simple contact-form
class_modul_basedownloads_search	Search plugin of the downloads-module.
class_modul_downloads_search	Search plugin of the downloads-module.
class_modul_faqs_search	Search plugin of the faqs-module.
class_modul_gallery_search	Search plugin of the gallery-module.
class_modul_guestbook_search	Search plugin of the guestbook-module.
class_modul_news_search	Search plugin of the news-module.
class_modul_pages_search	Search plugin of the pages-module. Searches the configured page-elements and the pages-data.

Variable Summary

mixed $arrElementData

mixed $arrModule

class_config $objConfig

class_db $objDB

class_rights $objRights

class_session $objSession

class_template $objTemplate

class_toolkit_portal $objToolkit

mixed $strOutput

mixed $strTemplateArea

Method Summary

class_portal __construct ([mixed $arrModule = array()], [ $arrElementData = array()], [string $strSystemid = ""])

fillTemplate ( $arrContent, $strIdentifier)

bool flushCompletePagesCache ()

bool flushPageFromPagesCache (string $strPagename)

string generateSystemid ()

string getAction ()

mixed getAllParams ()

string getArrModule (string $strKey)

int getEditDate ([string $strSystemid = ""])

string getHistory ([int $intPosition = 0])

class_lang_wrapper getLangWrapper ()

string getLastEditUser ([string $strSystemid = ""])

mixed getModuleData (string $strName, [bool $bitCache = true])

string getModuleOutput ()

string getModuleSystemid (string $strModule)

object getObjRights ()

obj getObjText ()

string getPagename ()

string getParam (string $strKey)

mixed getPathArray ([string $strSystemid = ""])

string getPortalLanguage ()

string getPrevId ([string $strSystemid = ""])

int getStatus ([string $strSystemid = ""])

string getSystemid ()

mixed getSystemRecord ([string $strSystemid = ""])

string getText (string $strName, [string $strModule = ""], [string $strArea = ""])

void portalReload (string $strUrlToLoad)

bool setEditDate ([string $strSystemid = ""])

void setHistory ()

void setParam ( $strKey, mixed $mixedValue, string $strName)

bool setStatus ([string $strSystemid = ""])

bool setSystemid (string $strID)

bool validateSystemid ( $strID, string $strtID)

Variables

mixed $arrElementData (line 76)

access: protected

Redefined in descendants as:

class_element_portal::$arrElementData

mixed $arrModule (line 73)

access: protected

class_config $objConfig = null (line 22)

Instance of class_config

access: protected

class_db $objDB = null (line 28)

Instance of class_db

access: protected

class_rights $objRights = null (line 52)

Instance of class_rights

access: protected

class_session $objSession = null (line 40)

Instance of class_session

access: protected

class_template $objTemplate = null (line 46)

Instance of class_template

access: protected

class_toolkit_portal $objToolkit = null (line 34)

Instance of class_toolkit_portal

access: protected

mixed $strOutput (line 75)

access: protected

mixed $strTemplateArea (line 74)

access: protected

Methods

Constructor __construct (line 84)

Constructor

access: public

class_portal __construct ([mixed $arrModule = array()], [ $arrElementData = array()], [string $strSystemid = ""])

mixed $arrModule
string $strSystemid
$arrElementData

Redefined in descendants as:

class_element_portal::__construct() : Constructor
class_element_basedownloads::__construct() : Contructor
class_element_baselatestlist::__construct() : Contructor
class_element_baseregistration::__construct() : Constructor
class_element_basetophitlist::__construct() : Contructor
class_element_basetopratelist::__construct() : Contructor
class_element_baseupload::__construct() : Constructor
class_element_downloads::__construct() : Contructor
class_element_downloads_toplist::__construct() : Contructor
class_element_faqs::__construct() : Contructor
class_element_formular::__construct() : Constructor
class_element_gallery::__construct() : Contructor
class_element_guestbook::__construct() : Contructor
class_element_image::__construct() : Constructor
class_element_imagelightbox::__construct() : Constructor
class_element_languageswitch::__construct() : Constructor
class_element_lastmodified::__construct() : Constructor
class_element_mediaplayer::__construct() : Constructor
class_element_mybase::__construct() : Constructor
class_element_navigation::__construct() : Contructor
class_element_news::__construct() : Contructor
class_element_paragraph::__construct() : Constructor
class_element_portallogin::__construct() : Constructor
class_element_portalregistration::__construct() : Constructor
class_element_portalstats::__construct() : Constructor
class_element_portalupload::__construct() : Constructor
class_element_postacomment::__construct() : Contructor
class_element_rendertext::__construct() : Constructor
class_element_row::__construct() : Constructor
class_element_rssfeed::__construct() : Constructor
class_element_search::__construct() : Constructor
class_element_tagcloud::__construct() : Constructor
class_element_tagto::__construct() : Constructor
class_element_tellafriend::__construct() : Constructor
class_element_textticker::__construct() : Constructor
class_modul_downloads_portal::__construct() : Constructor
class_modul_basedownloads_portal::__construct() : Constructor
class_modul_faqs_portal::__construct() : Constructor
class_modul_gallery_portal::__construct() : Constructor
class_modul_guestbook_portal::__construct() : Constructor
class_modul_navigation_portal::__construct() : Constructor
class_modul_news_portal::__construct() : Constructor
class_modul_news_portal_xml::__construct() : Constructor
class_modul_pages_portal::__construct()
class_modul_postacomment_portal::__construct() : Constructor
class_modul_postacomment_portal_xml::__construct() : Constructor
class_modul_rating_portal_xml::__construct() : Constructor
class_modul_search_portal::__construct() : Constructor
class_modul_search_portal_xml::__construct() : Constructor
class_modul_stats_portal::__construct() : Constructor
class_formular_kontakt::__construct() : Contructor
class_modul_basedownloads_search::__construct()
class_modul_downloads_search::__construct()
class_modul_faqs_search::__construct()
class_modul_gallery_search::__construct()
class_modul_guestbook_search::__construct()
class_modul_news_search::__construct()
class_modul_pages_search::__construct()

fillTemplate (line 482)

Wrapper to class_template::fillTemplate().

Includes the passing of an class_lang_wrapper by default. NOTE: Removes placeholders. If unwanted, call directly.

see: class_template::fill_template
since: 3.2.0
access: public

fillTemplate ( $arrContent, $strIdentifier)

$arrContent
$strIdentifier

flushCompletePagesCache (line 494)

Deletes the complete Pages-Cache

access: public

bool flushCompletePagesCache ()

flushPageFromPagesCache (line 505)

Removes one page from the cache

access: public

bool flushPageFromPagesCache (string $strPagename)

string $strPagename

generateSystemid (line 231)

Generates a new SystemID

return: The new SystemID
final:
access: public

string generateSystemid ()

getAction (line 180)

returns the action used for the current request

access: public

string getAction ()

getAllParams (line 171)

Returns the complete Params-Array

access: public

mixed getAllParams ()

getArrModule (line 367)

Returns a value from the $arrModule array.

If the requested key not exists, returns ""

access: public

string getArrModule (string $strKey)

string $strKey

getEditDate (line 286)

Returns the time the record was last edited

access: public

int getEditDate ([string $strSystemid = ""])

string $strSystemid

getHistory (line 415)

Returns the URL at the given position (from HistoryArray)

access: protected

string getHistory ([int $intPosition = 0])

int $intPosition

getLangWrapper (line 467)

Returns an instance of class_lang_wrapper, to be used with class_template::fill_array()

access: public

class_lang_wrapper getLangWrapper ()

getLastEditUser (line 274)

Returns the name of the user who last edited the record

access: public

string getLastEditUser ([string $strSystemid = ""])

string $strSystemid

getModuleData (line 335)

Returns the data for a registered module

access: public

mixed getModuleData (string $strName, [bool $bitCache = true])

string $strName
bool $bitCache

getModuleOutput (line 545)

Returns the data created by the child-class

access: public

string getModuleOutput ()

getModuleSystemid (line 345)

Returns the SystemID of a installed module

access: public

string getModuleSystemid (string $strModule)

string $strModule

getObjRights (line 240)

Returns the current instance of the class_rights

access: public

object getObjRights ()

getObjText (line 448)

Returns the current Text-Object Instance

access: protected

obj getObjText ()

getPagename (line 515)

Returns the name of the page to be loaded

access: public

string getPagename ()

getParam (line 159)

Returns a value from the params-Array

return: else ""
access: public

string getParam (string $strKey)

string $strKey

getPathArray (line 356)

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

access: public

mixed getPathArray ([string $strSystemid = ""])

string $strSystemid

getPortalLanguage (line 457)

Loads the language to load content

access: public

string getPortalLanguage ()

getPrevId (line 310)

Gets the Prev-ID of a record

access: public

string getPrevId ([string $strSystemid = ""])

string $strSystemid

getStatus (line 262)

Gets the status of a systemRecord

access: public

int getStatus ([string $strSystemid = ""])

string $strSystemid

getSystemid (line 221)

Returns the current SystemID

final:
access: public

string getSystemid ()

getSystemRecord (line 322)

Return a complete SystemRecord

access: public

mixed getSystemRecord ([string $strSystemid = ""])

string $strSystemid

getText (line 432)

Used to get Text out of Textfiles

access: public

string getText (string $strName, [string $strModule = ""], [string $strArea = ""])

string $strName
string $strModule
string $strArea

portalReload (line 555)

Use this method to do a header-redirect to a specific url.

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

access: public

void portalReload (string $strUrlToLoad)

string $strUrlToLoad

setEditDate (line 298)

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

access: public

bool setEditDate ([string $strSystemid = ""])

string $strSystemid

setHistory (line 382)

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

access: protected

void setHistory ()

setParam (line 149)

Writes a value to the params-array

access: public

void setParam ( $strKey, mixed $mixedValue, string $strName)

string $strName: Key
mixed $mixedValue: Value
$strKey

setStatus (line 250)

Negates the status of a systemRecord

access: public

bool setStatus ([string $strSystemid = ""])

string $strSystemid

setSystemid (line 194)

Sets the current SystemID

final:
access: public

bool setSystemid (string $strID)

string $strID

validateSystemid (line 211)

Checks a systemid for the correct syntax

deprecated: use validateSytemid directly
final:
access: public

bool validateSystemid ( $strID, string $strtID)

string $strtID
$strID

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