class ThrobberManager in Ajax loader 7

@file Class ThrobberManager

Hierarchy

• class \ThrobberManager

File

lib/ThrobberManager.php, line 8

Class ThrobberManager

class ThrobberManager {

  /**
   * Returns all valid throbbers definied by other modules through hook_ajax_throbber().
   * @param array $throbbers
   * @return array
   */
  public static function processUserDefinedThrobbers($throbbers = array()) {
    if (!$throbbers) {
      $throbbers = module_invoke_all('ajax_throbber');
    }
    $valid_throbbers = array();
    foreach ($throbbers as $options) {
      if (isset($options['class'])) {

        // Validate the throbber.
        if ($valid_throbber = self::isValidThrobber($options['class'])) {
          array_push($valid_throbbers, $valid_throbber);
        }
      }
    }
    return $valid_throbbers;
  }

  /**
   * Validates throbber object.
   * @param $class_name
   * @return bool
   */
  public static function isValidThrobber($class_name) {
    $throbber = FALSE;
    if (class_exists($class_name)) {
      $throbber = new $class_name();
    }
    if (!$throbber instanceof ThrobberInterface) {

      // throbber has to be instance of ThrobberInterface.
      $throbber = FALSE;
    }
    elseif (empty($throbber
      ->getLabel()) || empty($throbber
      ->getCssFile()) || empty($throbber
      ->getMarkup())) {

      // Properties have to be filled out.
      $throbber = FALSE;
    }
    return $throbber;
  }

  /**
   * Checks if throbber has to be loaded on current page.
   */
  public static function isApplicable($settings) {
    $is_applicable = FALSE;
    $is_admin_path = path_is_admin(current_path());
    if (!$is_admin_path) {
      $is_applicable = TRUE;
    }
    elseif ($settings['show_admin_paths'] && current_path() != 'admin/config/user-interface/ajax-loader') {
      $is_applicable = TRUE;
    }
    return $is_applicable;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ThrobberManager::isApplicable	public static	function	Checks if throbber has to be loaded on current page.
ThrobberManager::isValidThrobber	public static	function	Validates throbber object.
ThrobberManager::processUserDefinedThrobbers	public static	function	Returns all valid throbbers definied by other modules through hook_ajax_throbber().