b2evolution

Multilingual multiuser multiblog engine

Home About Demo Download Hosting Extend Docs Support
b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Source for file _free_html.widget.php

Documentation is available at _free_html.widget.php

  1. <?php
  2. /**
  3.  * This file implements the xyz Widget class.
  4.  *
  5.  * This file is part of the evoCore framework - {@link http://evocore.net/}
  6.  * See also {@link http://sourceforge.net/projects/evocms/}.
  7.  *
  8.  * @copyright (c)2003-2010 by Francois PLANQUE - {@link http://fplanque.net/}
  9.  *
  10.  *  {@internal License choice
  11.  *  - If you have received this file as part of a package, please find the license.txt file in
  12.  *    the same folder or the closest folder above for complete license terms.
  13.  *  - If you have received this file individually (e-g: from http://evocms.cvs.sourceforge.net/)
  14.  *    then you must choose one of the following licenses before using the file:
  15.  *    - GNU General Public License 2 (GPL) - http://www.opensource.org/licenses/gpl-license.php
  16.  *    - Mozilla Public License 1.1 (MPL) - http://www.opensource.org/licenses/mozilla1.1.php
  17.  *  }}}
  18.  *
  19.  * @package evocore
  20.  *
  21.  *  {@internal Below is a list of authors who have contributed to design/coding of this file: }}
  22.  * @author fplanque: Francois PLANQUE.
  23.  *
  24.  * @version $Id: _free_html.widget.php,v 1.22 2010/02/08 17:54:48 efy-yury Exp $
  25.  */
  26. if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
  27.  
  28. load_class( 'widgets/model/_widget.class.php', 'ComponentWidget' );
  29.  
  30. /**
  31.  * ComponentWidget Class
  32.  *
  33.  * A ComponentWidget is a displayable entity that can be placed into a Container on a web page.
  34.  *
  35.  * @package evocore
  36.  */
  37. class free_html_Widget extends ComponentWidget
  38. {
  39.     /**
  40.      * Constructor
  41.      */
  42.     function free_html_Widget( $db_row = NULL )
  43.     {
  44.         // Call parent constructor:
  45.         parent::ComponentWidget( $db_row, 'core', 'free_html' );
  46.     }
  47.  
  48.  
  49.     /**
  50.      * Get name of widget
  51.      */
  52.     function get_name()
  53.     {
  54.         $title = T_( 'Free HTML' );
  55.         return $title;
  56.     }
  57.  
  58.  
  59.     /**
  60.      * Get a very short desc. Used in the widget list.
  61.      *
  62.      * @return string The block title, the first 60 characters of the block
  63.      *                 content or an empty string.
  64.      */
  65.     function get_short_desc()
  66.     {
  67.         if( empty( $this->disp_params['title'] ) )
  68.         {
  69.             return strmaxlen( $this->disp_params['content'], 60, NULL, /* use htmlspecialchars() */ 'formvalue' );
  70.         }
  71.  
  72.         return format_to_output( $this->disp_params['title'] );
  73.     }
  74.  
  75.  
  76.   /**
  77.      * Get short description
  78.      */
  79.     function get_desc()
  80.     {
  81.         return T_('Custom text/HTML of your choice.');
  82.     }
  83.  
  84.  
  85.   /**
  86.    * Get definitions for editable params
  87.    *
  88.      * @see Plugin::GetDefaultSettings()
  89.      * @param local params like 'for_editing' => true
  90.      */
  91.     function get_param_definitions( $params )
  92.     {
  93.         // Demo data:
  94.         $r = array_merge( array(
  95.                 'title' => array(
  96.                     'label' => T_('Block title'),
  97.                     'size' => 60,
  98.                 ),
  99.                 'content' => array(
  100.                     'type' => 'html_textarea',
  101.                     'label' => T_('Block content'),
  102.                     'rows' => 10,
  103.                 ),
  104.             ), parent::get_param_definitions( $params )    );
  105.  
  106.         return $r;
  107.  
  108.     }
  109.  
  110.  
  111.     /**
  112.      * Display the widget!
  113.      *
  114.      * @param array MUST contain at least the basic display params
  115.      */
  116.     function display( $params )
  117.     {
  118.         global $Blog;
  119.  
  120.         $this->init_display( $params );
  121.  
  122.         // Collection common links:
  123.         echo $this->disp_params['block_start'];
  124.  
  125.         $this->disp_title( $this->disp_params['title'] );
  126.  
  127.         echo format_to_output( $this->disp_params['content'] );
  128.  
  129.         echo $this->disp_params['block_end'];
  130.  
  131.         return true;
  132.     }
  133. }
  134.  
  135.  
  136. /*
  137.  * $Log: _free_html.widget.php,v $
  138.  * Revision 1.22  2010/02/08 17:54:48  efy-yury
  139.  * copyright 2009 -> 2010
  140.  *
  141.  * Revision 1.21  2009/09/29 13:29:58  tblue246
  142.  * Proper security fixes
  143.  *
  144.  * Revision 1.20  2009/09/29 03:29:58  fplanque
  145.  * security fix
  146.  *
  147.  * Revision 1.19  2009/09/27 12:57:29  blueyed
  148.  * strmaxlen: add format param, which is used on the (possibly) cropped string.
  149.  *
  150.  * Revision 1.18  2009/09/14 13:54:13  efy-arrin
  151.  * Included the ClassName in load_class() call with proper UpperCase
  152.  *
  153.  * Revision 1.17  2009/09/12 11:03:13  efy-arrin
  154.  * Included the ClassName in the loadclass() with proper UpperCase
  155.  *
  156.  * Revision 1.16  2009/08/06 16:12:57  tblue246
  157.  * - Make block title field name translatable - again...
  158.  * - Show first 60 chars of block content if block title is empty
  159.  *
  160.  * Revision 1.15  2009/08/06 15:04:25  fplanque
  161.  * internal name is overkill. (too many confusing params not good)
  162.  * (maybe the first chars of content if title is empty ?)
  163.  *
  164.  * Revision 1.14  2009/08/03 14:05:04  tblue246
  165.  * minor
  166.  *
  167.  * Revision 1.13  2009/08/03 12:33:57  tblue246
  168.  * Add "internal name" field to HTML widget and make another field title translatable
  169.  *
  170.  * Revision 1.12  2009/03/13 02:32:07  fplanque
  171.  * Cleaned up widgets.
  172.  * Removed stupid widget_name param.
  173.  *
  174.  * Revision 1.11  2009/03/08 23:57:46  fplanque
  175.  * 2009
  176.  *
  177.  * Revision 1.10  2008/05/06 23:35:47  fplanque
  178.  * The correct way to add linebreaks to widgets is to add them to $disp_params when the container is called, right after the array_merge with defaults.
  179.  *
  180.  * Revision 1.8  2008/01/21 09:35:37  fplanque
  181.  * (c) 2008
  182.  *
  183.  * Revision 1.7  2007/12/23 16:16:18  fplanque
  184.  * Wording improvements
  185.  *
  186.  * Revision 1.6  2007/12/23 14:14:25  fplanque
  187.  * Enhanced widget name display
  188.  *
  189.  * Revision 1.5  2007/12/22 19:55:00  yabs
  190.  * cleanup from adding core params
  191.  *
  192.  * Revision 1.4  2007/12/22 17:02:50  yabs
  193.  * removing obsolete params
  194.  *
  195.  * Revision 1.3  2007/11/28 23:23:18  yabs
  196.  * clarification of params
  197.  *
  198.  * Revision 1.2  2007/11/27 10:02:04  yabs
  199.  * added params
  200.  *
  201.  * Revision 1.1  2007/06/25 11:02:25  fplanque
  202.  * MODULES (refactored MVC)
  203.  *
  204.  * Revision 1.2  2007/06/20 21:42:14  fplanque
  205.  * implemented working widget/plugin params
  206.  *
  207.  * Revision 1.1  2007/06/20 13:19:29  fplanque
  208.  * Free html widget
  209.  *
  210.  */
  211. ?>
evocore

Packages

main
admin
admin-skin
AmCode
collections
conf
evocore
evoskins
htsrv
install
libs
maintenance
MCFileManager-filesystems
MCManager-includes
MCManager-utils
messaging
plugins
sessions
skins
xmlsrv

Documentation generated on Sat, 06 Mar 2010 04:10:35 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).