mbirth/LuckyCoinkydink
1
0
Fork 0
Code Issues Pull Requests Activity

RQ some function arguments

Browse Source 
What shall we do with them, see serendipity_fetchEntry() and getClassByInstanceID() ?
This commit is contained in:
Ian 2016-02-08 15:14:49 +01:00
parent 2cc8655ed2
commit 1c1c11f31f
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/functions_entries.inc.php
View File

@ -522,7 +522,7 @@ function serendipity_fetchEntryData(&$ret) {
* @access public * @access public
* @param string The column to compare $val against (like 'id') * @param string The column to compare $val against (like 'id')
* @param string The value of the colum $key to compare with (like '4711') * @param string The value of the colum $key to compare with (like '4711')
* @param boolean Indicates if the full entry will be fetched (body+extended: TRUE), or only the body (FALSE). * @param boolean Indicates if the full entry will be fetched (body+extended: TRUE), or only the body (FALSE). RQ: WHY Isn't $full parameter used at all???
* @param string Indicates whether drafts should be fetched * @param string Indicates whether drafts should be fetched
* @return * @return
*/ */

19
include/plugin_api.inc.php
View File

@ -23,7 +23,7 @@ $serendipity['core_events']['backend_header']['jquery'] = 'serendipity_plugin_a
// Add jquery to all frontend templates (in noConflict mode) // Add jquery to all frontend templates (in noConflict mode)
function serendipity_plugin_api_frontend_header($event_name, &$bag, &$eventData, $addData) { function serendipity_plugin_api_frontend_header($event_name, &$bag, &$eventData, $addData) {
global $serendipity; global $serendipity;
// Only execute if current template (only) does not have its own jquery.js file // Only execute if current template (only) does not have its own jquery.js file
// jquery can be disabled if a template's config.inc.php or a plugin sets // jquery can be disabled if a template's config.inc.php or a plugin sets
@ -44,7 +44,7 @@ function serendipity_plugin_api_frontend_header($event_name, &$bag, &$eventData,
// Add jquery to all backend templates // Add jquery to all backend templates
function serendipity_plugin_api_backend_header($event_name, &$bag, &$eventData, $addData) { function serendipity_plugin_api_backend_header($event_name, &$bag, &$eventData, $addData) {
global $serendipity; global $serendipity;
// Only execute if current template does not have its own backend_jquery.js file // Only execute if current template does not have its own backend_jquery.js file
// jquery can be disabled if a template's config.inc.php or a plugin sets // jquery can be disabled if a template's config.inc.php or a plugin sets
@ -435,7 +435,7 @@ class serendipity_plugin_api
* *
* @access public * @access public
* @param string The filter for plugins (left|right|hide|event|eventh) * @param string The filter for plugins (left|right|hide|event|eventh)
* @param boolean If true, the filtering logic will be reversed an all plugins that are NOT part of the filter will be returned * @param boolean If true, the filtering logic will be reversed and all plugins that are NOT part of the filter will be returned
* @param string Filter by a specific classname (like 'serendipity_plugin_archives'). Can take SQL wildcards. * @param string Filter by a specific classname (like 'serendipity_plugin_archives'). Can take SQL wildcards.
* @param string Filter by a specific plugin instance id * @param string Filter by a specific plugin instance id
* @return array Returns the associative array of found plugins in the database * @return array Returns the associative array of found plugins in the database
@ -477,7 +477,7 @@ class serendipity_plugin_api
* *
* @access public * @access public
* @param string The filter for plugins (left|right|hide|event|eventh) * @param string The filter for plugins (left|right|hide|event|eventh)
* @param boolean If true, the filtering logic will be reversed an all plugins that are NOT part of the filter will be evaluated * @param boolean If true, the filtering logic will be reversed and all plugins that are NOT part of the filter will be evaluated
* @return int Number of plugins that were found. * @return int Number of plugins that were found.
*/ */
static function count_plugins($filter = '*', $negate = false) static function count_plugins($filter = '*', $negate = false)
@ -547,7 +547,7 @@ class serendipity_plugin_api
* *
* @access public * @access public
* @param string The ID of a plugin * @param string The ID of a plugin
* @param boolean If true, the plugin is a internal plugin (prefixed with '@') * @param boolean If true, the plugin is a internal plugin (prefixed with '@') RQ: with 2.0+ obsolet?!
* @return string The classname of the plugin * @return string The classname of the plugin
*/ */
static function getClassByInstanceID($instance_id, &$is_internal) static function getClassByInstanceID($instance_id, &$is_internal)
@ -1638,7 +1638,8 @@ class serendipity_plugin
* @param bool Called by a plugin (defaults true), since we do not have a theme using it yet * @param bool Called by a plugin (defaults true), since we do not have a theme using it yet
* @return string Parsed Smarty return * @return string Parsed Smarty return
*/ */
function &parseTemplate($filename, $plugin = true) { function &parseTemplate($filename, $plugin = true)
{
global $serendipity; global $serendipity;
$filename = basename($filename); $filename = basename($filename);
@ -1649,6 +1650,7 @@ class serendipity_plugin
return $serendipity['smarty']->fetch('file:'. $tfile); return $serendipity['smarty']->fetch('file:'. $tfile);
} }
} }
/** /**
@ -1736,13 +1738,14 @@ class serendipity_event extends serendipity_plugin
*/ */
function event_hook($event, &$bag, &$eventData, $addData = null) function event_hook($event, &$bag, &$eventData, $addData = null)
{ {
// Define event hooks here, if you want you plugin to execute those instead of being a sidebar item. // Define event hooks here, if you want your plugin to execute those instead of being a sidebar item.
// Look at external plugins 'serendipity_event_mailer' or 'serendipity_event_weblogping' for usage. // Look at external plugins 'serendipity_event_mailer' (?) or 'serendipity_event_weblogping' for usage.
// Currently available events: // Currently available events:
// backend_publish [after insertion of a new article in your s9y-backend] // backend_publish [after insertion of a new article in your s9y-backend]
// backend_display [after displaying an article in your s9y-backend] // backend_display [after displaying an article in your s9y-backend]
// frontend_display [before displaying an article in your s9y-frontend] // frontend_display [before displaying an article in your s9y-frontend]
// frontend_comment [after displaying the "enter comment" dialog] // frontend_comment [after displaying the "enter comment" dialog]
// ...and some more in the meanwhile...! :)
return true; return true;
} }