<?php
/**
* This file implements the item_title Widget class.
*
* This file is part of the evoCore framework - {@link http://evocore.net/}
* See also {@link http://sourceforge.net/projects/evocms/}.
*
* @copyright (c)2003-2020 by Francois Planque - {@link http://fplanque.com/}
*
* {@internal License choice
* - If you have received this file as part of a package, please find the license.txt file in
* the same folder or the closest folder above for complete license terms.
* - If you have received this file individually (e-g: from http://evocms.cvs.sourceforge.net/)
* then you must choose one of the following licenses before using the file:
* - GNU General Public License 2 (GPL) - http://www.opensource.org/licenses/gpl-license.php
* - Mozilla Public License 1.1 (MPL) - http://www.opensource.org/licenses/mozilla1.1.php
* }}
*
* @package evocore
*
* {@internal Below is a list of authors who have contributed to design/coding of this file: }}
* @author erhsatingin: Erwin Rommel Satingin.
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
load_class( 'widgets/model/_widget.class.php', 'ComponentWidget' );
/**
* ComponentWidget Class
*
* A ComponentWidget is a displayable entity that can be placed into a Container on a web page.
*
* @package evocore
*/
class item_title_Widget extends ComponentWidget
{
var $icon = 'header';
/**
* Constructor
*/
function __construct( $db_row = NULL )
{
// Call parent constructor:
parent::__construct( $db_row, 'core', 'item_title' );
}
/**
* Get help URL
*
* @return string URL
*/
function get_help_url()
{
return get_manual_url( 'item-title-widget' );
}
/**
* Get name of widget
*/
function get_name()
{
return T_('Title');
}
/**
* Get a very short desc. Used in the widget list.
*/
function get_short_desc()
{
return format_to_output( T_('Item Title') );
}
/**
* Get short description
*/
function get_desc()
{
return T_('Display the title of the item.');
}
/**
* Get definitions for editable params
*
* @see Plugin::GetDefaultSettings()
* @param local params like 'for_editing' => true
*/
function get_param_definitions( $params )
{
return array_merge( array(
'title' => array(
'label' => T_( 'Title' ),
'size' => 40,
'note' => T_( 'This is the title to display' ),
'defaultvalue' => '',
),
), parent::get_param_definitions( $params ) );
}
/**
* Display the widget!
*
* @param array MUST contain at least the basic display params
*/
function display( $params )
{
global $Item;
if( empty( $Item ) )
{ // Don't display this widget when there is no Item object:
$this->display_error_message( 'Widget "'.$this->get_name().'" is hidden because there is no Item.' );
return false;
}
$params = array_merge( array(
'widget_item_title_params' => array(),
'widget_item_title__edit_link_params' => array(),
), $params );
$this->init_display( $params );
// Parameters for item title:
$title_params = array_merge( array(
'before' => '',
'after' => '',
'link_type' => '#',
), $params['widget_item_title_params'] );
// Parameters for edit link:
$link_params = array_merge( array(
'edit_link_display' => false,
'before' => '<div class="'.button_class( 'group' ).'">',
'after' => '</div>',
'text' => $Item->is_intro() ? get_icon( 'edit' ).' '.T_('Edit Intro') : '#',
'class' => button_class( 'text' ),
), $params['widget_item_title__edit_link_params'] );
ob_start();
$Item->title( $title_params );
if( $link_params['edit_link_display'] )
{
$Item->edit_link( $link_params );
}
$item_title = ob_get_clean();
if( ! empty( $item_title ) )
{
echo $this->disp_params['block_start'];
$this->disp_title();
echo $this->disp_params['block_body_start'];
echo $item_title;
echo $this->disp_params['block_body_end'];
echo $this->disp_params['block_end'];
return true;
}
$this->display_debug_message();
return false;
}
/**
* Maybe be overriden by some widgets, depending on what THEY depend on..
*
* @return array of keys this widget depends on
*/
function get_cache_keys()
{
global $Collection, $Blog, $Item, $current_User;
return array(
'wi_ID' => $this->ID, // Have the widget settings changed ?
'set_coll_ID' => $Blog->ID, // Have the settings of the blog changed ? (ex: new skin)
'user_ID' => ( is_logged_in() ? $current_User->ID : 0 ), // Has the current User changed?
'item_ID' => ( empty( $Item->ID ) ? 0 : $Item->ID ), // Has the Item page changed?
);
}
}
?>