egroupware/home/inc/class.home_portlet.inc.php

129 lines
3.7 KiB
PHP
Raw Normal View History

<?php
/**
* EGroupware - Home - Portlet interface
*
* @link www.egroupware.org
* @author Nathan Gray
* @copyright (c) 2013 by Nathan Gray
* @package home
* @subpackage portlet
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
2016-04-28 20:06:46 +02:00
use EGroupware\Api\Etemplate;
abstract class home_portlet
{
/**
* Attributes that are common to all portlets, but are customized indirectly
* through the UI, rather than explictly through the configure popup
*/
public static $common_attributes = array(
'width', 'height', 'row', 'col'
);
/**
* Constructor sets up the portlet according to the user's saved property values
* for this particular portlet. It is possible to have multiple instances of the
* same portlet with different properties.
*
* The implementing class is allowed to modify the context, if needed, but it is
* better to use get_properties().
*
* @param context Array portlet settings such as size, as well as values for properties
2014-11-06 22:40:03 +01:00
* @param boolean $need_reload Flag to indicate that the portlet needs to be reloaded (exec will be called)
*/
2014-11-06 22:40:03 +01:00
public abstract function __construct(Array &$context = array(), &$need_reload = false);
2016-04-28 20:06:46 +02:00
/**
* Some descriptive information about the portlet, so that users can decide if
* they want it or not, and for inclusion in lists, hover text, etc.
*
* These should be already translated, no further translation will be done.
*
* @return Array with keys:
* - displayName: Used in lists
* - title: Put in the portlet header
* - description: A short description of what this portlet does or displays
*/
public abstract function get_description();
/**
2014-11-06 22:40:03 +01:00
* Generate the display for the portlet
*
* @param id String unique ID, provided to the portlet so it can make sure content is
* unique, if needed.
2016-04-28 20:06:46 +02:00
* @param Etemplate $etemplate eTemplate to generate content
*/
2016-04-28 20:06:46 +02:00
public abstract function exec($id = null, Etemplate &$etemplate = null);
/**
* Return a list of settings to customize the portlet.
*
* Settings should be in the same style as for preferences. It is OK to return an empty array
* for no customizable settings.
*
* These should be already translated, no further translation will be done.
*
* @see preferences/inc/class.preferences_settings.inc.php
* @return Array of settings. Each setting should have the following keys:
* - name: Internal reference
* - type: Widget type for editing
* - label: Human name
* - help: Description of the setting, and what it does
* - default: Default value, for when it's not set yet
*/
public function get_properties()
{
// Include the common attributes, or they won't get saved
$properties = array();
foreach(self::$common_attributes as $prop)
{
$properties[$prop] = array('name' => $prop);
}
2014-11-06 22:40:03 +01:00
$properties[] = array(
'name' => 'color',
'type' => 'colorpicker',
'label' => lang('Color'),
);
return $properties;
}
/**
* Return a list of allowable actions for the portlet.
*
* These actions will be merged with the default portlet actions. Use the
* same id / key to override the default action.
*/
public abstract function get_actions();
2016-04-28 20:06:46 +02:00
/**
* If this portlet can accept, display, or otherwise handle multiple
* EgroupWare entries. Used for drag and drop processing. How the entries
* are handled are up to the portlet.
*/
public function accept_multiple()
{
return false;
}
/**
* If this portlet can be created by dropping, these are the drop types
* that are accepted
*
* @return boolean|String[]
*/
public function accept_drop()
{
// In general, no
return false;
}
public function __toString()
{
return get_called_class() . ' Context:' . array2string($this->context);
}
}