class LanguageHierarchyI18nVariableLanguageRealm in Language Hierarchy 7

Controller for Language realms, with support for language heirarchy.

Hierarchy

• class \I18nVariableLanguageRealm extends \VariableRealmDefaultController
  • class \LanguageHierarchyI18nVariableLanguageRealm

1 string reference to 'LanguageHierarchyI18nVariableLanguageRealm'

i18n_variable_hierarchy_variable_realm_info in modules/i18n_variable_hierarchy/i18n_variable_hierarchy.module

Implements hook_variable_realm_info().

File

modules/i18n_variable_hierarchy/includes/i18n_variable_hierarchy.class.inc, line 10

Variable Realm controller.

class LanguageHierarchyI18nVariableLanguageRealm extends I18nVariableLanguageRealm {

  /**
   * Get a reference to the parent realm's store.
   */
  protected function getParentRealmStore($realm_key) {

    // If we have a parent language, then get those variables and merge them in.
    if ($parent_key = language_hierarchy_get_parent($realm_key)) {
      if ($parent_controller = $this
        ->getParentKeyVariableRealmController($parent_key->language)) {
        return $parent_controller
          ->getStore($parent_key->language);
      }
    }
    else {
      return NULL;
    }
  }

  /**
   * Create the store for this realm, passing in the parent store.
   */
  protected function createStore($realm_key, $variables = NULL) {
    $store = parent::createStore($realm_key, $variables);
    $store
      ->setParentStore($this
      ->getParentRealmStore($realm_key));
    return $store;
  }
  protected $parentKeyRealmController = array();

  /**
   * Get the realm controller belonging to the given key.
   *
   * Note that this result is stored in a instance variable, so it it not
   * safe to call this method with different $key parameters.
   *
   * @param $key
   *   The key of our parent in the language realm.
   *
   * @return VariableRealmControllerInterface
   *   The variable realm controller for the given parent key.
   */
  protected function getParentKeyVariableRealmController($key) {
    if (!isset($this->parentKeyRealmController[$key])) {
      $info = variable_realm_info($this->realm_name);
      $class = !empty($info['controller class']) ? $info['controller class'] : 'VariableRealmDefaultController';
      if ($this->parentKeyRealmController[$key] = class_exists($class) ? new $class($this->realm_name) : FALSE) {
        $this->parentKeyRealmController[$key]
          ->enable($key);
      }
    }
    return $this->parentKeyRealmController[$key];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
I18nVariableLanguageRealm::getAllKeys	public	function	Implementation of VariableRealmControllerInterface::getAllKeys().
I18nVariableLanguageRealm::getAvailableVariables	public	function	Implementation of VariableRealmControllerInterface::getAvailableVariables().
I18nVariableLanguageRealm::getDefaultKey	public	function	Implementation of VariableRealmControllerInterface::getDefaultKey().
I18nVariableLanguageRealm::getRequestKey	public	function	Implementation of VariableRealmControllerInterface::getRequestKey().
LanguageHierarchyI18nVariableLanguageRealm::$parentKeyRealmController	protected	property
LanguageHierarchyI18nVariableLanguageRealm::createStore	protected	function	Create the store for this realm, passing in the parent store.
LanguageHierarchyI18nVariableLanguageRealm::getParentKeyVariableRealmController	protected	function	Get the realm controller belonging to the given key.
LanguageHierarchyI18nVariableLanguageRealm::getParentRealmStore	protected	function	Get a reference to the parent realm's store.