class FacetapiEmptyBehaviorText in Facet API 7.2

Empty behavior plugin that displays markup, usually just some text.

This plugin allows administrators to display markup filtered through text formats as the contents of a facet when it has no items.

Hierarchy

• class \FacetapiEmptyBehavior
  • class \FacetapiEmptyBehaviorText

1 string reference to 'FacetapiEmptyBehaviorText'

facetapi_facetapi_empty_behaviors in ./facetapi.facetapi.inc

Implements hook_facetapi_empty_behaviors().

File

plugins/facetapi/empty_behavior_text.inc, line 14

The empty_text empty behavior class.

class FacetapiEmptyBehaviorText extends FacetapiEmptyBehavior {

  /**
   * A boolean flagging whether the input format is set, FALSE means it is
   * being pulled from FacetapiEmptyBehavior::getDefaultSettings().
   *
   * @var bool
   */
  protected $formatSet = FALSE;

  /**
   * Overrides FacetapiEmptyBehavior::__construct().
   *
   * Checks if a format was selected, calls parent's constructor.
   */
  public function __construct(stdClass $settings) {
    if (isset($settings->settings['empty_text']['format'])) {
      $this->formatSet = TRUE;
    }
    parent::__construct($settings);
  }

  /**
   * Implements FacetapiEmptyBehavior::execute().
   */
  public function execute() {
    $format_id = $this->settings['empty_text']['format'];
    $text = $this
      ->translate('empty_text', $this->settings['empty_text']['value']);
    return array(
      '#markup' => check_markup($text, $format_id),
    );
  }

  /**
   * Overrides FacetapiEmptyBehavior::settingsForm().
   */
  public function settingsForm(&$form, &$form_state) {
    global $user;
    $format_id = $this->formatSet ? $this->settings['empty_text']['format'] : filter_default_format($user);
    $format = filter_format_load($format_id);

    // NOTE: There is a core bug with form #states and the text_format #type.
    // @see http://drupal.org/node/997826
    $form['widget']['empty']['empty_text'] = array(
      '#type' => 'text_format',
      '#access' => $format && filter_access($format, $user),
      '#title' => t('Empty text'),
      '#default_value' => $this->settings['empty_text']['value'],
      '#format' => $format_id,
      '#states' => array(
        'visible' => array(
          'select[name="empty_behavior"]' => array(
            'value' => 'text',
          ),
        ),
      ),
    );
  }

  /**
   * Overrides FacetapiEmptyBehavior::getDefaultSettings().
   */
  public function getDefaultSettings() {
    return array(
      'empty_text' => array(
        'value' => '',
        'format' => filter_fallback_format(),
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiEmptyBehavior::$configName	protected	property	The machine readable name of facet configuration.
FacetapiEmptyBehavior::$settings	protected	property	An array of facet settings.
FacetapiEmptyBehavior::translate	public	function	Helper function for translating strings.
FacetapiEmptyBehaviorText::$formatSet	protected	property	A boolean flagging whether the input format is set, FALSE means it is being pulled from FacetapiEmptyBehavior::getDefaultSettings().
FacetapiEmptyBehaviorText::execute	public	function	Implements FacetapiEmptyBehavior::execute(). Overrides FacetapiEmptyBehavior::execute
FacetapiEmptyBehaviorText::getDefaultSettings	public	function	Overrides FacetapiEmptyBehavior::getDefaultSettings(). Overrides FacetapiEmptyBehavior::getDefaultSettings
FacetapiEmptyBehaviorText::settingsForm	public	function	Overrides FacetapiEmptyBehavior::settingsForm(). Overrides FacetapiEmptyBehavior::settingsForm
FacetapiEmptyBehaviorText::__construct	public	function	Overrides FacetapiEmptyBehavior::__construct(). Overrides FacetapiEmptyBehavior::__construct