RMPlugin Class Reference

Inheritance diagram for RMPlugin:

Public Member Functions
	__construct ($id=null)
	delete ()
	get_info ($name)
	id ()
	load_from_dir ($dir)
	on_activate ($q)
	on_install ()
	on_uninstall ()
	on_update ()
	options ()
	plugin ($dir= '')
	save ()
Public Member Functions inherited from RMObject
	_loadFilters ()
	assignVar ($key, $value)
	assignVars ($var_arr)
	cleanVars ()
	errors ($html=true)
	getErrors ()
	getHtmlErrors ()
	getLogger ($ashtml=true)
	getValues ($keys=null, $format= 's', $maxDepth=1)
	getVar ($key, $format= 's')
	getVars ($formated=false, $format= 's')
	id ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options= '')
	isDirty ()
	isNew ()
	registerFilter ($filtername)
	rmClone ()
	setDirty ()
	setErrors ($err_str)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
	setNew ()
	setVar ($key, $value, $not_gpc=false)
	setVarLen ($var, $len=null)
	setVarRequired ($var, $required)
	setVars ($var_arr, $not_gpc=false)
	setVarType ($var, $type)
	unsetDirty ()
	unsetNew ()

Private Member Functions
	insert_configs ()

Private Attributes
	$dir = ''
	$plugin
	$settings = array()

Additional Inherited Members
Public Attributes inherited from RMObject
	$cleanVars = array()
Protected Member Functions inherited from RMObject
	addError ($text)
	clear_vars ()
	clearLogger ()
	deleteFromTable ()
	getColumns ()
	initVarsFromTable ()
	loadValues ($id)
	loadValuesArray ($values)
	loadValuesFiltered ($filter='')
	logger ($event, $style='')
	saveToTable ()
	updateTable ()
	varIsset ($var)
Protected Attributes inherited from RMObject
	$_dbtable = ''
	$_log = array()
	$db = null
	$primary = 'id'
	$vars = array()

Detailed Description

Class to manage plugins objects

Definition at line 15 of file plugin.php.

Constructor & Destructor Documentation

RMPlugin::__construct

(

$id = null

)

Definition at line 24 of file plugin.php.

References $id, RMObject\getVar(), RMObject\initVarsFromTable(), load_from_dir(), RMObject\loadValues(), RMObject\setNew(), and RMObject\unsetNew().

Here is the call graph for this function:

Member Function Documentation

RMPlugin::delete

(

)

Definition at line 183 of file plugin.php.

References RMObject\$db, $dir, $sql, RMObject\addError(), RMObject\deleteFromTable(), and plugin().

Here is the call graph for this function:

RMPlugin::get_info

(

$name

)

Definition at line 100 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::id

(

)

Definition at line 80 of file plugin.php.

References RMObject\getVar().

Here is the call graph for this function:

RMPlugin::insert_configs ( )

private

Definition at line 124 of file plugin.php.

References RMObject\$db, $dir, $sql, RMObject\addError(), RMFunctions\get(), and plugin().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

RMPlugin::load_from_dir

(

$dir

)

This method must be called before to access the plugin methods

Parameters

string

Directory name

Definition at line 57 of file plugin.php.

References $class, $dir, $path, plugin(), RMCPATH, and RMObject\setVar().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

RMPlugin::on_activate

(

$q

)

Definition at line 116 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::on_install

(

)

Definition at line 104 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::on_uninstall

(

)

Definition at line 112 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::on_update

(

)

Definition at line 108 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::options

(

)

Definition at line 120 of file plugin.php.

References plugin().

Here is the call graph for this function:

RMPlugin::plugin

(

$dir = ''

)

Definition at line 84 of file plugin.php.

References $class, $dir, $plugin, RMObject\getVar(), and RMCPATH.

Referenced by delete(), get_info(), insert_configs(), load_from_dir(), on_activate(), on_install(), on_uninstall(), on_update(), and options().

Here is the call graph for this function:

Here is the caller graph for this function:

RMPlugin::save

(

)

Definition at line 172 of file plugin.php.

References insert_configs(), RMObject\isNew(), RMObject\saveToTable(), and RMObject\updateTable().

Here is the call graph for this function:

Member Data Documentation

RMPlugin::$dir = ''

private

Definition at line 17 of file plugin.php.

Referenced by delete(), insert_configs(), load_from_dir(), and plugin().

RMPlugin::$plugin

private

The plugin object

Definition at line 22 of file plugin.php.

Referenced by plugin().

RMPlugin::$settings = array()

private

Definition at line 18 of file plugin.php.

---

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

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/plugin.php