/**
* Get or set the single instance of CRM_Core_Resources
*
- * @param $instance CRM_Core_Resources, new copy of the manager
+ * @param CRM_Core_Resources $instance
+ * New copy of the manager.
* @return CRM_Core_Resources
*/
static public function singleton(CRM_Core_Resources $instance = NULL) {
/**
* Construct a resource manager
*
- * @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs.
- * @param CRM_Utils_Cache_Interface $cache JS-localization cache
+ * @param CRM_Extension_Mapper $extMapper
+ * Map extension names to their base path or URLs.
+ * @param CRM_Utils_Cache_Interface $cache
+ * JS-localization cache.
* @param string|null $cacheCodeKey Random code to append to resource URLs; changing the code forces clients to reload resources
*/
public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $ext string, extension name; use 'civicrm' for core
- * @param $file string, file path -- relative to the extension base dir
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @param $translate, whether to parse this file for strings enclosed in ts()
*
* @return CRM_Core_Resources
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $url string
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $url
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addScriptUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a JavaScript file to the current page using <SCRIPT SRC>.
*
- * @param $code string, JavaScript source code
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $code
+ * JavaScript source code.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addScript($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
*
* @see http://wiki.civicrm.org/confluence/display/CRMDOC/Javascript+Reference
*
- * @param string $nameSpace - usually the name of your extension
+ * @param string $nameSpace
+ * Usually the name of your extension.
* @param array $vars
* @return CRM_Core_Resources
*/
* This function is usually reserved for low-level system use.
* Extensions and components should generally use addVars instead.
*
- * @param $settings array
+ * @param array $settings
* @return CRM_Core_Resources
*/
public function addSetting($settings) {
$region = self::isAjaxMode() ? 'ajax-snippet' : 'html-header';
$resources = $this;
CRM_Core_Region::instance($region)->add(array(
- 'callback' => function(&$snippet, &$html) use ($resources) {
- $html .= "\n" . $resources->renderSetting();
- },
+ 'callback' => function(&$snippet, &$html) use ($resources) {
+ $html .= "\n" . $resources->renderSetting();
+ },
'weight' => -100000,
));
$this->addedSettings = TRUE;
* Variable substitutions can happen from client-side
*
* Note: this function rarely needs to be called directly and is mostly for internal use.
- * @see CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
+ * See CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files
*
* Simple example:
* // From php:
* CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs)))));
* And from javascript access it at CRM.myNamespace.myString
*
- * @param $text string|array
+ * @param string|array $text
* @return CRM_Core_Resources
*/
public function addString($text) {
/**
* Add a CSS file to the current page using <LINK HREF>.
*
- * @param $ext string, extension name; use 'civicrm' for core
- * @param $file string, file path -- relative to the extension base dir
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyleFile($ext, $file, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a CSS file to the current page using <LINK HREF>.
*
- * @param $url string
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $url
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyleUrl($url, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Add a CSS content to the current page using <STYLE>.
*
- * @param $code string, CSS source code
- * @param $weight int, relative weight within a given region
- * @param $region string, location within the file; 'html-header', 'page-header', 'page-footer'
+ * @param string $code
+ * CSS source code.
+ * @param int $weight
+ * relative weight within a given region.
+ * @param string $region
+ * location within the file; 'html-header', 'page-header', 'page-footer'.
* @return CRM_Core_Resources
*/
public function addStyle($code, $weight = self::DEFAULT_WEIGHT, $region = self::DEFAULT_REGION) {
/**
* Determine file path of a resource provided by an extension
*
- * @param $ext string, extension name; use 'civicrm' for core
- * @param $file string, file path -- relative to the extension base dir
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
*
* @return bool|string (string|bool), full file path or FALSE if not found
*/
/**
* Determine public URL of a resource provided by an extension
*
- * @param $ext string, extension name; use 'civicrm' for core
- * @param $file string, file path -- relative to the extension base dir
+ * @param string $ext
+ * extension name; use 'civicrm' for core.
+ * @param string $file
+ * file path -- relative to the extension base dir.
* @param bool $addCacheCode
*
* @return string, URL
$this->addScriptUrl(CRM_Utils_System::url('civicrm/ajax/l10n-js/' . $config->lcMessages, array('r' => $this->getCacheCode())), $jsWeight++, $region);
// Add global settings
- $settings = array('config' => array(
+ $settings = array(
+ 'config' => array(
'ajaxPopupsEnabled' => $this->ajaxPopupsEnabled,
'isFrontend' => $config->userFrameworkFrontend,
));
/**
* Translate strings in a javascript file
*
- * @param $ext string, extension name
- * @param $file string, file path
+ * @param string $ext
+ * extension name.
+ * @param string $file
+ * file path.
* @return void
*/
private function translateScript($ext, $file) {
$filePath = $this->getPath($ext, $file);
if ($filePath && is_readable($filePath)) {
$stringsByFile[$file] = CRM_Utils_JS::parseStrings(file_get_contents($filePath));
- } else {
+ }
+ else {
$stringsByFile[$file] = array();
}
$this->cache->set($ext, $stringsByFile);
$filters['event'] = array(
array('key' => 'event_type_id', 'value' => ts('Event Type')),
- array('key' => 'start_date', 'value' => ts('Start Date'), 'options' => array(
+ array(
+ 'key' => 'start_date',
+ 'value' => ts('Start Date'),
+ 'options' => array(
array('key' => '{">":"now"}', 'value' => ts('Upcoming')),
array('key' => '{"BETWEEN":["now - 3 month","now"]}', 'value' => ts('Past 3 Months')),
array('key' => '{"BETWEEN":["now - 6 month","now"]}', 'value' => ts('Past 6 Months')),
projects / civicrm-core.git / blobdiff