class Sweaver in Sweaver 7

@file Class Sweaver.

Hierarchy

• class \Sweaver

5 string references to 'Sweaver'

sweaverAdministration::getInfo in tests/sweaver.admin.test

Implementation of getInfo().

sweaverEditor::getInfo in tests/sweaver.editor.test

Implementation of getInfo().

sweaverThemeSettings::getInfo in tests/sweaver.themesettings.test

Implementation of getInfo().

sweaver_plugin_editor::sweaver_menu in plugins/sweaver_plugin_editor/sweaver_plugin_editor.inc

Menu registry.

sweaver_plugin_toolbar::sweaver_menu in plugins/sweaver_plugin_toolbar/sweaver_plugin_toolbar.inc

Menu registry.

File

./sweaver.inc, line 7

Class Sweaver.

class Sweaver {
  private static $instance;
  private $style = NULL;
  private $theme = NULL;
  private $plugins = array();
  private $configured = FALSE;
  private $plugins_registry = array();
  private $plugins_registry_enabled = array();

  /**
   * Constructor.
   * Private constructor to make sure this is never
   * instantiated by the constructor.
   */
  private function __construct() {
    if ($theme_key = sweaver_session(NULL, 'sweaver_theme')) {
      $this
        ->set_current_style($theme_key);
    }
    else {
      $this
        ->set_current_style(variable_get('theme_default', 'garland'));
    }
    if (!$this
      ->is_configured()) {
      $this
        ->register_plugins_configuration();
    }
  }

  /**
   * GetInstance
   * Static method to always return the same object Sweaver.
   * There can only be one Sweaver.
   */
  public static final function get_instance() {
    if (!isset(self::$instance)) {
      self::$instance = new Sweaver();
    }
    return self::$instance;
  }

  /**
   * register_plugins_configuration.
   * Registers an array of plugin configuration data to Sweaver.
   */
  public function register_plugins_configuration() {

    // Load the required plugins of ctools and the sweaver base class.
    ctools_include('plugins');

    // Check if the configuration was cached or not.
    if ($plugins_cache = cache_get('sweaver_plugins')) {
      $this->plugins_registry = $plugins_cache->data['sweaver_plugins'];
      $this->plugins_registry_enabled = $plugins_cache->data['sweaver_plugins_enabled'];
    }
    else {
      $this->plugins_registry = ctools_get_plugins('sweaver', 'plugins');

      // Build enabled plugins.
      foreach ($this->plugins_registry as $key => $plugin) {
        $this->plugins_registry[$key]['enabled'] = 0;
        if (variable_get('sweaver_plugin_status_' . $key, FALSE)) {
          $this->plugins_registry[$key]['enabled'] = 1;
          $this->plugins_registry_enabled[$key] = $this->plugins_registry[$key];
        }
      }

      // Cache the plugins ourselves too.
      $sweaver_plugins['sweaver_plugins'] = $this->plugins_registry;
      $sweaver_plugins['sweaver_plugins_enabled'] = $this->plugins_registry_enabled;
      cache_set('sweaver_plugins', $sweaver_plugins);
    }
    $this->configured = TRUE;
  }

  /**
   * Get the sweaver plugins configurations.
   */
  public function get_plugins_registry($enabled = TRUE) {
    return $enabled ? $this->plugins_registry_enabled : $this->plugins_registry;
  }

  /**
   * is_configured.
   * Tells us if Sweaver is configured.
   */
  public function is_configured() {
    return $this->configured;
  }

  /**
   * add_plugin.
   * Adds a sweaver plugin to the stash.
   */
  private function add_plugin(Sweaver_plugin $plugin) {
    $this->plugins[] = $plugin;
  }

  /**
   * is_plugin_activated
   * Check if a plugin is activated
   * @return true if activated
   */
  public function is_plugin_activated($name) {
    if ($this->plugins[$name]) {
      return isset($this->plugins_registry_enabled[$name]);
    }
    return FALSE;
  }

  /**
   * get_plugin.
   * Gets a sweaver plugin, and instantiates it if not loaded yet.
   */
  public function get_plugin($name, $enabled = TRUE) {
    if (!isset($this->plugins_registry[$name])) {
      drupal_set_message(t('No configuration found for @name in the plugin registry', array(
        '@name' => $name,
      )));
    }
    if (!isset($this->plugins[$name])) {
      module_load_include('inc', 'sweaver', 'sweaver_plugin');
      $check = $enabled ? isset($this->plugins_registry_enabled[$name]) : TRUE;
      if ($check && ($class = ctools_plugin_get_class($this->plugins_registry[$name], 'handler'))) {

        // Check that class exists until CTools & registry issues are resolved.
        if (class_exists($class)) {
          $this->plugins[$name] = new $class($this->plugins_registry[$name]);
        }
      }
      else {
        $this->plugins[$name] = FALSE;
      }
    }
    return $this->plugins[$name];
  }

  /**
   * Sets the current style.
   * @param $theme_key
   *   Optional, if missing the global one will be used.
   */
  public function set_current_style($theme_key) {
    $this->theme = $theme_key;
  }

  /**
   * Return a style for a theme.
   *
   * @param $theme
   *   The machine name of the theme.
   * @param $reset
   *   Whether to reset the current $css variable or not.
   * @return $css
   *   The css definition for this theme.
   */
  public function get_current_style($reset = FALSE) {
    $run =& drupal_static('run', FALSE);
    $css =& drupal_static('css', FALSE);
    if (!$run || $reset) {
      $run = TRUE;
      if (sweaver_session(NULL, 'sweaver_temp')) {
        ctools_include('object-cache');
        $css = ctools_object_cache_get('sweaver-styling', 'sweaver-styling');
        if (!isset($css->style_id)) {
          $css = new stdClass();
        }
        $css->type = 'draft';
      }
      elseif (sweaver_session(NULL, 'draft_mode')) {
        $table = sweaver_session(NULL, 'loaded_table') == 'live' ? 'sweaver_style' : 'sweaver_style_draft';
        $css = db_query("SELECT * FROM {" . $table . "} where style_id = :style_id", array(
          ':style_id' => sweaver_session(NULL, 'loaded_style'),
        ))
          ->fetchObject();
        if (!isset($css->style_id)) {
          $css = new stdClass();
        }
        $css->type = 'draft';
      }
      else {
        $css = db_query("SELECT * FROM {sweaver_style} where theme = :theme and active = 1", array(
          ':theme' => $this->theme,
        ))
          ->fetchObject();
        if (!isset($css->style_id)) {
          $css = new stdClass();
        }
        $css->type = 'live';
      }

      // We check if the style can be loaded on this page
      if (isset($css->pages)) {
        $path = drupal_strtolower(drupal_get_path_alias($_GET['q']));
        $css->pages = drupal_strtolower($css->pages);
        $page_match = drupal_match_path($path, $css->pages);
        if ($path != $_GET['q']) {
          $page_match = $page_match || drupal_match_path($_GET['q'], $css->pages);
        }
        $page_match = !($css->visibility xor $page_match);
        if (!$page_match) {
          $css = NULL;
        }
      }
      if (!isset($css->style_id)) {
        $css = NULL;
      }
    }
    $this->style = $css;
    return $css;
  }

  /**
   * Return all styles that affect the current page except the one active
   */
  public function get_secondary_styles() {
    $path = drupal_strtolower(drupal_get_path_alias($_GET['q']));
    $styles_to_load = array();
    $styles = db_query("SELECT style_id, visibility, pages FROM {sweaver_style} where theme = :theme and active = 2", array(
      ':theme' => $this->theme,
    ));
    while ($style = $styles
      ->fetchObject()) {
      $style->pages = drupal_strtolower($style->pages);
      $page_match = drupal_match_path($path, $style->pages);
      if ($path != $_GET['q']) {
        $page_match = $page_match || drupal_match_path($_GET['q'], $style->pages);
      }
      $page_match = !($style->visibility xor $page_match);
      if ($page_match) {
        $styles_to_load[] = $style->style_id;
      }
    }
    if (!empty($styles_to_load)) {
      $list = implode(', ', $styles_to_load);
      $styles = db_query("SELECT style_id, css FROM {sweaver_style} where style_id IN (:list)", array(
        ':list' => $list,
      ));
      $styles_to_return = array();
      while ($style = $styles
        ->fetchObject()) {
        $style->type = 'live';
        $styles_to_return[] = $style;
      }
      return $styles_to_return;
    }
    else {
      return array();
    }
  }

  /**
   * Returns the currently known theme_key.
   */
  public function get_theme_key() {
    return $this->theme;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Sweaver::$configured	private	property
Sweaver::$instance	private static	property
Sweaver::$plugins	private	property
Sweaver::$plugins_registry	private	property
Sweaver::$plugins_registry_enabled	private	property
Sweaver::$style	private	property
Sweaver::$theme	private	property
Sweaver::add_plugin	private	function	add_plugin. Adds a sweaver plugin to the stash.
Sweaver::get_current_style	public	function	Return a style for a theme.
Sweaver::get_instance	final public static	function	GetInstance Static method to always return the same object Sweaver. There can only be one Sweaver.
Sweaver::get_plugin	public	function	get_plugin. Gets a sweaver plugin, and instantiates it if not loaded yet.
Sweaver::get_plugins_registry	public	function	Get the sweaver plugins configurations.
Sweaver::get_secondary_styles	public	function	Return all styles that affect the current page except the one active
Sweaver::get_theme_key	public	function	Returns the currently known theme_key.
Sweaver::is_configured	public	function	is_configured. Tells us if Sweaver is configured.
Sweaver::is_plugin_activated	public	function	is_plugin_activated Check if a plugin is activated
Sweaver::register_plugins_configuration	public	function	register_plugins_configuration. Registers an array of plugin configuration data to Sweaver.
Sweaver::set_current_style	public	function	Sets the current style.
Sweaver::__construct	private	function	Constructor. Private constructor to make sure this is never instantiated by the constructor.