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

Documentation is available at _coll_avatar.widget.php

  1. <?php
  2. /**
  3.  * This file implements the coll_avatar_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.  *  Parts of this file are copyright (c)2008 by Daniel HAHLER - {@link http://daniel.hahler.de/}.
  10.  *
  11.  *  {@internal License choice
  12.  *  - If you have received this file as part of a package, please find the license.txt file in
  13.  *    the same folder or the closest folder above for complete license terms.
  14.  *  - If you have received this file individually (e-g: from http://evocms.cvs.sourceforge.net/)
  15.  *    then you must choose one of the following licenses before using the file:
  16.  *    - GNU General Public License 2 (GPL) - http://www.opensource.org/licenses/gpl-license.php
  17.  *    - Mozilla Public License 1.1 (MPL) - http://www.opensource.org/licenses/mozilla1.1.php
  18.  *  }}}
  19.  *
  20.  * @package evocore
  21.  *
  22.  *  {@internal Below is a list of authors who have contributed to design/coding of this file: }}
  23.  * @author blueyed: Daniel HAHLER
  24.  * @author fplanque: Francois PLANQUE.
  25.  *
  26.  * @version $Id: _coll_avatar.widget.php,v 1.8 2010/02/08 17:54:47 efy-yury Exp $
  27.  */
  28. if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
  29.  
  30. load_class( 'widgets/model/_widget.class.php', 'ComponentWidget' );
  31.  
  32. /**
  33.  * coll_avatar_Widget Class.
  34.  *
  35.  * This displays the blog owner's avatar.
  36.  *
  37.  * @package evocore
  38.  */
  39. class coll_avatar_Widget extends ComponentWidget
  40. {
  41.     /**
  42.      * Constructor
  43.      */
  44.     function coll_avatar_Widget( $db_row = NULL )
  45.     {
  46.         // Call parent constructor:
  47.         parent::ComponentWidget( $db_row, 'core', 'coll_avatar' );
  48.     }
  49.  
  50.  
  51.     /**
  52.      * Get name of widget
  53.      */
  54.     function get_name()
  55.     {
  56.         return T_('Avatar');
  57.     }
  58.  
  59.  
  60.     /**
  61.      * Get short description
  62.      */
  63.     function get_desc()
  64.     {
  65.         return T_('Display the avatar of the blog owner.');
  66.     }
  67.  
  68.  
  69.     /**
  70.      * Get definitions for editable params
  71.      *
  72.      * @see Plugin::GetDefaultSettings()
  73.      * @param array local params
  74.      *   - 'size': Size definition, see {@link $thumbnail_sizes}. E.g. 'fit-160x160'.
  75.      */
  76.     function get_param_definitions( $params )
  77.     {
  78.         global $thumbnail_sizes;
  79.  
  80.         $options = array();
  81.         // PHP 4 replacement for array_combine():
  82.         foreach( array_keys( $thumbnail_sizes ) as $thumb_size )
  83.         {
  84.             $options[$thumb_size] = $thumb_size;
  85.         }
  86.  
  87.         $r = array_merge( array(
  88.             'thumb_size' => array(
  89.                     'type' => 'select',
  90.                     'label' => T_('Image size'),
  91.                     'options' => $options,
  92.                     'note' => sprintf( /* TRANS: %s is a config variable name */ T_('List of available image sizes is defined in %s.'), '$thumbnail_sizes' ),
  93.                     'defaultvalue' => 'fit-160x160',
  94.                 ),
  95.             ), parent::get_param_definitions( $params ) );
  96.  
  97.         return $r;
  98.     }
  99.  
  100.  
  101.     /**
  102.      * Display the widget!
  103.      *
  104.      * @param array MUST contain at least the basic display params
  105.      */
  106.     function display( $params )
  107.     {
  108.         global $cat_modifier;
  109.         global $Blog;
  110.  
  111.         $this->init_display( $params );
  112.  
  113.         $owner_User = & $Blog->get_owner_User();
  114.  
  115.         if( ! $owner_User->has_avatar() )
  116.         {
  117.             return false;
  118.         }
  119.  
  120.         // START DISPLAY:
  121.         echo $this->disp_params['block_start'];
  122.  
  123.         // Display title if requested
  124.         $this->disp_title();
  125.  
  126.         echo $owner_User->get_link( array(
  127.                 'link_to'           => 'userpage',  // TODO: make configurable $this->disp_params['link_to']
  128.                 'link_text'    => 'avatar',
  129.                 'thumb_size'     => $this->disp_params['thumb_size'],
  130.             ) );
  131.  
  132.         echo $this->disp_params['block_end'];
  133.  
  134.         return true;
  135.     }
  136.  
  137.  
  138.     /**
  139.      * Maybe be overriden by some widgets, depending on what THEY depend on..
  140.      *
  141.      * @return array of keys this widget depends on
  142.      */
  143.     function get_cache_keys()
  144.     {
  145.         global $Blog;
  146.  
  147.         $owner_User = & $Blog->get_owner_User();
  148.  
  149.         return array(
  150.                 'wi_ID'   => $this->ID,                    // Have the widget settings changed ?
  151.                 'set_coll_ID' => $Blog->ID,            // Have the settings of the blog changed ? (ex: new owner, new skin)
  152.                 'user_ID' => $owner_User->ID,     // Has the owner User changed? (name, avatar, etc..)
  153.             );
  154.     }
  155. }
  156.  
  157.  
  158. /*
  159.  * $Log: _coll_avatar.widget.php,v $
  160.  * Revision 1.8  2010/02/08 17:54:47  efy-yury
  161.  * copyright 2009 -> 2010
  162.  *
  163.  * Revision 1.7  2009/12/01 04:19:25  fplanque
  164.  * even more invalidation dimensions
  165.  *
  166.  * Revision 1.6  2009/12/01 03:45:37  fplanque
  167.  * multi dimensional invalidation
  168.  *
  169.  * Revision 1.5  2009/10/03 21:00:50  tblue246
  170.  * Bugfixes
  171.  *
  172.  * Revision 1.4  2009/09/30 19:09:39  blueyed
  173.  * trans fix
  174.  *
  175.  * Revision 1.3  2009/09/20 01:35:52  fplanque
  176.  * Factorized User::get_link()
  177.  *
  178.  * Revision 1.2  2009/09/20 00:51:43  fplanque
  179.  * OMG!!
  180.  *
  181.  * Revision 1.1  2009/09/20 00:33:59  blueyed
  182.  * Add widget to display avatar of collection/blog owner. Install it for all new blogs by default.
  183.  *
  184.  */
  185. ?>
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:19 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).