*
* @license http://nucleuscms.org/license.txt GNU General Public License
* @copyright Copyright (C) 2002-2009 The Nucleus Group
- * @version $Id: PLUGIN.php 1630 2012-01-28 12:16:14Z sakamocchi $
+ * @version $Id: PLUGIN.php 1866 2012-05-20 13:21:55Z sakamocchi $
*/
-class NucleusPlugin
+abstract class NucleusPlugin
{
- // these functions _have_ to be redefined in your plugin
- function getName()
+ // these public functions should to be redefined in your plugin
+ public function getName()
{
- return 'Undefined';
+ return __CLASS__;
}
- function getAuthor()
+ public function getAuthor()
{
return 'Undefined';
}
- function getURL()
+ public function getURL()
{
return 'Undefined';
}
- function getVersion()
+ public function getVersion()
{
return '0.0';
}
- function getDescription()
+ public function getDescription()
{
return 'Undefined';
}
- // these function _may_ be redefined in your plugin
+ // these final public function _may_ be redefined in your plugin
- function getMinNucleusVersion()
+ public function getMinNucleusVersion()
{
return 150;
}
- function getMinNucleusPatchLevel()
+ public function getMinNucleusPatchLevel()
{
return 0;
}
- function getEventList()
+ public function getEventList()
{
return array();
}
- function getTableList()
+ public function getTableList()
{
return array();
}
- function hasAdminArea()
+ public function hasAdminArea()
{
return 0;
}
- function install()
+ public function install()
{
+ return;
}
- function unInstall()
+ public function unInstall()
{
+ return;
}
- function init()
+ public function init()
{
+ return;
}
- function doSkinVar($skinType)
+ public function doSkinVar($skinType)
{
+ return;
}
- function doTemplateVar(&$item)
+ public function doTemplateVar(&$item)
{
$args = func_get_args();
array_shift($args);
array_unshift($args, 'template');
- call_user_func_array(array(&$this,'doSkinVar'),$args);
+ call_user_func_array(array($this, 'doSkinVar'), $args);
+ return;
}
- function doTemplateCommentsVar(&$item, &$comment)
+ public function doTemplateCommentsVar(&$item, &$comment)
{
$args = func_get_args();
array_shift($args);
array_shift($args);
array_unshift($args, 'template');
- call_user_func_array(array(&$this,'doSkinVar'),$args);
+ call_user_func_array(array($this, 'doSkinVar'), $args);
+ return;
}
- function doAction($type)
+ public function doAction($type)
{
return _ERROR_PLUGIN_NOSUCHACTION;
}
- function doIf($key,$value)
+ public function doIf($key,$value)
{
return false;
}
- function doItemVar (&$item)
+ public function doItemVar (&$item)
{
+ return;
}
/**
*
* @returns 1 if the feature is reported, 0 if not
* @param $feature
- * Name of the feature. See plugin documentation for more info
- * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names
- * 'HelpPage' -> if the plugin provides a helppage
- * 'SqlApi' -> if the plugin uses the complete sql_* api (must also require nucleuscms 3.5)
+ * Name of the feature. See plugin documentation for more info
+ * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names
+ * 'HelpPage' -> if the plugin provides a helppage
+ * 'SqlApi' -> if the plugin uses the complete sql_* or DB::* api (must also require nucleuscms 3.5)
*/
- function supportsFeature($feature)
+ public function supportsFeature($feature)
{
return 0;
}
/**
- * Report a list of plugin that is required to function
+ * Report a list of plugin that is required to final public function
*
* @returns an array of names of plugin, an empty array indicates no dependency
*/
- function getPluginDep()
+ public function getPluginDep()
{
return array();
}
- // these helper functions should not be redefined in your plugin
+ // these helper final public functions should not be redefined in your plugin
/**
* Creates a new option for this plugin
* @param value
* Initial value for the option (max. value length is 128 characters)
*/
- function createOption($name, $desc, $type, $defValue = '', $typeExtras = '')
+ final public function createOption($name, $desc, $type, $defValue = '', $typeExtras = '')
{
- return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);
+ return $this->create_option('global', $name, $desc, $type, $defValue, $typeExtras);
}
- function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '')
+ final public function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '')
{
- return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);
+ return $this->create_option('blog', $name, $desc, $type, $defValue, $typeExtras);
}
- function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '')
+ final public function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '')
{
- return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);
+ return $this->create_option('member', $name, $desc, $type, $defValue, $typeExtras);
}
- function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '')
+ final public function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '')
{
- return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);
+ return $this->create_option('category', $name, $desc, $type, $defValue, $typeExtras);
}
- function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '')
+ final public function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '')
{
- return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);
+ return $this->create_option('item', $name, $desc, $type, $defValue, $typeExtras);
}
/**
*
* Note: Options get erased automatically on plugin uninstall
*/
- function deleteOption($name)
+ final public function deleteOption($name)
{
- return $this->_deleteOption('global', $name);
+ return $this->delete_option('global', $name);
}
- function deleteBlogOption($name)
+ final public function deleteBlogOption($name)
{
- return $this->_deleteOption('blog', $name);
+ return $this->delete_option('blog', $name);
}
- function deleteMemberOption($name)
+ final public function deleteMemberOption($name)
{
- return $this->_deleteOption('member', $name);
+ return $this->delete_option('member', $name);
}
- function deleteCategoryOption($name)
+ final public function deleteCategoryOption($name)
{
- return $this->_deleteOption('category', $name);
+ return $this->delete_option('category', $name);
}
- function deleteItemOption($name)
+ final public function deleteItemOption($name)
{
- return $this->_deleteOption('item', $name);
+ return $this->delete_option('item', $name);
}
/**
* Sets the value of an option to something new
*/
- function setOption($name, $value)
+ final public function setOption($name, $value)
{
- return $this->_setOption('global', 0, $name, $value);
+ return $this->set_option('global', 0, $name, $value);
}
- function setBlogOption($blogid, $name, $value)
+ final public function setBlogOption($blogid, $name, $value)
{
- return $this->_setOption('blog', $blogid, $name, $value);
+ return $this->set_option('blog', $blogid, $name, $value);
}
- function setMemberOption($memberid, $name, $value)
+ final public function setMemberOption($memberid, $name, $value)
{
- return $this->_setOption('member', $memberid, $name, $value);
+ return $this->set_option('member', $memberid, $name, $value);
}
- function setCategoryOption($catid, $name, $value)
+ final public function setCategoryOption($catid, $name, $value)
{
- return $this->_setOption('category', $catid, $name, $value);
+ return $this->set_option('category', $catid, $name, $value);
}
- function setItemOption($itemid, $name, $value) {
- return $this->_setOption('item', $itemid, $name, $value);
+ final public function setItemOption($itemid, $name, $value) {
+ return $this->set_option('item', $itemid, $name, $value);
}
/**
* Retrieves the current value for an option
*/
- function getOption($name)
+ final public function getOption($name)
{
// only request the options the very first time. On subsequent requests
// the static collection is used to save SQL queries.
if ( $this->plugin_options == 0 )
{
$this->plugin_options = array();
- $query = sql_query(
- 'SELECT d.oname as name, o.ovalue as value '.
- 'FROM '.
- sql_table('plugin_option').' o, '.
- sql_table('plugin_option_desc').' d '.
- 'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'
- );
- while ( $row = sql_fetch_object($query) )
+
+ $query = "SELECT d.oname as name, o.ovalue as value FROM %s o, %s d WHERE d.opid=%d AND d.oid=o.oid;";
+ $query = sprintf($query, sql_table('plugin_option'), sql_table('plugin_option_desc'), (integer) $this->plugid);
+ $result = DB::getResult($query);
+ foreach ( $result as $row )
{
- $this->plugin_options[strtolower($row->name)] = $row->value;
+ $this->plugin_options[strtolower($row['name'])] = $row['value'];
}
}
if ( isset($this->plugin_options[strtolower($name)]) )
}
else
{
- return $this->_getOption('global', 0, $name);
+ return $this->get_option('global', 0, $name);
}
}
- function getBlogOption($blogid, $name)
+ final public function getBlogOption($blogid, $name)
{
- return $this->_getOption('blog', $blogid, $name);
+ return $this->get_option('blog', $blogid, $name);
}
- function getMemberOption($memberid, $name)
+ final public function getMemberOption($memberid, $name)
{
- return $this->_getOption('member', $memberid, $name);
+ return $this->get_option('member', $memberid, $name);
}
- function getCategoryOption($catid, $name)
+ final public function getCategoryOption($catid, $name)
{
- return $this->_getOption('category', $catid, $name);
+ return $this->get_option('category', $catid, $name);
}
- function getItemOption($itemid, $name)
+ final public function getItemOption($itemid, $name)
{
- return $this->_getOption('item', $itemid, $name);
+ return $this->get_option('item', $itemid, $name);
}
/**
* Retrieves an associative array with the option value for each
* context id
*/
- function getAllBlogOptions($name)
+ final public function getAllBlogOptions($name)
{
- return $this->_getAllOptions('blog', $name);
+ return $this->get_all_options('blog', $name);
}
- function getAllMemberOptions($name)
+ final public function getAllMemberOptions($name)
{
- return $this->_getAllOptions('member', $name);
+ return $this->get_all_options('member', $name);
}
- function getAllCategoryOptions($name)
+ final public function getAllCategoryOptions($name)
{
- return $this->_getAllOptions('category', $name);
+ return $this->get_all_options('category', $name);
}
- function getAllItemOptions($name)
+ final public function getAllItemOptions($name)
{
- return $this->_getAllOptions('item', $name);
+ return $this->get_all_options('item', $name);
}
/**
* Retrieves an indexed array with the top (or bottom) of an option
- * (delegates to _getOptionTop())
+ * (delegates to getOptionTop())
*/
- function getBlogOptionTop($name, $amount = 10, $sort = 'desc')
+ final public function getBlogOptionTop($name, $amount = 10, $sort = 'desc')
{
- return $this->_getOptionTop('blog', $name, $amount, $sort);
+ return $this->get_option_top('blog', $name, $amount, $sort);
}
- function getMemberOptionTop($name, $amount = 10, $sort = 'desc')
+ final public function getMemberOptionTop($name, $amount = 10, $sort = 'desc')
{
- return $this->_getOptionTop('member', $name, $amount, $sort);
+ return $this->get_option_top('member', $name, $amount, $sort);
}
- function getCategoryOptionTop($name, $amount = 10, $sort = 'desc')
+ final public function getCategoryOptionTop($name, $amount = 10, $sort = 'desc')
{
- return $this->_getOptionTop('category', $name, $amount, $sort);
+ return $this->get_option_top('category', $name, $amount, $sort);
}
- function getItemOptionTop($name, $amount = 10, $sort = 'desc')
+ final public function getItemOptionTop($name, $amount = 10, $sort = 'desc')
{
- return $this->_getOptionTop('item', $name, $amount, $sort);
+ return $this->get_option_top('item', $name, $amount, $sort);
}
/**
- * Returns the plugin ID
- *
- * public
+ * NucleusPlugin::getID()
+ * get id for this plugin
+ *
+ * @access public
+ * @param void
+ * @return integer this plugid id
*/
- function getID()
+ final public function getID()
{
- return $this->plugid;
+ return (integer) $this->plugid;
+ }
+
+ /**
+ * NucleusPlugin::setID()
+ * set favorite id for this plugin
+ *
+ * @access public
+ * @param integer $plugid favorite id for plugin
+ * @return void
+ */
+ final public function setID($plugid)
+ {
+ $this->plugid = (integer) $plugid;
+ return;
}
/**
*
* public
*/
- function getAdminURL()
+ final public function getAdminURL()
{
global $CONF;
return $CONF['PluginURL'] . $this->getShortName() . '/';
*
* public
*/
- function getDirectory()
+ final public function getDirectory()
{
global $DIR_PLUGINS;
return $DIR_PLUGINS . $this->getShortName() . '/';
*
* public
*/
- function getShortName()
+ final public function getShortName()
{
return str_replace('np_','',strtolower(get_class($this)));
}
*
* public
**/
- function clearOptionValueCache()
+ final public function clearOptionValueCache()
{
- $this->_aOptionValues = array();
+ $this->option_values = array();
$this->plugin_options = 0;
+ return;
}
// internal functions of the class starts here
-
- var $_aOptionValues; // oid_contextid => value
- var $_aOptionToInfo; // context_name => array('oid' => ..., 'default' => ...)
- var $plugin_options; // see getOption()
- var $plugid; // plugin id
+ protected $option_values; // oid_contextid => value
+ protected $option_info; // context_name => array('oid' => ..., 'default' => ...)
+ protected $plugin_options; // see getOption()
+ protected $plugid; // plugin id
/**
* Class constructor: Initializes some internal data
*/
- function NucleusPlugin()
+ public function __construct()
{
- $this->_aOptionValues = array(); // oid_contextid => value
- $this->_aOptionToInfo = array(); // context_name => array('oid' => ..., 'default' => ...)
+ $this->option_values = array(); // oid_contextid => value
+ $this->option_info = array(); // context_name => array('oid' => ..., 'default' => ...)
$this->plugin_options = 0;
}
* @return array array with both values and contextid's
* @access private
*/
- function _getOptionTop($context, $name, $amount = 10, $sort = 'desc')
+ final protected function get_option_top($context, $name, $amount = 10, $sort = 'desc')
{
if ( ($sort != 'desc') && ($sort != 'asc') )
{
$sort= 'desc';
}
- $oid = $this->_getOID($context, $name);
+ $oid = $this->get_option_id($context, $name);
// retrieve the data and return
- $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;
- $query = sql_query($q);
+ $query = "SELECT otype, oextra FROM %s WHERE oid = %d;";
+ $query = sprintf($query, sql_table('plugin_option_desc'), $oid);
+ $row = DB::getRow($query);
- $o = sql_fetch_array($query);
-
- if ( ($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' ) )
+ if ( ($this->optionCanBeNumeric($row['otype'])) && ($row['oextra'] == 'number' ) )
{
$orderby = 'CAST(ovalue AS SIGNED)';
}
{
$orderby = 'ovalue';
}
- $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.intval($amount);
- $query = sql_query($q);
+ $query = "SELECT ovalue value, ocontextid id FROM %s WHERE oid = %d ORDER BY %s %s LIMIT 0,%d;";
+ $query = sprintf($query, sql_table('plugin_option'), $oid, $orderby, $sort, (integer) $amount);
+ $result = DB::getResult($query);
// create the array
$i = 0;
$top = array();
- while( $row = sql_fetch_array($query) )
+ foreach( $result as $row )
{
$top[$i++] = $row;
}
*
* private
*/
- function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '')
+ final protected function create_option($context, $name, $desc, $type, $defValue, $typeExtras = '')
{
// create in plugin_option_desc
$query = 'INSERT INTO ' . sql_table('plugin_option_desc')
.' (opid, oname, ocontext, odesc, otype, odef, oextra)'
.' VALUES ('.intval($this->plugid)
- .', \''.sql_real_escape_string($name).'\''
- .', \''.sql_real_escape_string($context).'\''
- .', \''.sql_real_escape_string($desc).'\''
- .', \''.sql_real_escape_string($type).'\''
- .', \''.sql_real_escape_string($defValue).'\''
- .', \''.sql_real_escape_string($typeExtras).'\')';
- sql_query($query);
- $oid = sql_insert_id();
+ .', '.DB::quoteValue($name)
+ .', '.DB::quoteValue($context)
+ .', '.DB::quoteValue($desc)
+ .', '.DB::quoteValue($type)
+ .', '.DB::quoteValue($defValue)
+ .', '.DB::quoteValue($typeExtras).')';
+ DB::execute($query);
+ $oid = DB::getInsertId();
$key = $context . '_' . $name;
- $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);
+ $this->option_info[$key] = array('oid' => $oid, 'default' => $defValue);
return 1;
}
*
* private
*/
- function _deleteOption($context, $name)
+ final protected function delete_option($context, $name)
{
- $oid = $this->_getOID($context, $name);
+ $oid = $this->get_option_id($context, $name);
if ( !$oid )
{
return 0; // no such option
}
// delete all things from plugin_option
- sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
+ $query = "DELETE FROM %s WHERE oid=%d;";
+ $query = sprintf($query, sql_table('plugin_option'), (integer) $oid);
+ DB::execute($query);
// delete entry from plugin_option_desc
- sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);
+ $query = "DELETE FROM %s WHERE oid=%d;";
+ $query = sprintf($query, sql_table('plugin_option_desc'), $oid);
+ DB::execute($query);
// clear from cache
- unset($this->_aOptionToInfo[$context . '_' . $name]);
- $this->_aOptionValues = array();
+ unset($this->option_info["{$context}_{$name}"]);
+ $this->option_values = array();
return 1;
}
* returns: 1 on success, 0 on failure
* private
*/
- function _setOption($context, $contextid, $name, $value)
+ final protected function set_option($context, $contextid, $name, $value)
{
global $manager;
- $oid = $this->_getOID($context, $name);
+ $oid = $this->get_option_id($context, $name);
if ( !$oid )
{
return 0;
switch ( $context )
{
case 'member':
- if ( !MEMBER::existsID($contextid) )
+ if ( !Member::existsID($contextid) )
{
return 0;
}
}
// update plugin_option
- sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));
- sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.sql_real_escape_string($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');
+ $query = "DELETE FROM %s WHERE oid=%d and ocontextid=%d;";
+ $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid);
+ DB::execute($query);
+
+ $query = "INSERT INTO %s (ovalue, oid, ocontextid) VALUES (%s, %d, %d);";
+ $query = sprintf($query, sql_table('plugin_option'), DB::quoteValue($value), $oid, $contextid);
+ DB::execute($query);
// update cache
- $this->_aOptionValues[$oid . '_' . $contextid] = $value;
+ $this->option_values["{$oid}_{$contextid}"] = $value;
if ( $context == 'global' )
{
$this->plugin_options[strtolower($name)] = $value;
}
-
+
return 1;
}
*
* private
*/
- function _getOption($context, $contextid, $name)
+ final protected function get_option($context, $contextid, $name)
{
- $oid = $this->_getOID($context, $name);
+ $oid = $this->get_option_id($context, $name);
if ( !$oid )
{
return '';
}
- $key = $oid . '_' . $contextid;
+ $key = "{$oid}_{$contextid}";
- if ( isset($this->_aOptionValues[$key]) )
+ if ( isset($this->option_values[$key]) )
{
- return $this->_aOptionValues[$key];
+ return $this->option_values[$key];
}
// get from DB
- $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));
+ $query = "SELECT ovalue FROM %s WHERE oid=%d and ocontextid=%d;";
+ $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid);
+ $result = DB::getResult($query);
- if ( !$res || (sql_num_rows($res) == 0) )
+ if ( !$result || ($result->rowCount() == 0) )
{
- $defVal = $this->_getDefVal($context, $name);
- $this->_aOptionValues[$key] = $defVal;
-
// fill DB with default value
- $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'
- .' VALUES ('.intval($oid).', '.intval($contextid).', \''.sql_real_escape_string($defVal).'\')';
- sql_query($query);
+ $this->option_values[$key] = $this->get_default_value($context, $name);
+ $query = "INSERT INTO %s (oid, ocontextid, ovalue) VALUES (%d, %d, %s);";
+ $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid, DB::quoteValue($this->option_values[$key]));
+ DB::execute($query);
}
else
{
- $o = sql_fetch_object($res);
- $this->_aOptionValues[$key] = $o->ovalue;
+ $row = $result->fetch();
+ $this->option_values[$key] = $row['ovalue'];
}
- return $this->_aOptionValues[$key];
+ return $this->option_values[$key];
}
/**
*
* private
*/
- function _getAllOptions($context, $name)
+ final protected function get_all_options($context, $name)
{
- $oid = $this->_getOID($context, $name);
+ $oid = $this->get_option_id($context, $name);
if ( !$oid )
{
return array();
}
- $defVal = $this->_getDefVal($context, $name);
+ $default_value = $this->get_default_value($context, $name);
- $aOptions = array();
+ $options = array();
+ $query = "SELECT %s as contextid FROM %s;";
switch ( $context )
{
case 'blog':
- $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));
+ $query = sprintf($query, 'bnumber', sql_table('blog'));
break;
case 'category':
- $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));
+ $query = sprintf($query, 'catid', sql_table('category'));
break;
case 'member':
- $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));
+ $query = sprintf($query, 'mnumber', sql_table('member'));
break;
case 'item':
- $r = sql_query('SELECT inumber as contextid FROM ' . sql_table('item'));
+ $query = sprintf($query, 'inumber', sql_table('item'));
break;
}
- if ( $r )
+
+ $result = DB::getResult($query);
+ if ( $result )
{
- while ( $o = sql_fetch_object($r) )
+ foreach ( $result as $row )
{
- $aOptions[$o->contextid] = $defVal;
+ $options[$row['contextid']] = $default_value;
}
}
- $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
- while ( $o = sql_fetch_object($res) )
+ $query = "SELECT ocontextid, ovalue FROM %s WHERE oid=%d;";
+ $query = sprintf($query, sql_table('plugin_option'), $oid);
+ $result = DB::getResult($query);
+ foreach ( $result as $row )
{
- $aOptions[$o->ocontextid] = $o->ovalue;
+ $options[$row['ocontextid']] = $row['ovalue'];
}
- return $aOptions;
+ return $options;
}
/**
- * NucleusPlugin::_getOID
+ * NucleusPlugin::get_option_id
*
* Gets the 'option identifier' that corresponds to a given option name.
* When this method is called for the first time, all the OIDs for the plugin
* @param string $name plugin name
* @return integer option id
*/
- function _getOID($context, $name)
+ final protected function get_option_id($context, $name)
{
- $key = $context . '_' . $name;
+ $key = "{$context}_{$name}";
- if ( array_key_exists($key, $this->_aOptionToInfo)
- && array_key_exists('oid', $this->_aOptionToInfo[$key]) )
+ if ( array_key_exists($key, $this->option_info)
+ && array_key_exists('oid', $this->option_info[$key]) )
{
- return $this->_aOptionToInfo[$key]['oid'];
+ return $this->option_info[$key]['oid'];
}
// load all OIDs for this plugin from the database
- $this->_aOptionToInfo = array();
- $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);
- $res = sql_query($query);
- while ( $o = sql_fetch_object($res) )
+ $this->option_info = array();
+ $query = "SELECT oid, oname, ocontext, odef FROM %s WHERE opid=%d;";
+ $query = sprintf($query, sql_table('plugin_option_desc'), $this->plugid);
+ $result = DB::getResult($query);
+ foreach ( $result as $row )
{
- $k = $o->ocontext . '_' . $o->oname;
- $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);
+ $k = $row['ocontext'] . '_' . $row['oname'];
+ $this->option_info[$k] = array('oid' => $row['oid'], 'default' => $row['odef']);
}
- sql_free_result($res);
+ $result->closeCursor();
- return $this->_aOptionToInfo[$key]['oid'];
+ return $this->option_info[$key]['oid'];
}
- function _getDefVal($context, $name)
+ final protected function get_default_value($context, $name)
{
$key = $context . '_' . $name;
- if ( array_key_exists($key, $this->_aOptionToInfo)
- && array_key_exists('default', $this->_aOptionToInfo[$key]) )
+ if ( array_key_exists($key, $this->option_info)
+ && array_key_exists('default', $this->option_info[$key]) )
{
- return $this->_aOptionToInfo[$key]['default'];
+ return $this->option_info[$key]['default'];
}
return;
}
/**
+ * NucleusPlugin::delete_option_values()
* Deletes all option values for a given context and contextid
* (used when e.g. a blog, member or category is deleted)
*
- * (static method)
+ *@static
+ *@param String $context global/blog/category/item/member
+ *@param Integer $contextid ID
+ *@return Void
*/
- function _deleteOptionValues($context, $contextid)
+ static public function delete_option_values($context, $contextid)
{
// delete all associated plugin options
$aOIDs = array();
// find ids
- $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.sql_real_escape_string($context).'\'';
- $res = sql_query($query);
- while ( $o = sql_fetch_object($res) )
+ $query = "SELECT oid FROM %s WHERE ocontext=%s;";
+ $query = sprintf($query, sql_table('plugin_option_desc'), DB::quoteValue($context));
+
+ $result = DB::getResult($query);
+ foreach ( $result as $row )
{
- array_push($aOIDs, $o->oid);
+ array_push($aOIDs, $row['oid']);
}
- sql_free_result($res);
+ $result->closeCursor();
// delete those options. go go go
if ( count($aOIDs) > 0 )
{
- $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);
- sql_query($query);
+ $query = "DELETE FROM %s WHERE oid in (%s) and ocontextid=%d;";
+ $query = sprintf($query, sql_table('plugin_option'), implode(',',$aOIDs), (integer) $contextid);
+ DB::execute($query);
}
+ return;
}
/**
* @param string $typeExtra the value of the typeExtra field of an option
* @return array array of the meta-key/value-pairs
*/
- function getOptionMeta($typeExtra)
+ static public function getOptionMeta($typeExtra)
{
$meta = array();
/* 1. if $typeExtra includes delimiter ';', split it to tokens */
- $tokens = i18n::explode(';', $typeExtra);
+ $tokens = preg_split('#;#', $typeExtra);
/*
* 2. if each of tokens includes "=", it consists of key => value
* @param string $typeExtra the value of the typeExtra field of an option
* @return string the selectlist
*/
- function getOptionSelectValues($typeExtra)
+ static public function getOptionSelectValues($typeExtra)
{
$meta = NucleusPlugin::getOptionMeta($typeExtra);
* @return bool if it is up-to-date it return true, else false
* @author TeRanEX
*/
- function subscribtionListIsUptodate()
+ public function subscribtionListIsUptodate()
{
- $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());
+ $res = DB::getResult('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->plugid);
$ev = array();
- while( $a = sql_fetch_array($res) )
+ foreach ( $res as $row )
{
- array_push($ev, $a['event']);
+ array_push($ev, $row['event']);
}
if ( count($ev) != count($this->getEventList()) )
{
}
/**
- * NucleusPlugin::_applyPluginOptions()
+ * NucleusPlugin::apply_plugin_options()
* Update its entry in database table
*
* @static
- * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))
+ * @param $options: array ( 'oid' => array( 'contextid' => 'value'))
* (taken from request using requestVar())
- * @param $newContextid: integer (accepts a contextid when it is for a new
+ * @param $new_contextid: integer (accepts a contextid when it is for a new
* contextid there was no id available at the moment of writing the
* formcontrols into the page (by ex: itemOptions for new item)
* @return void
*/
- function _applyPluginOptions(&$aOptions, $newContextid = 0)
+ static public function apply_plugin_options(&$options, $new_contextid = 0)
{
global $manager;
- if ( !is_array($aOptions) )
+
+ if ( !is_array($options) )
{
return;
}
- foreach ( $aOptions as $oid => $values )
+ foreach ( $options as $oid => $values )
{
// get option type info
- $query = "SELECT opid, oname, ocontext, otype, oextra, odef FROM %s WHERE oid=%d";
+ $query = "SELECT opid, oname, ocontext, otype, oextra, odef FROM %s WHERE oid=%d;";
$query = sprintf($query, sql_table('plugin_option_desc'), (integer) $oid);
- $result = sql_query($query);
- if ( $info = sql_fetch_object($result) )
+ $result = DB::getRow($query);
+ if ( $result )
{
- foreach ( $values as $key => $value )
+ foreach ( $values as $id => $value )
{
- // avoid overriding the key used by foreach statement
- $contextid=$key;
+ // decide wether we are using the contextid of newContextid
+ if ( $new_contextid != 0 )
+ {
+ $contextid = $new_contextid;
+ }
+ else
+ {
+ $contextid = $id;
+ }
// retreive any metadata
- $meta = NucleusPlugin::getOptionMeta($info->oextra);
+ $meta = NucleusPlugin::getOptionMeta($result['oextra']);
// if the option is readonly or hidden it may not be saved
if ( array_key_exists('access', $meta)
$value = undoMagic($value);
/* validation the value according to its type */
- switch ( $info->otype )
+ switch ( $result['otype'] )
{
case 'yesno':
if ( ($value != 'yes') && ($value != 'no') )
if ( array_key_exists('datatype', $meta)
&& ($meta['datatype'] == 'numerical') && ($value != (integer) $value) )
{
- $value = (integer) $info->odef;
+ $value = (integer) $result['odef'];
}
break;
case 'password':
break;
}
- // decide wether we are using the contextid of newContextid
- if ( $newContextid != 0 )
- {
- $contextid = $newContextid;
- }
-
/*
* trigger event PrePluginOptionsUpdate to give the plugin the
* possibility to change/validate the new value for the option
*/
$data = array(
- 'context' => $info->ocontext,
- 'plugid' => $info->opid,
- 'optionname' => $info->oname,
+ 'context' => $result['ocontext'],
+ 'plugid' => $result['opid'],
+ 'optionname' => $result['oname'],
'contextid' => $contextid,
'value' => &$value);
$manager->notify('PrePluginOptionsUpdate', $data);
// delete and insert its fields of table in database
$query = "DELETE FROM %s WHERE oid=%d AND ocontextid=%d;";
$query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid);
- sql_query($query);
- $query = "INSERT INTO %s (oid, ocontextid, ovalue) VALUES (%d, %d, '%s');";
- $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid, sql_real_escape_string($value));
- sql_query($query);
- }
- }
- // clear option value cache if the plugin object is already loaded
- if ( is_object($info) )
- {
- $plugin=& $manager->pidLoaded($info->opid);
- if ( $plugin )
- {
- $plugin->clearOptionValueCache();
+ DB::execute($query);
+ $query = "INSERT INTO %s (oid, ocontextid, ovalue) VALUES (%d, %d, %s);";
+ $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid, DB::quoteValue($value));
+ DB::execute($query);
+
+ // clear option value cache if the plugin object is already loaded
+ $plugin=& $manager->pidLoaded($result['opid']);
+ if ( $plugin )
+ {
+ $plugin->clearOptionValueCache();
+ }
+
+ continue;
}
}
+ continue;
}
return;
}
OSDN Git Service
