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 _colls_list_public.widget.php

Documentation is available at _colls_list_public.widget.php

  1. <?php
  2. /**
  3.  * This file implements the colls_list_public 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: _colls_list_public.widget.php,v 1.12 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 colls_list_public_Widget extends ComponentWidget
  38. {
  39.     /**
  40.      * Constructor
  41.      */
  42.     function colls_list_public_Widget( $db_row = NULL )
  43.     {
  44.         // Call parent constructor:
  45.         parent::ComponentWidget( $db_row, 'core', 'colls_list_public' );
  46.     }
  47.  
  48.  
  49.     /**
  50.      * Get name of widget
  51.      */
  52.     function get_name()
  53.     {
  54.         return T_('Public blog list');
  55.     }
  56.  
  57.  
  58.     /**
  59.      * Get a very short desc. Used in the widget list.
  60.      */
  61.     function get_short_desc()
  62.     {
  63.         return format_to_output($this->disp_params['title']);
  64.     }
  65.  
  66.  
  67.   /**
  68.      * Get short description
  69.      */
  70.     function get_desc()
  71.     {
  72.         return T_('Display list of all blogs marked as public.');
  73.     }
  74.  
  75.  
  76.   /**
  77.    * Get definitions for editable params
  78.    *
  79.      * @see Plugin::GetDefaultSettings()
  80.      * @param local params like 'for_editing' => true
  81.      */
  82.     function get_param_definitions( $params )
  83.     {
  84.         global $use_strict;
  85.         $r = array_merge( array(
  86.                 'title' => array(
  87.                     'label' => T_( 'Title' ),
  88.                     'size' => 40,
  89.                     'note' => T_( 'This is the title to display, $icon$ will be replaced by the feed icon' ),
  90.                     'defaultvalue' => T_('All blogs'),
  91.                 ),
  92.                 /* 3.3? this is borked
  93.                 'list_type' => array(
  94.                     'label' => T_( 'Display type' ),
  95.                     'type' => 'select',
  96.                     'defaultvalue' => 'list',
  97.                     'options' => array( 'list' => T_('List'), 'form' => T_('Select menu') ),
  98.                     'note' => T_( 'How do you want to display blogs?' ),
  99.                 ),
  100.                 */
  101.             ), parent::get_param_definitions( $params )    );
  102.  
  103.         return $r;
  104.     }
  105.  
  106.  
  107.     /**
  108.      * Display the widget!
  109.      *
  110.      * @param array MUST contain at least the basic display params
  111.      */
  112.     function display( $params )
  113.     {
  114.         $this->init_display( $params );
  115.  
  116.         $this->disp_coll_list( 'public' );
  117.  
  118.         return true;
  119.     }
  120.  
  121.  
  122.     /**
  123.      * Maybe be overriden by some widgets, depending on what THEY depend on..
  124.      *
  125.      * @return array of keys this widget depends on
  126.      */
  127.     function get_cache_keys()
  128.     {
  129.         global $Blog;
  130.  
  131.         return array(
  132.                 'wi_ID'   => $this->ID,                    // Have the widget settings changed ?
  133.                 'set_coll_ID' =>'any',                     // Have the settings of ANY blog changed ? (ex: new skin here, new name on another)
  134.             );
  135.     }
  136. }
  137.  
  138.  
  139. /*
  140.  * $Log: _colls_list_public.widget.php,v $
  141.  * Revision 1.12  2010/02/08 17:54:48  efy-yury
  142.  * copyright 2009 -> 2010
  143.  *
  144.  * Revision 1.11  2009/12/22 03:30:24  blueyed
  145.  * cleanup
  146.  *
  147.  * Revision 1.10  2009/12/01 04:19:25  fplanque
  148.  * even more invalidation dimensions
  149.  *
  150.  * Revision 1.9  2009/09/14 13:54:13  efy-arrin
  151.  * Included the ClassName in load_class() call with proper UpperCase
  152.  *
  153.  * Revision 1.8  2009/09/12 11:03:13  efy-arrin
  154.  * Included the ClassName in the loadclass() with proper UpperCase
  155.  *
  156.  * Revision 1.7  2009/07/02 21:50:13  fplanque
  157.  * commented out unfinished code
  158.  *
  159.  * Revision 1.6  2009/06/18 07:35:53  yabs
  160.  * bugfix : $type is already a param ;)
  161.  *
  162.  * Revision 1.5  2009/05/28 06:49:06  sam2kb
  163.  * Blog list widget can be either a "regular list" or a "select menu"
  164.  * See http://forums.b2evolution.net/viewtopic.php?t=18794
  165.  *
  166.  * Revision 1.4  2009/03/13 02:32:07  fplanque
  167.  * Cleaned up widgets.
  168.  * Removed stupid widget_name param.
  169.  *
  170.  * Revision 1.3  2009/03/08 23:57:46  fplanque
  171.  * 2009
  172.  *
  173.  * Revision 1.2  2008/01/21 09:35:37  fplanque
  174.  * (c) 2008
  175.  *
  176.  * Revision 1.1  2007/06/25 11:02:24  fplanque
  177.  * MODULES (refactored MVC)
  178.  *
  179.  * Revision 1.3  2007/06/20 21:42:13  fplanque
  180.  * implemented working widget/plugin params
  181.  *
  182.  * Revision 1.2  2007/06/20 14:25:00  fplanque
  183.  * fixes
  184.  *
  185.  * Revision 1.1  2007/06/18 21:25:47  fplanque
  186.  * one class per core widget
  187.  *
  188.  */
  189. ?>
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:04:09 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).