boxes_simple | boxes_simple.inc | CIS 7

cis7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple
cle7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple
elmsmedia7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple
icor7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple
meedjum_blog7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple
mooc7 sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc boxes_simple

Simple custom text box.

Hierarchy

class boxes_simple

Expanded class hierarchy of boxes_simple

Members

Name	Modifiers	Type	Description
boxes_box::$boxes	static	property
boxes_box::$delta	public	property
boxes_box::$description	public	property
boxes_box::$export_type	public	property
boxes_box::$new	public	property
boxes_box::$options	public	property
boxes_box::$plugin_key	public	property
boxes_box::$title	public	property
boxes_box::cache_setting	public	function	Returns the block cache settings for this box. Subclasses can override this to perform more intricate operations around deciding the cache settings of the specific box instance.
boxes_box::delete	public	function	Delete a box.
boxes_box::factory	public static	function	Instantiate, populate and return a box object.
boxes_box::load	public static	function	Load existing box by its unique identifier $delta.
boxes_box::reset	public static	function	Reset the boxes cache.
boxes_box::save	public	function	Save a box.
boxes_box::use_multistep_create	public	function	Declare if the box should use a multistep form for the create form.
boxes_box::__construct	protected	function	Create a new box.
boxes_simple::options_defaults	public	function	Implementation of boxes_box::options_defaults(). Overrides boxes_box::options_defaults
boxes_simple::options_form	public	function	Implementation of boxes_box::options_form(). Overrides boxes_box::options_form
boxes_simple::render	public	function	Implementation of boxes_box::render(). Overrides boxes_box::render

File

sites/all/modules/ulmus/boxes/plugins/boxes_simple.inc, line 6

View source

class boxes_simple extends boxes_box {
  /**
   * Implementation of boxes_box::options_defaults().
   */
  public function options_defaults() {
    return array(
      'body' => array(
        'value' => '',
        'format' => filter_default_format(),
      ),
    );
  }

  /**
   * Implementation of boxes_box::options_form().
   */
  public function options_form(&$form_state) {
    $format = filter_format_load($this->options['body']['format']);

    if (filter_access($format)) {
      $form = array();
      $form['body'] = array(
        '#type' => 'text_format',
        '#base_type' => 'textarea',
        '#title' => t('Box body'),
        '#default_value' => $this->options['body']['value'],
        '#rows' => 6,
        '#format' => $this->options['body']['format'] ? $this->options['body']['format'] : NULL,
        '#description' => t('The content of the block as shown to the user.'),
      );
      return $form;
    }
  }

  /**
   * Implementation of boxes_box::render().
   */
  public function render() {
    $content = '';
    if (!empty($this->options['body']['value']) && isset($this->options['body']['format'])) {
      $content = check_markup($this->options['body']['value'], $this->options['body']['format'], $langcode = '' /* TODO Set this variable. */, FALSE);
    }
    $title = isset($this->title) ? $this->title : NULL;
    return array(
      'delta' => $this->delta, // Crucial.
      'title' => $title,
      'subject' => check_plain($title),
      'content' => $content,
    );
  }
}

1 string reference to 'boxes_simple'

boxes_boxes_plugins in sites/all/modules/ulmus/boxes/boxes.module: Implements hook_boxes_plugins().