~quam-plures-core/quam-plures/qp5_colls-blogs_chaps-cats

<?php

/**

 * This file implements the "Comment list" widget

 *

 * @author {@link http://wonderwinds.com/ Ed Bennett}

 * @author {@link http://astonishme.co.uk/ Yabba (Paul Jones, rest in peace)}

 * @author {@link http://fplanque.net/ Francois PLANQUE}

 * @copyright (c) 2009 by {@link http://quamplures.net/ the Quam Plures project}

 * @license http://www.gnu.org/licenses/gpl.txt GNU General Public License v3

 * @package widgets

 */

if(!defined('QP_MAIN_INIT')) die('fail');

 

/**

 * comment_list_Widget class

 * @package widgets

 */

class comment_list_Widget extends ComponentWidget

{

        /**

         * Constructor

         */

        function comment_list_Widget( $db_row = NULL )

        {

                // Call parent constructor

                parent::ComponentWidget( $db_row, 'widget', 'comment_list' );

                $this->widget_name = T_('Comment List');

                $this->widget_title = T_('Recent comments');

        }

 

 

        /**

         * Get widget's short description

         */

        function get_desc()

        {

                return T_('List of comments; click goes to comment.');

        }

 

 

        /**

         * Get widget's title

         * @todo (3069): rename this to get_title()

         */

        function get_short_desc()

        {

                return format_to_output( $this->disp_params['widget_title'] );

        }

 

 

        /**

         * Get definitions for editable params

         * @see Plugin::GetDefaultSettings()

         * @param local params like 'for_editing' => true

         */

        function get_param_definitions( $params )

        {

                $r = array_merge( array(

                        'disp_order' => array(

                                'label' => T_('Order'),

                                'type' => 'select',

                                'options' => array( 'DESC' => T_('Newest to oldest'), 'ASC' => T_('Oldest to newest'), 'RAND' => T_('Random selection') ),

                                'defaultvalue' => 'DESC',

                                'note' => T_('Order to display items'),

                        ),

                        'limit' => array(

                                'label' => T_('Max items'),

                                'defaultvalue' => 20,

                                'size' => 4,

                                'note' => T_('Maximum number of items to display.'),

                        ),

                        'author_links' => array(

                                'label' => T_('Link to author'),

                                'type' => 'checkbox',

                                'defaultvalue' => true,

                                'note' => T_('Link the author to their url'),

                        ),

                        'hover_text' => array(

                                'label' => T_('Hover text'),

                                'type' => 'text',

                                'defaultvalue' => T_('Read the full comment'),

                                'size' => 40,

                                'note' => T_('Text to show when hovering over the link'),

                        ),

                        'blog_ID' => array(

                                'label' => T_('Blog'),

                                'size' => 4,

                                'note' => T_('ID of the blog to use, leave empty for the current blog.'),

                        ),

                ), parent::get_param_definitions( $params ) );

                return $r;

        }

 

 

        /**

         * Display the widget!

         * @param array must contain at least the basic display params

         */

        function display( $params )

        {

                global $Blog;

 

                $this->init_display( $params );

 

                $blogCache = get_Cache( 'BlogCache' );

                $listBlog = ( $this->disp_params['blog_ID'] ? $blogCache->get_by_ID( $this->disp_params['blog_ID'] ) : $Blog );

 

                // Create ItemList

                // Note: we pass a widget specific prefix in order to make sure to never interfere with the mainlist

                $limit = $this->disp_params['limit'];

                $order = $this->disp_params['disp_order'];

                $CommentList = new CommentList( $listBlog, "'comment','trackback'", array( 'published' ), '', '', $order, '', $limit );

 

                echo $this->disp_params['block_start'];

                $this->disp_title();

                echo $this->disp_params['list_start'];

 

                // Loop through comments

                while( $Comment = & $CommentList->get_next() )

                {

                        // Load comment's Item object:

                        $Comment->get_Item();

                        echo $this->disp_params['item_start'];

                        // display comment author's name

                        $Comment->author( array(

                                'after_visitor' => ' ',

                                'after_user' => ' ',

                                'make_link' => $this->disp_params['author_links'],

                        ) );

                        echo T_('on').' ';

                        // display a permalink link to the comment

                        $Comment->permanent_link( array(

                                        'text' => $Comment->Item->title,

                                        'title' => $this->disp_params['hover_text'],

                                ) );

                        echo $this->disp_params['item_end'];

                } // End of comment loop

                echo $this->disp_params['list_end'];

                echo $this->disp_params['block_end'];

 

                return true;

        }

}

 

?>