';
}
/**
* Set a specific tab header.
* i.e: echo $this->SetTabHeader('preferences',$this->Lang('preferences'));
*
* @final
* @param string The tab id
* @param string The tab title
* @param booleban A flag indicating wether this tab is active.
* @return string
*/
function SetTabHeader($tabid,$title,$active=false)
{
if( $active == FALSE )
{
$active = ($tabid == $this->__current_tab);
}
$a="";
if (TRUE == $active)
{
$a=" class='active'";
$this->mActiveTab = $tabid;
}
$tabid = strtolower(str_replace(' ','_',$tabid));
return '
'.$title.'
';
}
/**
* Output a string to stop the output of headers and close the necessary XHTML div.
*
* @final
* @return string
*/
function EndTabHeaders()
{
return "
';
}
/**
* Output a string to indicate the end of XHTML areas for tabs.
*
* @final
* @return string
*/
function EndTabContent()
{
return '
';
}
/**
* Output a string to indicate the start of the output for a specific tab
*
* @final
* @param string tabid (see SetTabHeader)
* @param arrray Parameters
* @return string
*/
function StartTab($tabid, $params = array())
{
if (FALSE == empty($this->mActiveTab) && $tabid == $this->mActiveTab && FALSE == empty($params['tab_message'])) {
$message = $this->ShowMessage($this->Lang($params['tab_message']));
} else {
$message = '';
}
return ''.$message;
}
/**
* Output a string to indicate the end of the output for a specific tab.
*
* @final
* @return string
*/
function EndTab()
{
return '
';
}
/**
* ------------------------------------------------------------------
* Other Functions
* ------------------------------------------------------------------
*/
/**
*
* Called in the admin theme for every installed module, this method allows
* the module to output style information for use in the admin theme.
*
* @abstract
* @returns string css text.
*/
function AdminStyle()
{
return '';
}
/**
* Set the content-type header.
*
* @abstract
* @param string Value to set the content-type header too
* @return string valid content type string.
*/
function SetContentType($contenttype)
{
$variables = cmsms()->variables;
$variables['content-type'] = $contenttype;
}
/**
* Put an event into the audit (admin) log. This should be
* done on most admin events for consistency.
*
* @final
* @param string item id, useful for working on a specific record (i.e article or user)
* @param string item name
* @param string action name
* @return void
*/
final public function Audit($itemid, $itemname, $action)
{
audit($itemid,$itemname,$action);
}
/**
* Creates a string containing links to all the pages.
*
* @deprecated
* @param string The id given to the module on execution
* @param string The action that this form should do when the form is submitted
* @param string The id to eventually return to when the module is finished it's task
* @param string the current page to display
* @param string the amount of items being listed
* @param string the amount of items to list per page
* @param boolean A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)
* @return string
*/
function CreatePagination($id, $action, $returnid, $page, $totalrows, $limit, $inline=false)
{
$this->LoadMiscMethods();
return cms_module_CreatePagination($this, $id, $action, $returnid, $page, $totalrows, $limit, $inline);
}
/**
* ShowMessage
* Returns a formatted page status message
*
* @final
* @param message - Message to be shown
* @return string
*/
function ShowMessage($message)
{
$gCms = cmsms();
if (isset($gCms->variables['admintheme'])) {
$admintheme =& $gCms->variables['admintheme']; //php4 friendly
return $admintheme->ShowMessage($message);
}
return '';
}
/**
* Set a display message.
*
* @since 1.11
* @author Robert Campbell
* @param mixed The message. Accepts either an array of messages or a single string.
*/
public function SetMessage($str)
{
if( !is_array($this->__messages) ) $this->__messages = array();
if( !is_array($str) ) $str = array($str);
$this->__messages = array_merge($this->__messages,$str);
}
/**
* ShowErrors
* Outputs errors in a nice error box with a troubleshooting link to the wiki
*
* @final
* @param errors - array or string of errors to be shown
* @return string
*/
function ShowErrors($errors)
{
$theme = cms_utils::get_theme_object();
if( is_object($theme) ) {
return $theme->ShowErrors($errors);
}
return '';
}
/**
* Set an error message.
*
* @since 1.11
* @author Robert Campbell
* @param mixed The message. Accepts either an array of messages or a single string.
*/
public function SetError($str)
{
if( !is_array($this->__errors) ) $this->__errors = array();
if( !is_array($str) ) $str = array($str);
$this->__errors = array_merge($this->__errors,$str);
}
/**
* ------------------------------------------------------------------
* Permission Functions
* ------------------------------------------------------------------
*/
/**
* Create's a new permission for use by the module.
*
* @final
* @param string Name of the permission to create
* @param string Description of the permission
* @return void
*/
final public function CreatePermission($permission_name, $permission_text)
{
$gCms = cmsms();
$db = $gCms->GetDB();
$query = "SELECT permission_id FROM ".cms_db_prefix()."permissions WHERE permission_name = ?";
$count = $db->GetOne($query, array($permission_name));
if (intval($count) == 0)
{
$new_id = $db->GenID(cms_db_prefix()."permissions_seq");
$time = $db->DBTimeStamp(time());
$query = "INSERT INTO ".cms_db_prefix()."permissions (permission_id, permission_name, permission_text, create_date, modified_date) VALUES (?,?,?,".$time.",".$time.")";
$db->Execute($query, array($new_id, $permission_name, $permission_text));
}
}
/**
* Checks a permission against the currently logged in user.
*
* @final
* @param string The name of the permission to check against the current user
* @return boolean
*/
final public function CheckPermission($permission_name)
{
$userid = get_userid(false);
return check_permission($userid, $permission_name);
}
/**
* Removes a permission from the system. If recreated, the
* permission would have to be set to all groups again.
*
* @final
* @param string The name of the permission to remove
* @return void
*/
final public function RemovePermission($permission_name)
{
cms_mapi_remove_permission($permission_name);
}
/**
* ------------------------------------------------------------------
* Preference Functions
* ------------------------------------------------------------------
*/
/**
* Returns a module preference if it exists.
*
* @final
* @param string The name of the preference to check
* @param string The default value, just in case it doesn't exist
* @return string
*/
final public function GetPreference($preference_name, $defaultvalue='')
{
return get_site_preference($this->GetName() . "_mapi_pref_" . $preference_name, $defaultvalue);
}
/**
* Sets a module preference.
*
* @final
* @param string The name of the preference to set
* @param string The value to set it to
* @return void
*/
final public function SetPreference($preference_name, $value)
{
return set_site_preference($this->GetName() . "_mapi_pref_" . $preference_name, $value);
}
/**
* Removes a module preference. If no preference name
* is specified, removes all module preferences.
*
* @final
* @param string The name of the preference to remove. If empty all preferences associated with the module are removed.
* @return boolean
*/
final public function RemovePreference($preference_name='')
{
if( $preference_name == '' )
{
return remove_site_preference($this->GetName()."_mapi_pref_",true);
}
return remove_site_preference($this->GetName() . "_mapi_pref_" . $preference_name);
}
/**
* ------------------------------------------------------------------
* Event Handler Related functions
* ------------------------------------------------------------------
*/
/**
* Add an event handler for an existing eg event.
*
* @final
* @param string modulename The name of the module sending the event, or 'Core'
* @param string $eventname The name of the event
* @param boolean $removable Can this event be removed from the list?
* @returns mixed If successful, true. If it fails, false.
*/
final public function AddEventHandler( $modulename, $eventname, $removable = true )
{
Events::AddEventHandler( $modulename, $eventname, false, $this->GetName(), $removable );
}
/**
* Inform the system about a new event that can be generated
*
* @final
* @param string The name of the event
* @returns nothing
*/
final public function CreateEvent( $eventname )
{
Events::CreateEvent($this->GetName(), $eventname);
}
/**
* An event that this module is listening to has occurred, and should be handled.
* This method must be over-ridden if this module is capable of handling events.
* of any type.
*
* The default behavior of this method is to check for a function called event.