X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FRegion.php;h=7868cee23813384dcd91f33f40ccb39a2d88c6d8;hb=94e6918c3f16db13cfcb8261ad846a80e9604eb3;hp=417b1ecaa1e5d3fde86df153c2242fa553c1b7b9;hpb=6f2500ee7589360102875df4367568fe87485df6;p=civicrm-core.git diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index 417b1ecaa1..7868cee238 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -7,7 +7,7 @@ class CRM_Core_Region { static private $_instances = NULL; /** - * Obtain the content for a given region + * Obtain the content for a given region. * * @param string $name * @param bool $autocreate @@ -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]; @@ -64,7 +64,7 @@ class CRM_Core_Region { } /** - * Add a snippet of content to a region + * Add a snippet of content to a region. * * @code * CRM_Core_Region::instance('page-header')->add(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 @@ -146,7 +146,7 @@ class CRM_Core_Region { } /** - * Render all the snippets in a region + * Render all the snippets in a region. * * @param string $default * HTML, the initial content of the region. @@ -220,7 +220,7 @@ class CRM_Core_Region { default: require_once 'CRM/Core/Error.php'; CRM_Core_Error::fatal(ts('Snippet type %1 is unrecognized', - array(1 => $snippet['type']))); + array(1 => $snippet['type']))); } } return $html; @@ -250,46 +250,47 @@ class CRM_Core_Region { } /** - * Add block of static HTML to a region + * Add block of static HTML to a region. * * @param string $markup * HTML. * - public function addMarkup($markup) { - return $this->add(array( - 'type' => 'markup', - 'markup' => $markup, - )); - } - - /** - * Add a Smarty template file to a region + * 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 * * @param string $template * Path to the Smarty template file. * - public function addTemplate($template) { - return $this->add(array( - 'type' => 'template', - 'template' => $template, - )); - } - - /** - * Use a callback function to extend a region + * 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, + * )); + * } + */ + }