interface BeanTypePluginInterface in Bean (for Drupal 7) 7
Interface for Plugin Classes
Hierarchy
- interface \BeanTypePluginInterface
Expanded class hierarchy of BeanTypePluginInterface
All classes that implement BeanTypePluginInterface
1 string reference to 'BeanTypePluginInterface'
- bean_check_plugin_class in ./
bean.module - Check the plugin type class
File
- includes/
bean.core.inc, line 11 - Bean classes and plugin interface
View source
interface BeanTypePluginInterface {
/**
* Constructor
*
* Plugin info should be called using bean_fetch_plugin_info().
*
* @abstract
*
* @param $plugin_info array of information from the ctools plugin.
*/
public function __construct($plugin_info);
/**
* Get the ctools plugin info.
*
* If you pass in a key, then the key from the plugin info will be returned
* otherwise the entire plugin will be returned
*
* @abstract
*
* @param $key
* @return array of plugin info for value froma key
*/
public function getInfo($key = NULL);
/**
* Build the URL string for the plugin
*
* @abstract
*
* @return url
*/
public function buildURL();
/**
* Get the label name of the plugin
*
* @abstract
*
* @return label of the type
*/
public function getLabel();
/**
* Get the description of the plugin
*
* @abstract
*
* @return
* description of the type
*/
public function getDescription();
/**
* Set the Bean object for later use
*
* @abstract
*
* @param Bean $bean
*/
public function setBean($bean);
/**
* Is this type editable?
*
* @abstract
*
* @return boolean
*/
public function isEditable();
/**
* Define the form values and their defaults
*/
public function values();
/**
* The Plugin Form
*
* The Bean object will be either loaded from the database or filled with the defaults.
*
* @param $bean
* @param $form
* @param $form_state
* @return array
* form array
*/
public function form($bean, $form, &$form_state);
/**
* Validate function for bean type form
*
* @abstract
*
* @param $values
* @param $form_state
*/
public function validate($values, &$form_state);
/**
* React to a bean being saved
*
* @abstract
*
* @param Bean $bean
*/
public function submit(Bean $bean);
/**
* Return the block content.
*
* @abstract
*
* @param $bean
* The bean object being viewed.
* @param $content
* The default content array created by Entity API. This will include any
* fields attached to the entity.
* @param string $view_mode
* The view mode passed into $entity->view().
*
* @param null $langcode
*
* @return
* Return a renderable content array.
*/
public function view($bean, $content, $view_mode = 'default', $langcode = NULL);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BeanTypePluginInterface:: |
public | function | Build the URL string for the plugin | 1 |
BeanTypePluginInterface:: |
public | function | The Plugin Form | 1 |
BeanTypePluginInterface:: |
public | function | Get the description of the plugin | 1 |
BeanTypePluginInterface:: |
public | function | Get the ctools plugin info. | 1 |
BeanTypePluginInterface:: |
public | function | Get the label name of the plugin | 1 |
BeanTypePluginInterface:: |
public | function | Is this type editable? | 1 |
BeanTypePluginInterface:: |
public | function | Set the Bean object for later use | 1 |
BeanTypePluginInterface:: |
public | function | React to a bean being saved | 1 |
BeanTypePluginInterface:: |
public | function | Validate function for bean type form | 1 |
BeanTypePluginInterface:: |
public | function | Define the form values and their defaults | 1 |
BeanTypePluginInterface:: |
public | function | Return the block content. | 1 |
BeanTypePluginInterface:: |
public | function | Constructor | 1 |