Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

BaseCrons Class Reference
[Basic Modules]

Inheritance diagram for BaseCrons:

MyModule BaseModule List of all members.

Detailed Description

Pages that can be used as cron jobs.

Provides ip based restrictions, defaults to blank template, provides hooks to email admins.

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

Public Member Functions

 init ($page=null, $vars=null)
 preps all pages for crons
 draw ()
 draws our page w/ title and status.
 emailAdmins ($subject, $body)
 email a message to all the admins

Protected Member Functions

 getAdmins ()
 attempts to get a list of admins by directly hitting users table.


Member Function Documentation

BaseCrons::draw  ) 
 

draws our page w/ title and status.

very basic.

Reimplemented from BaseModule.

Definition at line 32 of file base-crons.inc.php.

BaseCrons::emailAdmins subject,
body
 

email a message to all the admins

Parameters:
$subject the subject of the message
$body the body of the message

Definition at line 65 of file base-crons.inc.php.

References getAdmins().

BaseCrons::getAdmins  )  [protected]
 

attempts to get a list of admins by directly hitting users table.

you may want to override this with more specific behaviour for your site.

Returns:
$an array of Users that are admins

Definition at line 46 of file base-crons.inc.php.

References dbFetchAssoc(), and dbQuery().

Referenced by emailAdmins().

BaseCrons::init page = null,
vars = null
 

preps all pages for crons

sets template to blank, makes sure you're an admin and/or from the right IP address ( as per 'cron_request_ip' config value)

See also:
BaseModule::init

Reimplemented from BaseModule.

Definition at line 16 of file base-crons.inc.php.

References Config::get(), and BaseModule::setTemplate().


The documentation for this class was generated from the following file:
Generated on Fri Oct 27 12:26:40 2006 for BaseJumper by doxygen 1.3.9.1