static private $_instances = NULL;
/**
- * Obtain the content for a given region
+ * Obtain the content for a given region.
*
* @param string $name
* @param bool $autocreate
* @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];
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();
}
/**
- * 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(
* 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
}
/**
- * Render all the snippets in a region
+ * Render all the snippets in a region.
*
* @param string $default
* HTML, the initial content of the region.
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;
}
/**
- * 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,
+ * ));
+ * }
+ */
+
}