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

Documentation is available at _coll_xml_feeds.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: _coll_xml_feeds.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 coll_xml_feeds_Widget extends ComponentWidget
  38. {
  39.     /**
  40.      * Constructor
  41.      */
  42.     function coll_xml_feeds_Widget( $db_row = NULL )
  43.     {
  44.         // Call parent constructor:
  45.         parent::ComponentWidget( $db_row, 'core', 'coll_xml_feeds' );
  46.     }
  47.  
  48.  
  49.     /**
  50.      * Get name of widget
  51.      */
  52.     function get_name()
  53.     {
  54.         return T_('XML Feeds (RSS / Atom)');
  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->get_title());
  64.     }
  65.  
  66.  
  67.   /**
  68.      * Get short description
  69.      */
  70.     function get_desc()
  71.     {
  72.         return T_('List of all available XML feeds.');
  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' => '$icon$ '.T_('XML Feeds'),
  91.                 ),
  92.                 'disp_info_link' => array(
  93.                     'label' => T_( 'Help link' ),
  94.                     'type' => 'checkbox',
  95.                     'note' => T_( 'Check this to display "What is RSS?" link' ),
  96.                     'defaultvalue' => 1,
  97.                 ),
  98.                 'info_link' => array(
  99.                     'label' => T_( 'New Window' ),
  100.                     'type' => 'checkbox',
  101.                     'note' => T_( 'Check this to add target="_blank" to the "What is RSS?" link' ),
  102.                     'defaultvalue' => !$use_strict,
  103.                 ),
  104.             ), parent::get_param_definitions( $params )    );
  105.  
  106.         return $r;
  107.     }
  108.  
  109.  
  110.     function get_title()
  111.     {
  112.         global $rsc_url;
  113.  
  114.         $title = str_replace( '$icon$', '<img src="'.$rsc_url.'icons/feed-icon-16x16.gif" width="16" height="16" class="top" alt="" /> ', $this->disp_params['title']);
  115.         // fp> TODO: support for different icon sizes and backgrounds (at least black and white; mid grey would be cool also)
  116.  
  117.         return $title;
  118.     }
  119.  
  120.  
  121.     /**
  122.      * Display the widget!
  123.      *
  124.      * @param array MUST contain at least the basic display params
  125.      */
  126.     function display( $params )
  127.     {
  128.         global $Blog;
  129.  
  130.         $this->init_display( $params );
  131.  
  132.         // Available XML feeds:
  133.         echo $this->disp_params['block_start'];
  134.  
  135.         $this->disp_title( $this->get_title() );
  136.  
  137.         echo $this->disp_params['list_start'];
  138.  
  139.         $SkinCache = & get_SkinCache();
  140.         $SkinCache->load_by_type( 'feed' );
  141.  
  142.         // TODO: this is like touching private parts :>
  143.         foreach( $SkinCache->cache as $Skin )
  144.         {
  145.             if( $Skin->type != 'feed' )
  146.             {    // This skin cannot be used here...
  147.                 continue;
  148.             }
  149.  
  150.             echo $this->disp_params['item_start'];
  151.             echo $Skin->name.': ';
  152.             echo '<a href="'.$Blog->get_item_feed_url( $Skin->folder ).'">'.T_('Posts').'</a>';
  153.             if ( $Blog->allowcomments != 'never' )
  154.             {
  155.                 echo ', <a href="'.$Blog->get_comment_feed_url( $Skin->folder ).'">'.T_('Comments').'</a>';
  156.             }
  157.  
  158.             echo $this->disp_params['item_end'];
  159.         }
  160.  
  161.         echo $this->disp_params['list_end'];
  162.  
  163.  
  164.         // Display "info" link, if activated.
  165.         if( $this->disp_params['disp_info_link'] )
  166.         {
  167.             /**
  168.              * @var AbstractSettings
  169.              */
  170.             global $global_Cache;
  171.  
  172.             $feedhlp = $global_Cache->get( 'feedhlp' );
  173.             if( empty( $feedhlp ) )
  174.             {    // Use basic default: (fp> needs serious update) -- Note: no localization because destination is in English anyway.
  175.                 $feedhlp = array( array( 'http://webreference.fr/2006/08/30/rss_atom_xml', 'What is RSS?' ) );
  176.             }
  177.  
  178.             if( $this->disp_params[ 'info_link' ] )
  179.             {
  180.                 $link_params = array( 'target' => '_blank' );
  181.             }
  182.             else
  183.             {
  184.                 $link_params = array( 'target' => '' );
  185.             }
  186.             display_list( $feedhlp, $this->disp_params['notes_start'], $this->disp_params['notes_end'], ' ', '', '', NULL, 1, $link_params );
  187.         }
  188.  
  189.         echo $this->disp_params['block_end'];
  190.  
  191.         return true;
  192.     }
  193. }
  194.  
  195.  
  196. /*
  197.  * $Log: _coll_xml_feeds.widget.php,v $
  198.  * Revision 1.22  2010/02/08 17:54:48  efy-yury
  199.  * copyright 2009 -> 2010
  200.  *
  201.  * Revision 1.21  2009/09/26 12:00:44  tblue246
  202.  * Minor/coding style
  203.  *
  204.  * Revision 1.20  2009/09/25 07:33:31  efy-cantor
  205.  * replace get_cache to get_*cache
  206.  *
  207.  * Revision 1.19  2009/09/14 13:54:13  efy-arrin
  208.  * Included the ClassName in load_class() call with proper UpperCase
  209.  *
  210.  * Revision 1.18  2009/09/12 11:03:13  efy-arrin
  211.  * Included the ClassName in the loadclass() with proper UpperCase
  212.  *
  213.  * Revision 1.17  2009/06/12 13:24:09  waltercruz
  214.  * Don't show links for blog comments feed if the blog doesn't allow comments
  215.  *
  216.  * Revision 1.16  2009/03/14 19:22:30  fplanque
  217.  * minor
  218.  *
  219.  * Revision 1.15  2009/03/13 14:20:50  tblue246
  220.  * doc
  221.  *
  222.  * Revision 1.14  2009/03/13 02:32:07  fplanque
  223.  * Cleaned up widgets.
  224.  * Removed stupid widget_name param.
  225.  *
  226.  * Revision 1.13  2009/03/08 23:57:46  fplanque
  227.  * 2009
  228.  *
  229.  * Revision 1.12  2009/03/04 00:53:42  fplanque
  230.  * minor
  231.  *
  232.  * Revision 1.11  2009/02/27 19:51:35  blueyed
  233.  * XML feeds widget: add a 'disp_info_link' config option, defaulting to false. Since the help is very outdated, it makes no sense to eventually load the global_Cache just for that. Also makes the widget cleaner. Might default to true, when it provides more valuable info.
  234.  *
  235.  * Revision 1.10  2008/09/15 03:12:22  fplanque
  236.  * help link update
  237.  *
  238.  * Revision 1.9  2008/05/06 23:35:47  fplanque
  239.  * 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.
  240.  *
  241.  * Revision 1.7  2008/01/21 09:35:37  fplanque
  242.  * (c) 2008
  243.  *
  244.  * Revision 1.6  2007/12/23 16:16:18  fplanque
  245.  * Wording improvements
  246.  *
  247.  * Revision 1.5  2007/12/23 14:14:25  fplanque
  248.  * Enhanced widget name display
  249.  *
  250.  * Revision 1.4  2007/12/22 19:55:00  yabs
  251.  * cleanup from adding core params
  252.  *
  253.  * Revision 1.3  2007/11/28 17:50:24  fplanque
  254.  * normalization
  255.  *
  256.  * Revision 1.2  2007/11/27 10:02:04  yabs
  257.  * added params
  258.  *
  259.  * Revision 1.1  2007/06/25 11:02:23  fplanque
  260.  * MODULES (refactored MVC)
  261.  *
  262.  * Revision 1.2  2007/06/20 21:42:13  fplanque
  263.  * implemented working widget/plugin params
  264.  *
  265.  * Revision 1.1  2007/06/18 21:25:47  fplanque
  266.  * one class per core widget
  267.  *
  268.  */
  269. ?>
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:06:18 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).