BaseAdmin Class Reference
[Basic Modules]

Inheritance diagram for BaseAdmin:

List of all members.

---

Detailed Description

Basic Administration area.

Provides cache management, hit tracking, etc. Automatically protected by default.

Definition at line 8 of file base-admin.inc.php.

Public Member Functions
	init ($page=null, $vars=null)
	getPagesXml ()
	adds in default admin pages.
	initMainPage ()
	inits the main page, sets the title
	drawMainPage ()
	draws the main page, with links for cache, and hit trackingg
	initClearCachePage ()
	sets title
	drawClearCachePage ()
	does cache clearing page w/ confirmation form.
	createClearCacheForm ()
	creates cache clearing confirmation form
	initDeleteCachePage ()
	sets the title
	drawDeleteCachePage ()
	does the cache deletion w/ confirmation
	createDeleteCacheForm ($key)
	creates cache key deletion confirmation form
	initViewCachePage ()
	sets the title
	drawViewCachePage ()
	shows the cache data for the key, and shows delete link
	drawHitTrackingPage ()
	draws hit tracking page.
	initClearHitsPage ()
	sets title
	drawClearHitsPage ()
	does cache clearing page w/ confirmation form.
	createClearHitsForm ()
	creates cache clearing confirmation form

---

Member Function Documentation

BaseAdmin::createClearCacheForm (   )

creates cache clearing confirmation form Returns: a Form object Definition at line 121 of file base-admin.inc.php. References BaseModule::getUrl(). Referenced by drawClearCachePage().

BaseAdmin::createClearHitsForm (   )

creates cache clearing confirmation form Returns: a Form object Definition at line 310 of file base-admin.inc.php. References BaseModule::getUrl(). Referenced by drawClearHitsPage().

BaseAdmin::createDeleteCacheForm (  $  key  )

creates cache key deletion confirmation form Parameters: $key  the key to delete Returns: a Form class Definition at line 173 of file base-admin.inc.php. References BaseModule::getUrl(). Referenced by drawDeleteCachePage().

BaseAdmin::drawClearCachePage (   )

does cache clearing page w/ confirmation form. Definition at line 98 of file base-admin.inc.php. References createClearCacheForm(), and CacheBot::flush().

BaseAdmin::drawClearHitsPage (   )

does cache clearing page w/ confirmation form. Definition at line 285 of file base-admin.inc.php. References createClearHitsForm(), and Site::getSite().

BaseAdmin::drawDeleteCachePage (   )

does the cache deletion w/ confirmation Definition at line 147 of file base-admin.inc.php. References createDeleteCacheForm(), and CacheBot::delete().

BaseAdmin::drawHitTrackingPage (   )

draws hit tracking page. broken down into popular modules and popular modules/pages. Definition at line 220 of file base-admin.inc.php. References dbFetchAssoc(), and dbQuery().

BaseAdmin::drawMainPage (   )

draws the main page, with links for cache, and hit trackingg Reimplemented from BaseModule. Definition at line 70 of file base-admin.inc.php. References BaseModule::getLink().

BaseAdmin::drawViewCachePage (   )

shows the cache data for the key, and shows delete link Definition at line 199 of file base-admin.inc.php. References Util::dump(), CacheBot::get(), and BaseModule::getLink().

BaseAdmin::getPagesXml (   )

adds in default admin pages. pages added are: clearcache - a page that clears the entire cache deletecache - deletes a single key from the cache viewcache - view a single key's data from the cache hittracking - track hits across the site. clearhits - clear the hits from the tracking table Reimplemented from BaseModule. Definition at line 40 of file base-admin.inc.php.

BaseAdmin::init (  $  page = null, $  vars = null )

See also: BaseModule::init init is extended to force users to a) be logged in, and b) that they are admins to view any page in the module Reimplemented from BaseModule. Definition at line 15 of file base-admin.inc.php. References BaseModule::assertLogin().

BaseAdmin::initClearCachePage (   )

sets title Definition at line 90 of file base-admin.inc.php.

BaseAdmin::initClearHitsPage (   )

sets title Definition at line 277 of file base-admin.inc.php.

BaseAdmin::initDeleteCachePage (   )

sets the title Definition at line 137 of file base-admin.inc.php.

BaseAdmin::initMainPage (   )

inits the main page, sets the title Reimplemented from BaseModule. Definition at line 62 of file base-admin.inc.php.

BaseAdmin::initViewCachePage (   )

sets the title Definition at line 189 of file base-admin.inc.php.

---

The documentation for this class was generated from the following file:

• lib/modules/base-admin.inc.php

---