class boxes_i18n in Boxes translation 6

Simple translatable custom text box.

Hierarchy

• class \boxes_box
  • class \boxes_simple
    • class \boxes_i18n

1 string reference to 'boxes_i18n'

i18n_boxes_boxes_plugins in ./i18n_boxes.module

Implementation of hook_boxes_plugins().

File

plugins/boxes/boxes_i18n.inc, line 6

class boxes_i18n extends boxes_simple {

  /**
   * Implementation of boxes_content::options_defaults().
   */
  public function options_defaults() {
    $defaults = parent::options_defaults();
    return $defaults + array(
      'i18n_boxes' => array(
        'language' => I18N_BOXES_LOCALIZE,
      ),
    );
  }

  /**
   * Implementation of boxes_content::options_form().
   */
  public function options_form() {
    $form = parent::options_form();
    $form['i18n_boxes'] = array(
      '#type' => 'fieldset',
      '#title' => t('Multilingual settings'),
      '#collapsible' => TRUE,
      '#weight' => 0,
      '#tree' => TRUE,
    );
    $options = array(
      '' => t('All languages'),
    );
    $options[I18N_BOXES_LOCALIZE] = t('All languages (Translatable)');
    $options += locale_language_list('name');
    $form['i18n_boxes']['language'] = array(
      '#type' => 'radios',
      '#title' => t('Language'),
      '#default_value' => $this->options['i18n_boxes']['language'],
      '#options' => $options,
    );
    return $form;
  }

  /**
   * Save a box.
   */
  public function save() {
    parent::save();

    // Make the box strings available to be translated.
    $this
      ->locale_refresh();
  }

  /**
   * Refresh the translatable strings.
   */
  public function locale_refresh() {
    $title = '';
    $content = '';
    if ($this->options['i18n_boxes']['language'] == I18N_BOXES_LOCALIZE) {
      $content = $this->options['body'];
      $title = $this->title;
    }

    // Update or delete the i18nstrings record for the body.
    i18nstrings_update("boxes:{$this->plugin_key}:{$this->delta}:body", $content, $this->options['format']);

    // Update or delete the title, too.
    i18nstrings_update("boxes:{$this->plugin_key}:{$this->delta}:title", $title);
  }

  /**
   * Implementation of boxes_content::render().
   */
  public function render() {
    global $language;

    // Get the filtered rendered data from boxes_simple.
    $block = parent::render();

    // Handle any multilingual settings.
    if (!empty($this->options['i18n_boxes']['language'])) {
      if ($this->options['i18n_boxes']['language'] == I18N_BOXES_LOCALIZE) {

        // This box is available to translate.
        $block['content'] = i18nstrings_text("boxes:{$this->plugin_key}:{$this->delta}:body", $block['content']);

        // Also translate the title.
        $block['subject'] = i18nstrings("boxes:{$this->plugin_key}:{$this->delta}:title", $block['subject']);
        $block['title'] = $block['subject'];
      }
      elseif ($this->options['i18n_boxes']['language'] != $language->language) {

        // This box does not share the language of the user, so do not display.
        $block = NULL;
      }
    }
    return $block;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::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::__construct	protected	function	Create a new box.
boxes_i18n::locale_refresh	public	function	Refresh the translatable strings.
boxes_i18n::options_defaults	public	function	Implementation of boxes_content::options_defaults(). Overrides boxes_simple::options_defaults
boxes_i18n::options_form	public	function	Implementation of boxes_content::options_form(). Overrides boxes_simple::options_form
boxes_i18n::render	public	function	Implementation of boxes_content::render(). Overrides boxes_simple::render
boxes_i18n::save	public	function	Save a box. Overrides boxes_box::save