CRM-15735 fix - Update payment status for pay-later membership renewal ignores Receiv...
[civicrm-core.git] / CRM / Core / Region.php
index 9b0384ea5ae367ba165d9a48efecf97b4b0b5dea..9db08aa172b053e9a270f583456854fc064dec43 100644 (file)
@@ -15,7 +15,7 @@ class CRM_Core_Region {
    * @return CRM_Core_Region
    */
   public static function &instance($name, $autocreate = TRUE) {
-    if ( $autocreate && ! isset( self::$_instances[$name] ) ) {
+    if ($autocreate && !isset(self::$_instances[$name])) {
       self::$_instances[$name] = new CRM_Core_Region($name);
     }
     return self::$_instances[$name];
@@ -48,7 +48,7 @@ class CRM_Core_Region {
   public function __construct($name) {
     // Templates injected into regions should normally be file names, but sometimes inline notation is handy.
     require_once 'CRM/Core/Smarty/resources/String.php';
-    civicrm_smarty_register_string_resource( );
+    civicrm_smarty_register_string_resource();
 
     $this->_name = $name;
     $this->_snippets = array();
@@ -84,7 +84,7 @@ class CRM_Core_Region {
    * Note: This function does not perform any extra encoding of markup, script code, or etc. If
    * you're passing in user-data, you must clean it yourself.
    *
-   * @param $snippet
+   * @param array $snippet
    *   Array; keys:.
    *   - type: string (auto-detected for markup, template, callback, script, scriptUrl, jquery, style, styleUrl)
    *   - name: string, optional
@@ -122,7 +122,7 @@ class CRM_Core_Region {
     if (!isset($snippet['name'])) {
       $snippet['name'] = count($this->_snippets);
     }
-    $this->_snippets[ $snippet['name'] ] = $snippet;
+    $this->_snippets[$snippet['name']] = $snippet;
     $this->_isSorted = FALSE;
     return $snippet;
   }
@@ -173,25 +173,29 @@ class CRM_Core_Region {
       if ($snippet['disabled']) {
         continue;
       }
-      switch($snippet['type']) {
+      switch ($snippet['type']) {
         case 'markup':
           $html .= $snippet['markup'];
           break;
+
         case 'template':
           $tmp = $smarty->get_template_vars('snippet');
           $smarty->assign('snippet', $snippet);
           $html .= $smarty->fetch($snippet['template']);
           $smarty->assign('snippet', $tmp);
           break;
+
         case 'callback':
           $args = isset($snippet['arguments']) ? $snippet['arguments'] : array(&$snippet, &$html);
           $html .= call_user_func_array($snippet['callback'], $args);
           break;
+
         case 'scriptUrl':
           if (!$allowCmsOverride || !$cms->addScriptUrl($snippet['scriptUrl'], $this->_name)) {
             $html .= sprintf("<script type=\"text/javascript\" src=\"%s\">\n</script>\n", $snippet['scriptUrl']);
           }
           break;
+
         case 'jquery':
           $snippet['script'] = sprintf("CRM.\$(function(\$) {\n%s\n});", $snippet['jquery']);
           // no break - continue processing as script
@@ -200,20 +204,23 @@ class CRM_Core_Region {
             $html .= sprintf("<script type=\"text/javascript\">\n%s\n</script>\n", $snippet['script']);
           }
           break;
+
         case 'styleUrl':
           if (!$allowCmsOverride || !$cms->addStyleUrl($snippet['styleUrl'], $this->_name)) {
             $html .= sprintf("<link href=\"%s\" rel=\"stylesheet\" type=\"text/css\"/>\n", $snippet['styleUrl']);
           }
           break;
+
         case 'style':
           if (!$allowCmsOverride || !$cms->addStyle($snippet['style'], $this->_name)) {
             $html .= sprintf("<style type=\"text/css\">\n%s\n</style>\n", $snippet['style']);
           }
           break;
+
         default:
           require_once 'CRM/Core/Error.php';
-          CRM_Core_Error::fatal( ts( 'Snippet type %1 is unrecognized',
-                     array( 1 => $snippet['type'] ) ) );
+          CRM_Core_Error::fatal(ts('Snippet type %1 is unrecognized',
+            array(1 => $snippet['type'])));
       }
     }
     return $html;
@@ -226,11 +233,19 @@ class CRM_Core_Region {
    * @return int
    */
   public static function _cmpSnippet($a, $b) {
-    if ($a['weight'] < $b['weight']) return -1;
-    if ($a['weight'] > $b['weight']) return 1;
+    if ($a['weight'] < $b['weight']) {
+      return -1;
+    }
+    if ($a['weight'] > $b['weight']) {
+      return 1;
+    }
     // fallback to name sort; don't really want to do this, but it makes results more stable
-    if ($a['name'] < $b['name']) return -1;
-    if ($a['name'] > $b['name']) return 1;
+    if ($a['name'] < $b['name']) {
+      return -1;
+    }
+    if ($a['name'] > $b['name']) {
+      return 1;
+    }
     return 0;
   }
 
@@ -240,14 +255,14 @@ class CRM_Core_Region {
    * @param string $markup
    *   HTML.
    *
-  public function addMarkup($markup) {
-    return $this->add(array(
-      'type' => 'markup',
-      'markup' => $markup,
-    ));
-  }
-
-  /**
+   * public function addMarkup($markup) {
+   * return $this->add(array(
+   * 'type' => 'markup',
+   * 'markup' => $markup,
+   * ));
+   * }
+   *
+   * /**
    * Add a Smarty template file to a region
    *
    * Note: File is not evaluated until the page is rendered
@@ -255,26 +270,27 @@ class CRM_Core_Region {
    * @param string $template
    *   Path to the Smarty template file.
    *
-  public function addTemplate($template) {
-    return $this->add(array(
-      'type' => 'template',
-      'template' => $template,
-    ));
-  }
-
-  /**
+   * public function addTemplate($template) {
+   * return $this->add(array(
+   * 'type' => 'template',
+   * 'template' => $template,
+   * ));
+   * }
+   *
+   * /**
    * Use a callback function to extend a region
    *
    * @param mixed $callback
    * @param array $arguments
    *   Optional, array of parameters for callback; if omitted, the default arguments are ($snippetSpec, $html).
    *
-  public function addCallback($callback, $arguments = FALSE) {
-    return $this->add(array(
-      'type' => 'callback',
-      'callback' => $callback,
-      'arguments' => $arguments,
-    ));
-  }
-  */
+   * public function addCallback($callback, $arguments = FALSE) {
+   * return $this->add(array(
+   * 'type' => 'callback',
+   * 'callback' => $callback,
+   * 'arguments' => $arguments,
+   * ));
+   * }
+   */
+
 }