X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FResources.php;h=97f03f5d84f55f4e6177ca435a73bf84890a964f;hb=dc195289d598fae6feedab517c4ababcdb840541;hp=af9c6932fbeb505d5bff8f184365445bf505312e;hpb=d366b2d70ea6c3e387faa6a1f777eeb0c6844834;p=civicrm-core.git

diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php
index af9c6932fb..97f03f5d84 100644
--- a/CRM/Core/Resources.php
+++ b/CRM/Core/Resources.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -102,7 +102,8 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -127,8 +128,10 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -149,10 +152,14 @@ class CRM_Core_Resources {
   /**
    * 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
@@ -174,9 +181,11 @@ class 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) {
@@ -193,9 +202,12 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -220,7 +232,8 @@ class CRM_Core_Resources {
    *
    * @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
    */
@@ -236,7 +249,7 @@ class 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) {
@@ -245,9 +258,9 @@ class CRM_Core_Resources {
       $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;
@@ -318,7 +331,7 @@ class CRM_Core_Resources {
    * 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:
@@ -338,7 +351,7 @@ class CRM_Core_Resources {
    * 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) {
@@ -356,10 +369,14 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -369,9 +386,11 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -388,9 +407,12 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -407,8 +429,10 @@ class CRM_Core_Resources {
   /**
    * 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
    */
@@ -424,8 +448,10 @@ class CRM_Core_Resources {
   /**
    * 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
@@ -479,7 +505,6 @@ class CRM_Core_Resources {
    *
    * @param string $region
    * @return CRM_Core_Resources
-   * @access public
    */
   public function addCoreResources($region = 'html-header') {
     if (!isset($this->addedCoreResources[$region]) && !self::isAjaxMode()) {
@@ -503,7 +528,8 @@ class CRM_Core_Resources {
       $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,
       ));
@@ -558,8 +584,10 @@ class CRM_Core_Resources {
   /**
    * 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) {
@@ -573,7 +601,8 @@ class CRM_Core_Resources {
       $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);
@@ -586,7 +615,7 @@ class CRM_Core_Resources {
    *
    * @return string javascript content
    */
-  static function outputLocalizationJS() {
+  public static function outputLocalizationJS() {
     CRM_Core_Page_AJAX::setJsHeaders();
     $config = CRM_Core_Config::singleton();
     $vars = array(
@@ -689,7 +718,7 @@ class CRM_Core_Resources {
   /**
    * @return bool - is this page request an ajax snippet?
    */
-  static function isAjaxMode() {
+  public static function isAjaxMode() {
     return in_array(CRM_Utils_Array::value('snippet', $_REQUEST), array(CRM_Core_Smarty::PRINT_SNIPPET, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON));
   }
 
@@ -699,12 +728,15 @@ class CRM_Core_Resources {
    * @TODO: Provide a sane way to extend this list for other entities - a hook or??
    * @return array
    */
-  static function getEntityRefFilters() {
+  public static function getEntityRefFilters() {
     $filters = array();
 
     $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')),
@@ -717,9 +749,8 @@ class CRM_Core_Resources {
       array('key' => 'status_id', 'value' => ts('Activity Status')),
     );
 
-    $contactTypes = CRM_Utils_Array::makeNonAssociative(CRM_Contact_BAO_ContactType::getSelectElements(FALSE, TRUE, '.'));
     $filters['contact'] = array(
-      array('key' => 'contact_type', 'value' => ts('Contact Type'), 'options' => $contactTypes),
+      array('key' => 'contact_type', 'value' => ts('Contact Type')),
       array('key' => 'group', 'value' => ts('Group'), 'entity' => 'group_contact'),
       array('key' => 'tag', 'value' => ts('Tag'), 'entity' => 'entity_tag'),
       array('key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'address'),