liberty
[ class tree: liberty ] [ index: liberty ] [ all elements ]

Source for file data.comment.php

Documentation is available at data.comment.php

  1. <?php
  2. /**
  3.  * @version  $Revision$
  4.  * @package  liberty
  5.  * @subpackage plugins_data
  6.  */
  7.  
  8. /**
  9.  * definitions
  10.  */
  11. global $gLibertySystem;
  12. define'PLUGIN_GUID_DATACOMMENT''datacomment' );
  13. global $gLibertySystem;
  14. $pluginParams array (
  15.     'tag'           => 'COMMENT',
  16.     'auto_activate' => FALSE,
  17.     'requires_pair' => TRUE,
  18.     'load_function' => 'data_comment',
  19.     'title'         => 'Comment',
  20.     'help_page'     => 'DataPluginComment',
  21.     'description'   => tra("This plugin allows Comments (Text that will not be displayed) to be added to a page."),
  22.     'help_function' => 'data__comment_help',
  23.     'syntax'        => "{comment}Data Not Displayed{/comment}",
  24.     'plugin_type'   => DATA_PLUGIN
  25. );
  26. $gLibertySystem->registerPluginPLUGIN_GUID_DATACOMMENT$pluginParams );
  27. $gLibertySystem->registerDataTag$pluginParams['tag']PLUGIN_GUID_DATACOMMENT );
  28.  
  29. /**
  30.  * data_comment_help
  31.  * 
  32.  * @access public
  33.  * @return string help
  34.  */
  35. function data_comment_help({
  36.     $help =
  37.         '<table class="data help">'
  38.             .'<tr>'
  39.                 .'<th>' tra"Key" '</th>'
  40.                 .'<th>' tra"Type" '</th>'
  41.                 .'<th>' tra"Comments" '</th>'
  42.             .'</tr>'
  43.             .'<tr class="odd">'
  44.                 .'<td>' tra("This plugin uses no parameters. Anything located between the two")
  45.                 . ' <strong>{COMMENT}</strong> ' tra("Blocks is not displayed."'</td>'
  46.             .'</tr>'
  47.         .'</table>'
  48.         . tra("Example: ""{COMMENT}" tra("Everything in here is not displayed.""{/COMMENT}";
  49.     return $help;
  50. }
  51.  
  52. /**
  53.  * data_comment
  54.  * 
  55.  * @access public
  56.  * @return string ' '
  57.  */
  58. function data_comment$pData$pParams {
  59.     return ' ';
  60. }
  61. ?>

Documentation generated on Wed, 29 Jul 2015 13:56:18 +0000 by phpDocumentor 1.5.0-lsces