From 0ba3a26c34708fccedf1b213e8fc7fa51cacbab3 Mon Sep 17 00:00:00 2001 From: Martin Hecht Date: Sun, 12 Feb 2017 23:20:20 +0100 Subject: [PATCH] updated to 1.5.1 --- CHANGELOG | 12 +++ TODO | 1 + add_filter.php | 6 +- ajax/ajax_dragdrop.js | 2 +- ajax/ajax_dragdrop.php | 6 +- backend.css | 6 +- backend_body.js | 6 +- config_init.php | 6 +- convert.php | 6 +- css.php | 6 +- debug_conf.php | 6 +- dialog/jquery.dialog.js | 2 +- docs/files/CHANGELOG-txt.html | 4 +- docs/files/DE/install_filter_module-txt.html | 2 +- docs/files/DE/install_filter_plugin-txt.html | 2 +- docs/files/EN/install_filter_module-txt.html | 2 +- docs/files/EN/install_filter_plugin-txt.html | 2 +- docs/files/functions_outputfilter-php.html | 18 ++-- docs/index/Files.html | 2 +- docs/index/Functions.html | 14 +-- docs/index/General.html | 24 ++--- docs/search/FunctionsF.html | 2 +- docs/search/GeneralF.html | 2 +- edit_filter.php | 8 +- export.php | 6 +- functions.php | 102 +++++++++++++------ functions_outputfilter.php | 98 +++++++++++++++--- info.php | 12 +-- install.php | 7 +- languages/DE.php | 10 +- languages/EN.php | 8 +- languages/FR.php | 8 +- languages/IT.php | 8 +- languages/NL.php | 6 +- languages/NO.php | 6 +- naturaldocs_txt/CHANGELOG.txt | 12 +++ naturaldocs_txt/functions_outputfilter.php | 98 +++++++++++++++--- precheck.php | 6 +- templates/add_edit.htt | 6 +- templates/css.htt | 6 +- templates/tool.htt | 8 +- tool.php | 13 ++- uninstall.php | 6 +- upgrade.php | 19 +++- upload.php | 13 ++- 45 files changed, 424 insertions(+), 181 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 3410328..e8050b9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -2,6 +2,18 @@ Header: Version-History 1.5: +1.5.1 %(mrbaseman, 25 Jan 2017)% + - allow arrays for !$ref_name! in + - switch to colon separator in ajax helper + - if !$ref_name! is ommited in , move !$name! up to the top + - update patch detection for wbce 1.2 and module filter replacement + - suppress warning when is called and !$ref_name! not found + - store active/inactive state not only inside opf but also as WBCE Settings value + - add additional hint upon an attempt to install a module filter as a plugin + - trigger upgrade/install of module filters + - in take settings constants into account + - immediately reflect toggle of the active/inactive state in the dashboard + 1.5.0 %(mrbaseman, 29 Sept 2016)% - fetch $page_id from constant !PAGE_ID! for all cases - automagically initialize the global filter list diff --git a/TODO b/TODO index 68f11ec..68d66d9 100644 --- a/TODO +++ b/TODO @@ -1,3 +1,4 @@ TODO list for future releases ============================= - maybe include more example filters one time + diff --git a/add_filter.php b/add_filter.php index e0613d5..cc6123f 100644 --- a/add_filter.php +++ b/add_filter.php @@ -8,12 +8,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/ajax/ajax_dragdrop.js b/ajax/ajax_dragdrop.js index c0d7aff..47a59af 100644 --- a/ajax/ajax_dragdrop.js +++ b/ajax/ajax_dragdrop.js @@ -40,7 +40,7 @@ if(jQuery().sortable){ type: 'POST', url: AJAX_PLUGINS+'/ajax_dragdrop.php', data: jQuery(this).sortable("serialize", { - expression: /(.+)[_:](.+)/ + expression: /(.+)[:](.+)/ }) + '&action=updatePosition', dataType: 'json', success: function(json_respond){ diff --git a/ajax/ajax_dragdrop.php b/ajax/ajax_dragdrop.php index e9e74a6..c871b29 100644 --- a/ajax/ajax_dragdrop.php +++ b/ajax/ajax_dragdrop.php @@ -4,12 +4,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/backend.css b/backend.css index 5cd0ce1..f3dc7cd 100644 --- a/backend.css +++ b/backend.css @@ -6,12 +6,12 @@ backend.css * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/backend_body.js b/backend_body.js index 4542833..1caff3a 100644 --- a/backend_body.js +++ b/backend_body.js @@ -6,12 +6,12 @@ backend_body.js * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/config_init.php b/config_init.php index 09807bf..720f6d2 100644 --- a/config_init.php +++ b/config_init.php @@ -8,12 +8,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/convert.php b/convert.php index dcb7d7c..e824291 100644 --- a/convert.php +++ b/convert.php @@ -8,12 +8,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/css.php b/css.php index 35d1d60..190e2b1 100644 --- a/css.php +++ b/css.php @@ -8,12 +8,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/debug_conf.php b/debug_conf.php index 2ac427f..63b098e 100644 --- a/debug_conf.php +++ b/debug_conf.php @@ -8,12 +8,12 @@ * * @category tool * @package Outputfilter Dashboard - * @version 1.5.0 + * @version 1.5.1 * @authors Thomas "thorn" Hornik , Christian M. Stefan (Stefek) , Martin Hecht (mrbaseman) - * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2016 Martin Hecht (mrbaseman) + * @copyright (c) 2009,2010 Thomas "thorn" Hornik, 2010 Christian M. Stefan (Stefek), 2017 Martin Hecht (mrbaseman) * @link https://github.com/WebsiteBaker-modules/outpufilter_dashboard * @link http://forum.websitebaker.org/index.php/topic,28926.0.html - * @link http://forum.wbce.org/viewtopic.php?pid=3121 + * @link https://forum.wbce.org/viewtopic.php?id=176 * @link http://addons.wbce.org/pages/addons.php?do=item&item=53 * @license GNU General Public License, Version 3 * @platform WebsiteBaker 2.8.x diff --git a/dialog/jquery.dialog.js b/dialog/jquery.dialog.js index a42cd37..a40b1ea 100644 --- a/dialog/jquery.dialog.js +++ b/dialog/jquery.dialog.js @@ -383,7 +383,7 @@ function fadeDialog(flag) /* define some message-functions */ function opf_message(title, text, type, button1, button2, action) { DLGRESULT = null; - showDialog(title,text,type, 350, 120, false, false, true, 4, button1, button2); + showDialog(title,text,type, 450, 180, false, false, true, 4, button1, button2); // if(action!=0) { setTimeout("opf_message_helper('"+action+"')",100); diff --git a/docs/files/CHANGELOG-txt.html b/docs/files/CHANGELOG-txt.html index 95809e3..56dd4b5 100644 --- a/docs/files/CHANGELOG-txt.html +++ b/docs/files/CHANGELOG-txt.html @@ -11,7 +11,7 @@ -

Version-History

1.5

1.5.0 (mrbaseman, 29 Sept 2016)

  • fetch $page_id from constant PAGE_ID for all cases
  • automagically initialize the global filter list
  • allow to sort filters via drag&drop
  • make exported filter human-readable
  • improve processing of formatting of documentation
  • when exporting a filter create a filter.php file
  • during export also insert placeholders introduced in version 1.4.4
  • allow to convert between inline filters and plugin filters
  • added opf_move_up_before to move filters up in the list during installation
  • search for pre-existing module filters during installation of opf
  • cleaned up backend_body.js
  • support backend filtering, provided that the class “Tool” exists and the settings have been converted to modules In case you have created a filter which screws up the backend completely, add the following line to your global config.php of your WBCE installation
define('WB_OPF_BE_OFF', 'off');

The value doesn’t really matter, just if the constant is defined, there will no filter be applied to the backend and you have access to the dashboard again and you can fix the filters.

1.4

this version is a major re-engineering of the module with the goal to use it without PMF.  Special thanks to all who have tested and especially to NorHei for fruitful discussions and for providing additional testing ressources.

1.4.9 (mrbaseman, 23 Mar 2016)

  • change cachecontrols filter type to page(last)
  • realign code: wrap long lines and set tab width=4
  • make help browser work without javascript
  • fix css edit for filters that supply css files
  • provide export download link when javascript is disabled
  • allow to delete filters even without javascript
  • added French and Italian language support

1.4.8 (mrbaseman, 21 Feb 2016)

  • remove unused code part from add_filter to fix array conversion warnings
  • update plugin filters to use new placeholders introduced in 1.4.4 in order to pick up this change you have to remove the example filters before upgrading OpF
  • update documentation: added a section which explains the use of the constants and placeholders

1.4.7 (mrbaseman, 21 Feb 2016)

  • a couple of cosmetic bugfixes (correctly display Umlauts in filter list, replace German ss special char with ss in filter description, remove unused filter_id from template parsing, properly initialize TPL_EXTRA_FIELDS_BLOCK in edit_filter, fix for using global LANG inside method in WBCE)
  • security fix: check ftan for upload
  • several fixes for arrays as additional field (like in correct date example)
  • fix css edit for filters that provide css

1.4.6 (mrbaseman, 18 Feb 2016)

  • add module icon for WBCE 1.2
  • bugfix: do not allow moving up uppermost filter
  • switch from FTANs to IDKEYs in many places of the backend

1.4.5 (mrbaseman, 09 Feb 2016)

  • update documentation layout
  • include example plugins again
  • update patch check
  • merge in Stefek’s changes, thanks for your contribution and for your ideas you have contributed
  • automatically remove naturaldocs sources during install
  • various minor changes to make it working in upcoming wb-classic releases

1.4.4 (Stefek, 05 Feb 2016)

  • added the following tokens to apply instead of hardcoded pathes within OpF-Plugins:
{SYSVAR:WB_URL}   = will replace with the content of the Constant WB_URL
+
Version-History
1.5
1.5.1 (mrbaseman, 25 Jan 2017)
  • allow arrays for $ref_name in opf_move_up_before
  • switch to colon separator in ajax helper
  • if $ref_name is ommited in opf_move_up_before, move $name up to the top
  • update patch detection for wbce 1.2 and module filter replacement
  • suppress warning when opf_move_up_before is called and $ref_name not found
  • store active/inactive state not only inside opf but also as WBCE Settings value
  • add additional hint upon an attempt to install a module filter as a plugin
  • trigger upgrade/install of module filters
  • in opf_filter_is_active take settings constants into account
  • immediately reflect toggle of the active/inactive state in the dashboard
1.5.0 (mrbaseman, 29 Sept 2016)
  • fetch $page_id from constant PAGE_ID for all cases
  • automagically initialize the global filter list
  • allow to sort filters via drag&drop
  • make exported filter human-readable
  • improve processing of formatting of documentation
  • when exporting a filter create a filter.php file
  • during export also insert placeholders introduced in version 1.4.4
  • allow to convert between inline filters and plugin filters
  • added opf_move_up_before to move filters up in the list during installation
  • search for pre-existing module filters during installation of opf
  • cleaned up backend_body.js
  • support backend filtering, provided that the class “Tool” exists and the settings have been converted to modules In case you have created a filter which screws up the backend completely, add the following line to your global config.php of your WBCE installation
define('WB_OPF_BE_OFF', 'off');
The value doesn’t really matter, just if the constant is defined, there will no filter be applied to the backend and you have access to the dashboard again and you can fix the filters.
1.4
this version is a major re-engineering of the module with the goal to use it without PMF.  Special thanks to all who have tested and especially to NorHei for fruitful discussions and for providing additional testing ressources.
1.4.9 (mrbaseman, 23 Mar 2016)
  • change cachecontrols filter type to page(last)
  • realign code: wrap long lines and set tab width=4
  • make help browser work without javascript
  • fix css edit for filters that supply css files
  • provide export download link when javascript is disabled
  • allow to delete filters even without javascript
  • added French and Italian language support
1.4.8 (mrbaseman, 21 Feb 2016)
  • remove unused code part from add_filter to fix array conversion warnings
  • update plugin filters to use new placeholders introduced in 1.4.4 in order to pick up this change you have to remove the example filters before upgrading OpF
  • update documentation: added a section which explains the use of the constants and placeholders
1.4.7 (mrbaseman, 21 Feb 2016)
  • a couple of cosmetic bugfixes (correctly display Umlauts in filter list, replace German ss special char with ss in filter description, remove unused filter_id from template parsing, properly initialize TPL_EXTRA_FIELDS_BLOCK in edit_filter, fix for using global LANG inside method in WBCE)
  • security fix: check ftan for upload
  • several fixes for arrays as additional field (like in correct date example)
  • fix css edit for filters that provide css
1.4.6 (mrbaseman, 18 Feb 2016)
  • add module icon for WBCE 1.2
  • bugfix: do not allow moving up uppermost filter
  • switch from FTANs to IDKEYs in many places of the backend
1.4.5 (mrbaseman, 09 Feb 2016)
  • update documentation layout
  • include example plugins again
  • update patch check
  • merge in Stefek’s changes, thanks for your contribution and for your ideas you have contributed
  • automatically remove naturaldocs sources during install
  • various minor changes to make it working in upcoming wb-classic releases
1.4.4 (Stefek, 05 Feb 2016)
  • added the following tokens to apply instead of hardcoded pathes within OpF-Plugins:
{SYSVAR:WB_URL}   = will replace with the content of the Constant WB_URL
 {SYSVAR:WB_PATH}  = will replace with the content of the Constant WB_PATH
 {OPF:PLUGIN_URL}  = will replace with WB_URL.'/modules/outputfilter_dashboard/plugins/{your_plugin}'
 {OPF:PLUGIN_PATH} = will replace with WB_PATH.'/modules/outputfilter_dashboard/plugins/{your_plugin}'
  • added 2 CONSTANTS to work with OPF Plugins
OPF_PLUGINS_PATH
@@ -39,7 +39,7 @@
 
 
 
-
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 

+
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id

 
 
 
diff --git a/docs/files/DE/install_filter_module-txt.html b/docs/files/DE/install_filter_module-txt.html
index f9f341c..8653af6 100644
--- a/docs/files/DE/install_filter_module-txt.html
+++ b/docs/files/DE/install_filter_module-txt.html
@@ -93,7 +93,7 @@
 
 
 
-
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

+
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

 
 
 
diff --git a/docs/files/DE/install_filter_plugin-txt.html b/docs/files/DE/install_filter_plugin-txt.html
index 8277fd4..8682ab3 100644
--- a/docs/files/DE/install_filter_plugin-txt.html
+++ b/docs/files/DE/install_filter_plugin-txt.html
@@ -66,7 +66,7 @@
 
 
 
-
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

+
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

 
 
 
diff --git a/docs/files/EN/install_filter_module-txt.html b/docs/files/EN/install_filter_module-txt.html
index 0333237..fe83ee7 100644
--- a/docs/files/EN/install_filter_module-txt.html
+++ b/docs/files/EN/install_filter_module-txt.html
@@ -93,7 +93,7 @@
 
 
 
-
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

+
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

 
 
 
diff --git a/docs/files/EN/install_filter_plugin-txt.html b/docs/files/EN/install_filter_plugin-txt.html
index 4541dd8..d05064c 100644
--- a/docs/files/EN/install_filter_plugin-txt.html
+++ b/docs/files/EN/install_filter_plugin-txt.html
@@ -66,7 +66,7 @@
 
 
 
-
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

+
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
The Filter function must have an unique name, and should have a “opff_”-prefix

 
 
 
diff --git a/docs/files/functions_outputfilter-php.html b/docs/files/functions_outputfilter-php.html
index db0d3d3..e89a7c7 100644
--- a/docs/files/functions_outputfilter-php.html
+++ b/docs/files/functions_outputfilter-php.html
@@ -11,7 +11,7 @@
 
 
 
-
Filter functions
Summary
Filter functions
The Filter-Function itselfThe Filter function must have an unique name, and should have a “opff_”-prefix
Functions
opf_register_filterRegister a new Filter.
opf_move_up_beforeUpon registration move a filter up to a position before another one. 
opf_unregister_filterUn-Register a Filter.
opf_register_frontend_filesRegister JS- or CSS-files to be loaded into the page’s <head>-section.
opf_register_onload_eventRegister an Javascript onload-function inside page’s <head>-section, using window.attachEvent() or window.addEventListener().
opf_register_onloadRegister an Javascript script onload-function inside page’s <body>-section.
opf_register_document_readyRegister an Javascript onload-event inside page’s <head>-section, using jquery’s jQuery(document).ready()  
opf_find_classCheck whether a class (or any other attribute) is present in content.
opf_add_classAdd a class to a present HTML-tag, i.e. 
opf_add_class_to_classAdd a class to an already present class. 
opf_add_class_to_attrAdd a class to all HTML-tags that has a given attribute.
opf_cut_extractCuts pieces out of content using a regular expression and replace them by placeholders.
opf_glue_extractbool opf_glue_extract( string &$content, string $extracts )
opf_filter_get_dataFetch data from filter.
opf_filter_get_rel_posChecks if a given filter was or will be executed.
opf_filter_existsChecks whether a given filter exists
opf_is_childpageChecks whether a page is a subpage of a given page (or the same page)
opf_filter_is_activeCheckes whether a given filter is active for the actual module and page_id
opf_filter_get_additional_valuesReceive additional filter arguments

+
Filter functions
Summary
Filter functions
The Filter-Function itselfThe Filter function must have an unique name, and should have a “opff_”-prefix
Functions
opf_register_filterRegister a new Filter.
opf_move_up_beforeUpon registration move a filter up to a position before another one. 
opf_unregister_filterUn-Register a Filter.
opf_register_frontend_filesRegister JS- or CSS-files to be loaded into the page’s <head>-section.
opf_register_onload_eventRegister an Javascript onload-function inside page’s <head>-section, using window.attachEvent() or window.addEventListener().
opf_register_onloadRegister an Javascript script onload-function inside page’s <body>-section.
opf_register_document_readyRegister an Javascript onload-event inside page’s <head>-section, using jquery’s jQuery(document).ready()  
opf_find_classCheck whether a class (or any other attribute) is present in content.
opf_add_classAdd a class to a present HTML-tag, i.e. 
opf_add_class_to_classAdd a class to an already present class. 
opf_add_class_to_attrAdd a class to all HTML-tags that has a given attribute.
opf_cut_extractCuts pieces out of content using a regular expression and replace them by placeholders.
opf_glue_extractbool opf_glue_extract( string &$content, string $extracts )
opf_filter_get_dataFetch data from filter.
opf_filter_get_rel_posChecks if a given filter was or will be executed.
opf_filter_existsChecks whether a given filter exists
opf_is_childpageChecks whether a page is a subpage of a given page (or the same page)
opf_filter_is_activeCheckes whether a given filter is active for the actual module and page_id
opf_filter_get_additional_valuesReceive additional filter arguments
opf_filter_name_to_settingFor WBCE 1.2: This function converts the name of a filter to the settings string which is associated with the active/inactive state of the given filter name.

 
 
The Filter-Function itself
The Filter function must have an unique name, and should have a “opff_”-prefix
Prototype
bool opff_unique_name( string &$content, int $page_id, int $section_id, string $module, object $wb )
Parameters
&$content(string) The page’s or section’s Content, per reference!
$page_id(int) Actual Page ID.
$section_id(int) Actual Section ID.  For Filters of type OPF_TYPE_PAGE or OPF_TYPE_PAGE_LAST this is always FALSE.
$module(string) Name of actual module (== $module_directory  ).  For Filters of type OPF_TYPE_PAGE or OPF_TYPE_PAGE_LAST this is always FALSE.
$wb(object) Instance of Class wb.
Returns
Should return always TRUE.  Only in case the content may be damaged or undefined the function must return FALSE.
Examples
// simple filter which will convert all U to X in $content
 function opff_x_as_u(&$content, $page_id, $section_id, $module, $wb) {
@@ -88,7 +88,7 @@
 // apply filter to all pages
 'pages' => 'all'
pages_parent
List of pages (PAGE_IDs) the filter is applied to.  Additionaly the filter is applied to all sub-pages, too.  Alias ‘all’ for all present pages.
// apply filter on page 12 and 21, and all sub-pages of page 12 and 21
 'pages_parent' => '12,21' // written as list
-'pages_parent' => array('12', '21') // written as array
additional_fields
Arrays of additional configuration elements.
In case the filter need some additional config-elements but it doesn’t has its own Settings-Page / Admin-Tool, you can add some fields using additional_fields.  Possible field-types are
textnormal HTML text-field
textareanormal HTML textarea
editareatextarea with activated editarea (Editor)
radionormal HTML radio-fields
checkboxnormal HTML checkbox-fields
selectnormal HTML select-field
arraysimple array broken up into several text-fields
allowedit has no affect on these fields.
See opf_filter_get_additional_values on how to retrieve values from these fields.
Example: Adding various fields
'additional_fields' => array(
+'pages_parent' => array('12', '21') // written as array
additional_fields
Arrays of additional configuration elements.
In case the filter needs some additional config-elements but it doesn’t have its own Settings-Page / Admin-Tool, you can add some fields using additional_fields.  Possible field-types are
textnormal HTML text-field
textareanormal HTML textarea
editareatextarea with activated editarea (Editor)
radionormal HTML radio-fields
checkboxnormal HTML checkbox-fields
selectnormal HTML select-field
arraysimple array broken up into several text-fields
allowedit has no affect on these fields.
See opf_filter_get_additional_values on how to retrieve values from these fields.
Example: Adding various fields
'additional_fields' => array(
     array( // add text-field "Name"
         'type' => 'text',    // type of field
         'label' => 'Name',       // Label for the text-field
@@ -168,7 +168,7 @@
     )
 )
labelLabel of field.  label can be an ordinary string “Enter Date”, or a language-specific array.
variableName of variable to be used for this field.  Radio-buttons uses the same name.
typeType of field: ‘text’, ‘textarea’, ‘editarea’, ‘radio’, ‘checkbox’, ‘select’ or ‘array’.
nameValue for the HTML name-attribute.  Radio-buttons uses the same name.
valueDefault-value.  ‘select’ and ‘array’ requires an array.
checkedFor ‘radio’ or ‘checkbox’: use ’checked’ => 1 to mark this field checked.  For ‘select’: use ’checked’ => ‘value’ i.e. repeat the selected value.
style(optional) For ‘text’, ‘textarea’, ‘editarea’: add width: and/or height: attributes.

 
-
opf_move_up_before
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one.  This function can be used after opf_register_filter() to adjust its position in the filter list.  By default, freshly installed filters are appended to the end of the list of filters of the same type.  Use this function inside the <install.php> to move the filter up to a target position denoted by the name of another filter.  You can repeat this with different names of filters from which you know that they have to be applied after the one you are installing.
Prototype
bool opf_move_up_before( string $name, string $ref_name )
Parameters
$name(string) the name of the filter to move up in the list
$ref_name(string) name of the filter at the target position
Returns
TRUE on success, FALSE if the types don’t match or the filters were not found
Example
opf_move_up_before('opf CSS to head', 'Searchengine Highlighter');

+
opf_move_up_before
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one.  This function can be used after opf_register_filter() to adjust its position in the filter list.  By default, freshly installed filters are appended to the end of the list of filters of the same type.  Use this function inside the <install.php> to move the filter up to a target position denoted by the name of another filter.  You can repeat this with different names of filters from which you know that they have to be applied after the one you are installing.  Alternatively, if $ref_name is an array, the filter denoted by $name is moved upwards to the position of the upper-most entry of the whole list.  If $ref_name is ommited, the filter $name is moved up to the top of the whole list.  In this case the return value is the new position of the filter $name
Prototype
bool opf_move_up_before( string $name, string $ref_name )
array opf_move_up_before( string $name, array $ref_name )
int opf_move_up_before( string $name )
Parameters
$name(string) the name of the filter to move up in the list
$ref_name(string) name of the filter at the target position or
$ref_name(array) names of the filters at the target positions
Returns
TRUE on success, FALSE if the types don’t match or the filters were not found or an array of bools, corresponding to the return values for each filter or the position of $name if $ref_name is ommitted
Example
opf_move_up_before('opf CSS to head', 'Searchengine Highlighter');

 
 
opf_unregister_filter
function opf_unregister_filter($name)
Un-Register a Filter.
This function is used to remove a filter.  Use this for Module-Filters in the module’s uninstall.php-file.
Prototype
bool opf_unregister_filter( string $name )
Parameters
$name(string) Name of filter to un-register.
Returns
TRUE on success, FALSE otherwise.
Example
opf_unregister_filter('PrettyPrint: Google-Code-Prettify');

 
@@ -185,7 +185,7 @@
   <script type="text/javascript">function do_highlight() { highlighter.highlight(); }</script>
   ','js');

 
-
opf_register_onload_event
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s <head>-section, using window.attachEvent() or window.addEventListener().
Prototype
bool opf_register_onload_event( string $function_name )
Parameters
$function_name(string) Name of JS-function to register.
Returns
Always TRUE.
Example
opf_register_onload_event('prettyPrint');
Notes
There is no way to supply arguments to the function, yet.  Use opf_register_onload in case the function call needs arguments.

+
opf_register_onload_event
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s <head>-section, using window.attachEvent() or window.addEventListener().
Prototype
bool opf_register_onload_event( string $function_name )
Parameters
$function_name(string) Name of JS-function to register.
Returns
Always TRUE.
Example
opf_register_onload_event('prettyPrint');
Notes
There is no way to supply arguments to the function, yet.  Use opf_register_onload in case the function call needs arguments.

 
 
opf_register_onload
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s <body>-section.
Prototype
bool opf_register_onload( string $script )
Parameters
$script(string) JS-script to register.
Returns
Always TRUE.
Example
opf_register_onload('prettyPrint();');
 opf_register_onload("supersleight.run('".WB_URL."/modules/opf_fix_png_ie6/x.gif');");
@@ -267,7 +267,7 @@
     }
 }

 
-
opf_glue_extract
function opf_glue_extract(&$content,
$extracts)
Prototype
bool opf_glue_extract( string &$content, string $extracts )
Parameters
$content(string) Content (by reference).
$extracts(array)  An array returned by opf_cut_extract().
Notes
See opf_cut_extract().
Returns
TRUE.

+
opf_glue_extract
function opf_glue_extract(&$content,
$extracts)
Prototype
bool opf_glue_extract( string &$content, string $extracts )
Parameters
$content(string) Content (by reference).
$extracts(array)  An array returned by opf_cut_extract().
Notes
See opf_cut_extract().
Returns
TRUE.

 
 
opf_filter_get_data
function opf_filter_get_data($name = '')
Fetch data from filter.
Prototype
array opf_filter_get_data( string $name=’’ )
Parameters
$namestring Name of Filter.  Use ‘’ (empty string) for current filter.
Returns
Data of current filter, or FALSE in case of error.
Example
$data = opf_filter_get_data();
 var_dump($data);
will output:
array
@@ -328,10 +328,14 @@
     // Filter 'Menu Linebreak' is active for actual module and page_id.
 }

 
-
opf_filter_get_additional_values
function opf_filter_get_additional_values()
Receive additional filter arguments
Prototype
array opf_filter_get_additional_values( void )
This function fetches additional filter arguments from filter-settings.  See opf_register_filter().
Returns
Array containing the additional arguments, or FALSE in case of error.
Examples
$values = opf_filter_get_additional_values();
+
opf_filter_get_additional_values
function opf_filter_get_additional_values()
Receive additional filter arguments
Prototype
array opf_filter_get_additional_values( void )
This function fetches additional filter arguments from filter-settings.  See opf_register_filter().
Returns
Array containing the additional arguments, or FALSE in case of error.
Examples
$values = opf_filter_get_additional_values();
 $locale = $values['locale'];
 $date_formats = $values['date_formats'];

 
+
opf_filter_name_to_setting
function opf_filter_name_to_setting($name)
For WBCE 1.2: This function converts the name of a filter to the settings string which is associated with the active/inactive state of the given filter name.
Prototype
string opf_filter_name_to_setting( string )
Parameters
$namestring the name of the filter
Returns
the name of the corresponding setting (in lowercase letters)
Examples
    if(Settings::Get(opf_filter_name_to_setting($name))){
+  // do something;
+}

+
 

 
 
@@ -346,7 +350,7 @@
 
 
 
-
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.
function opf_add_class(&$content,
$class,
$tag)
Add a class to a present HTML-tag, i.e. 
function opf_add_class_to_class(&$content,  
$class,  
$present_class,  
$tag = '')
Add a class to an already present class. 
function opf_add_class_to_attr(&$content,  
$class,  
$attr,  
$value,  
$tag = '')
Add a class to all HTML-tags that has a given attribute.
function opf_cut_extract(&$content,  
$regex,  
$subpattern = 0,
$modifers = 'iU',
$delimiter = '~',
$extracts = '')
Cuts pieces out of content using a regular expression and replace them by placeholders.
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
function opf_filter_get_additional_values()
Receive additional filter arguments

+
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 
function opf_unregister_filter($name)
Un-Register a Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.
function opf_add_class(&$content,
$class,
$tag)
Add a class to a present HTML-tag, i.e. 
function opf_add_class_to_class(&$content,  
$class,  
$present_class,  
$tag = '')
Add a class to an already present class. 
function opf_add_class_to_attr(&$content,  
$class,  
$attr,  
$value,  
$tag = '')
Add a class to all HTML-tags that has a given attribute.
function opf_cut_extract(&$content,  
$regex,  
$subpattern = 0,
$modifers = 'iU',
$delimiter = '~',
$extracts = '')
Cuts pieces out of content using a regular expression and replace them by placeholders.
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
function opf_filter_get_additional_values()
Receive additional filter arguments
function opf_filter_name_to_setting($name)
For WBCE 1.2: This function converts the name of a filter to the settings string which is associated with the active/inactive state of the given filter name.

 
 
 
diff --git a/docs/index/Files.html b/docs/index/Files.html
index c8c14b7..6637792 100644
--- a/docs/index/Files.html
+++ b/docs/index/Files.html
@@ -49,7 +49,7 @@
 
 
 
-
1.5.0 (mrbaseman, 29 Sept 2016)

+
1.5.1 (mrbaseman, 25 Jan 2017)

 
 

 
diff --git a/docs/index/Functions.html b/docs/index/Functions.html
index 0a12fb1..0060ad0 100644
--- a/docs/index/Functions.html
+++ b/docs/index/Functions.html
@@ -11,7 +11,7 @@
 
 
 
-
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
opf_add_class
opf_add_class_to_attr
opf_add_class_to_class
C
opf_cut_extract
F
opf_filter_exists
opf_filter_get_additional_values
opf_filter_get_data
opf_filter_get_rel_pos
opf_filter_is_active
opf_find_class
G
opf_glue_extract
I
opf_is_childpage
M
opf_move_up_before
R
opf_register_document_ready
opf_register_filter
opf_register_frontend_files
opf_register_onload
opf_register_onload_event
U
opf_unregister_filter

+
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
opf_add_class
opf_add_class_to_attr
opf_add_class_to_class
C
opf_cut_extract
F
opf_filter_exists
opf_filter_get_additional_values
opf_filter_get_data
opf_filter_get_rel_pos
opf_filter_is_active
opf_filter_name_to_setting
opf_find_class
G
opf_glue_extract
I
opf_is_childpage
M
opf_move_up_before
R
opf_register_document_ready
opf_register_filter
opf_register_frontend_files
opf_register_onload
opf_register_onload_event
U
opf_unregister_filter

 
 
function opf_add_class(&$content,
$class,
$tag)
Add a class to a present HTML-tag, i.e. 
function opf_add_class_to_attr(&$content,  
$class,  
$attr,  
$value,  
$tag = '')
Add a class to all HTML-tags that has a given attribute.
function opf_add_class_to_class(&$content,  
$class,  
$present_class,  
$tag = '')
Add a class to an already present class. 

 
@@ -21,27 +21,27 @@
 
 
 
-
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_filter_get_additional_values()
Receive additional filter arguments
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.

+
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_filter_get_additional_values()
Receive additional filter arguments
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
function opf_filter_name_to_setting($name)
For WBCE 1.2: This function converts the name of a filter to the settings string which is associated with the active/inactive state of the given filter name.
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.

 
 
 
-
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )

+
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )

 
 
 
-
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)

+
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)

 
 
 
-
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 

+
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 

 
 
 
-
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().

+
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().

 
 
 
-
function opf_unregister_filter($name)
Un-Register a Filter.

+
function opf_unregister_filter($name)
Un-Register a Filter.

 
 

 
diff --git a/docs/index/General.html b/docs/index/General.html
index 6d37da1..747e78d 100644
--- a/docs/index/General.html
+++ b/docs/index/General.html
@@ -11,7 +11,7 @@
 
 
 
-
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
opf_add_class
opf_add_class_to_attr
opf_add_class_to_class
 Admin-Tool
DE/admin.txtDE/intro.txtEN/admin.txtEN/intro.txt
 Admin-Tool Overview
 Admin-ToolÜbersicht
 Admin-Tool(de)
 Admin-Tool(en)
 After installation
 Apply two patches
B
 Before installation
 Beschreibung
C
 Core-Dateien verändern
 Create and install a Plugin-Filter
 Create Inline-Filter(en)
 Create Module-Filter(en)
 Create Plugin-Filter(en)
opf_cut_extract
D
 Description
E
 Einen Filter als Teil eines Moduls installieren
 Einen Plugin-Filter erzeugen
 Einführung
 Einführung(de)
 Export Filters
F
 Filter
 Filter exportieren
 Filter functions
 Filter Installieren
opf_filter_exists
opf_filter_get_additional_values
opf_filter_get_data
opf_filter_get_rel_pos
opf_filter_is_active
 Filters
opf_find_class
 Functions
G
opf_glue_extract
H
 How to install the OutputFilter-Dashboard module itself
I
 Inline-Filter schreiben(de)
 Install a filter as part of a module
 Install Filters
 Install OutputFilter-Dashboard(en)
 Installation
DE/install_opf.txtEN/install_opf.txt
 Installation des OutputFilter-Dashboard Moduls
 Introduction
 Introduction(en)
opf_is_childpage
L
 License(Documentation)
 License(Software)
 Licenses
M
 Modul-Filter schreiben(de)
opf_move_up_before
N
 Nach der Installation
O
 OutputFilter-Dashboard Modul installieren(de)
P
 Patch
DE/intro.txtEN/intro.txt
 php
precheck
DE/install_filter_module.txtEN/install_filter_module.txt
wb/framework/frontend.functions
DE/install_opf.txtEN/install_opf.txt
wb/index
DE/install_opf.txtEN/install_opf.txt
 Plugin-Filter schreiben(de)
R
opf_register_document_ready
opf_register_filter
opf_register_frontend_files
opf_register_onload
opf_register_onload_event
 Requirements
T
 The Filter-Function itself
U
opf_unregister_filter
V
 Version-History
 Vor der Installation
 Voraussetzungen

+
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
opf_add_class
opf_add_class_to_attr
opf_add_class_to_class
 Admin-Tool
DE/admin.txtDE/intro.txtEN/admin.txtEN/intro.txt
 Admin-Tool Overview
 Admin-ToolÜbersicht
 Admin-Tool(de)
 Admin-Tool(en)
 After installation
 Apply two patches
B
 Before installation
 Beschreibung
C
 Core-Dateien verändern
 Create and install a Plugin-Filter
 Create Inline-Filter(en)
 Create Module-Filter(en)
 Create Plugin-Filter(en)
opf_cut_extract
D
 Description
E
 Einen Filter als Teil eines Moduls installieren
 Einen Plugin-Filter erzeugen
 Einführung
 Einführung(de)
 Export Filters
F
 Filter
 Filter exportieren
 Filter functions
 Filter Installieren
opf_filter_exists
opf_filter_get_additional_values
opf_filter_get_data
opf_filter_get_rel_pos
opf_filter_is_active
opf_filter_name_to_setting
 Filters
opf_find_class
 Functions
G
opf_glue_extract
H
 How to install the OutputFilter-Dashboard module itself
I
 Inline-Filter schreiben(de)
 Install a filter as part of a module
 Install Filters
 Install OutputFilter-Dashboard(en)
 Installation
DE/install_opf.txtEN/install_opf.txt
 Installation des OutputFilter-Dashboard Moduls
 Introduction
 Introduction(en)
opf_is_childpage
L
 License(Documentation)
 License(Software)
 Licenses
M
 Modul-Filter schreiben(de)
opf_move_up_before
N
 Nach der Installation
O
 OutputFilter-Dashboard Modul installieren(de)
P
 Patch
DE/intro.txtEN/intro.txt
 php
precheck
DE/install_filter_module.txtEN/install_filter_module.txt
wb/framework/frontend.functions
DE/install_opf.txtEN/install_opf.txt
wb/index
DE/install_opf.txtEN/install_opf.txt
 Plugin-Filter schreiben(de)
R
opf_register_document_ready
opf_register_filter
opf_register_frontend_files
opf_register_onload
opf_register_onload_event
 Requirements
T
 The Filter-Function itself
U
opf_unregister_filter
V
 Version-History
 Vor der Installation
 Voraussetzungen

 
 
function opf_add_class(&$content,
$class,
$tag)
Add a class to a present HTML-tag, i.e. 
function opf_add_class_to_attr(&$content,  
$class,  
$attr,  
$value,  
$tag = '')
Add a class to all HTML-tags that has a given attribute.
function opf_add_class_to_class(&$content,  
$class,  
$present_class,  
$tag = '')
Add a class to an already present class. 
Das Admin-Tool ist der zentrale Punkt um Filter zu installieren, steuern, löschen oder zu exportieren. 
The overview lists all installed filters, grouped by type of filter. 
In der Filter-Übersicht werden alle installiertien Filter angezeigt, gruppiert nach Typ des Filters. 
Website Baker Version 2.8.3 sp6 and later as well as Website Baker Community Edition Version WBCE 1.1 onwards already contain all the adaptions needed. 
To make the Filter work, you have to patch two core-files

 
@@ -33,11 +33,11 @@
 
 
 
-
Für die Installation von Filtern siehe Filter Installieren.
Benutzen Sie das “Exportieren”-Icon in der Filter-Übersicht, um einen vorhandenen Inline- oder Plugin-Filter zu exportieren. 
Um einen neuen Inline-Filter zu installieren, klicken Sie einfach den “Neuen Inline-Filter hinzufügen”-Schaltfläche an,        und geben Sie die Daten des Filters in das Formular auf der folgenden Seite ein.
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_filter_get_additional_values()
Receive additional filter arguments
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
See Install Filters on how to install filters.
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.

+
Für die Installation von Filtern siehe Filter Installieren.
Benutzen Sie das “Exportieren”-Icon in der Filter-Übersicht, um einen vorhandenen Inline- oder Plugin-Filter zu exportieren. 
Um einen neuen Inline-Filter zu installieren, klicken Sie einfach den “Neuen Inline-Filter hinzufügen”-Schaltfläche an,        und geben Sie die Daten des Filters in das Formular auf der folgenden Seite ein.
function opf_filter_exists($name,  
$verbose = FALSE)
Checks whether a given filter exists
function opf_filter_get_additional_values()
Receive additional filter arguments
function opf_filter_get_data($name = '')
Fetch data from filter.
function opf_filter_get_rel_pos($name)
Checks if a given filter was or will be executed.
function opf_filter_is_active($name)
Checkes whether a given filter is active for the actual module and page_id
function opf_filter_name_to_setting($name)
For WBCE 1.2: This function converts the name of a filter to the settings string which is associated with the active/inactive state of the given filter name.
See Install Filters on how to install filters.
function opf_find_class($content,  
$match,  
$tag = '',
$attr = 'class')
Check whether a class (or any other attribute) is present in content.

 
 
 
-
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )

+
function opf_glue_extract(&$content,
$extracts)
bool opf_glue_extract( string &$content, string $extracts )

 
 
 
@@ -45,19 +45,19 @@
 
 
 
-
Bitte sehen Sie die Beschreibung unter Admin-Tool (de).
To add a filter to a module, just add calls to opf_register_filter() and opf_unregister_filter() to that module’s install.php  
To install a new inline-filter, just press the “Add new inline filter”-Button, and insert the filter-dependent data into the form.
Installieren Sie OutputFilter-Dashboard wie üblich.
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)

+
Bitte sehen Sie die Beschreibung unter Admin-Tool (de).
To add a filter to a module, just add calls to opf_register_filter() and opf_unregister_filter() to that module’s install.php  
To install a new inline-filter, just press the “Add new inline filter”-Button, and insert the filter-dependent data into the form.
Installieren Sie OutputFilter-Dashboard wie üblich.
function opf_is_childpage($child,
$parent)
Checks whether a page is a subpage of a given page (or the same page)

 
 
 
-
OutputFilter-Dashboard Documentation is licensed under the Creative Commons Attribution ShareAlike License, v.3.0 Germany. 
OutputFilter-Dashboard is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

+
OutputFilter-Dashboard Documentation is licensed under the Creative Commons Attribution ShareAlike License, v.3.0 Germany. 
OutputFilter-Dashboard is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

 
 
 
-
function opf_move_up_before($name,
$ref_name)
Upon registration move a filter up to a position before another one. 

+
function opf_move_up_before($name,  
$ref_name = "")
Upon registration move a filter up to a position before another one. 

 
 
 
-
Website Baker ab Version 2.8.3 sp6 und Website Baker Community Edition ab WBCE 1.1 entalten bereits alle notwendigen Anpassungen. 

+
Website Baker ab Version 2.8.3 sp6 und Website Baker Community Edition ab WBCE 1.1 entalten bereits alle notwendigen Anpassungen. 

 
 
 
@@ -65,23 +65,23 @@
 
 
 
-
Damit OutputfilterDashboard funktioniert, müssen zwei Dateien von WebsiteBaker angepaßt werden. 
Überprüfen Sie vor der installation, ob Outputfilter-Dashboard installiert ist. 

+
Damit OutputfilterDashboard funktioniert, müssen zwei Dateien von WebsiteBaker angepaßt werden. 
Überprüfen Sie vor der installation, ob Outputfilter-Dashboard installiert ist. 

 
 
 
-
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().
Website Baker 2.8 or later.

+
function opf_register_document_ready($js)
Register an Javascript onload-event inside page’s head-section, using jquery’s jQuery(document).ready()  
function opf_register_filter($filter,  
$serialized = FALSE)
Register a new Filter.
function opf_register_frontend_files($file,  
$type,  
$target = 'head',
$media = 'screen',
$iehack = '')
Register JS- or CSS-files to be loaded into the page’s head-section.
function opf_register_onload($script)
Register an Javascript script onload-function inside page’s body-section.
function opf_register_onload_event($function_name)
Register an Javascript onload-function inside page’s head-section, using window.attachEvent() or window.addEventListener().
Website Baker 2.8 or later.

 
 
 
-
The Filter function must have an unique name, and should have a “opff_”-prefix

+
The Filter function must have an unique name, and should have a “opff_”-prefix

 
 
 
-
function opf_unregister_filter($name)
Un-Register a Filter.

+
function opf_unregister_filter($name)
Un-Register a Filter.

 
 
 
-
1.5.0 (mrbaseman, 29 Sept 2016)
Vor der Installation von OutputFilter-Dashboard muß das alte Frontend-Filter-Admin Modul - wenn vorhanden - deinstalliert werden, nicht zu verwechseln mit dem Frontend-Output-Filter!
Website Baker 2.8 oder neuer.

+
1.5.1 (mrbaseman, 25 Jan 2017)
Vor der Installation von OutputFilter-Dashboard muß das alte Frontend-Filter-Admin Modul - wenn vorhanden - deinstalliert werden, nicht zu verwechseln mit dem Frontend-Output-Filter!
Website Baker 2.8 oder neuer.

 
 

 
diff --git a/docs/search/FunctionsF.html b/docs/search/FunctionsF.html
index 8bbb602..ec55b88 100644
--- a/docs/search/FunctionsF.html
+++ b/docs/search/FunctionsF.html
@@ -11,7 +11,7 @@
 
 
 
-
Loading...
Searching...
No Matches