X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FExtension%2FMapper.php;h=fdf7c3c2ae7ad936ef2123c09202842d7a06dc87;hb=28d4d481c0554b45aa12155c7250db57c9c7a561;hp=e393d8ee7874ba49a2fe3fbd39c07d64b523e5a2;hpb=51daafaadd025703b2f8d6e3d27898e3768908f9;p=civicrm-core.git

diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php
index e393d8ee78..fdf7c3c2ae 100755
--- a/CRM/Extension/Mapper.php
+++ b/CRM/Extension/Mapper.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -51,7 +51,7 @@ class CRM_Extension_Mapper {
   /**
    * An URL for public extensions repository
    */
-  //CONST DEFAULT_EXTENSIONS_REPOSITORY = 'http://civicrm.org/extdir/ver={ver}|cms={uf}';
+  //const DEFAULT_EXTENSIONS_REPOSITORY = 'http://civicrm.org/extdir/ver={ver}|cms={uf}';
 
   /**
    * Extension info file name
@@ -102,19 +102,19 @@ class CRM_Extension_Mapper {
       $this->civicrmUrl = rtrim($config->resourceBase, '/');
     }
     if ($civicrmPath) {
-      $this->civicrmPath = rtrim($civicrmPath,'/');
+      $this->civicrmPath = rtrim($civicrmPath, '/');
     } else {
       global $civicrm_root;
-      $this->civicrmPath = rtrim($civicrm_root,'/');
+      $this->civicrmPath = rtrim($civicrm_root, '/');
     }
   }
 
   /**
    * Given the class, provides extension's key.
    *
-   * @access public
    *
-   * @param string $clazz extension class name
+   * @param string $clazz
+   *   Extension class name.
    *
    * @return string name of extension key
    */
@@ -125,12 +125,9 @@ class CRM_Extension_Mapper {
   /**
    * Given the class, provides extension path.
    *
-   * @access public
    *
    * @param $clazz
    *
-   * @internal param string $key extension key
-   *
    * @return string full path the extension .php file
    */
   public function classToPath($clazz) {
@@ -142,9 +139,9 @@ class CRM_Extension_Mapper {
   /**
    * Given the string, returns true or false if it's an extension key.
    *
-   * @access public
    *
-   * @param string $key a string which might be an extension key
+   * @param string $key
+   *   A string which might be an extension key.
    *
    * @return boolean true if given string is an extension name
    */
@@ -156,9 +153,9 @@ class CRM_Extension_Mapper {
   /**
    * Given the string, returns true or false if it's an extension class name.
    *
-   * @access public
    *
-   * @param string $clazz a string which might be an extension class name
+   * @param string $clazz
+   *   A string which might be an extension class name.
    *
    * @return boolean true if given string is an extension class name
    */
@@ -171,12 +168,13 @@ class CRM_Extension_Mapper {
   }
 
   /**
-   * @param string $key extension fully-qualified-name
+   * @param string $key
+   *   Extension fully-qualified-name.
    * @param bool $fresh
    *
    * @throws CRM_Extension_Exception
    * @throws Exception
-   * @return object CRM_Extension_Info
+   * @return CRM_Extension_Info
    */
   public function keyToInfo($key, $fresh = FALSE) {
     if ($fresh || !array_key_exists($key, $this->infos)) {
@@ -196,9 +194,9 @@ class CRM_Extension_Mapper {
   /**
    * Given the key, provides extension's class name.
    *
-   * @access public
    *
-   * @param string $key extension key
+   * @param string $key
+   *   Extension key.
    *
    * @return string name of extension's main class
    */
@@ -210,9 +208,9 @@ class CRM_Extension_Mapper {
    * Given the key, provides the path to file containing
    * extension's main class.
    *
-   * @access public
    *
-   * @param string $key extension key
+   * @param string $key
+   *   Extension key.
    *
    * @return string path to file containing extension's main class
    */
@@ -225,8 +223,8 @@ class CRM_Extension_Mapper {
    * Given the key, provides the path to file containing
    * extension's main class.
    *
-   * @access public
-   * @param string $key extension key
+   * @param string $key
+   *   Extension key.
    * @return string local path of the extension source tree
    */
   public function keyToBasePath($key) {
@@ -240,9 +238,9 @@ class CRM_Extension_Mapper {
    * Given the key, provides the path to file containing
    * extension's main class.
    *
-   * @access public
    *
-   * @param string $key extension key
+   * @param string $key
+   *   Extension key.
    *
    * @return string url for resources in this extension
    */
@@ -263,7 +261,8 @@ class CRM_Extension_Mapper {
   /**
    * Fetch the list of active extensions of type 'module'
    *
-   * @param $fresh bool whether to forcibly reload extensions list from canonical store
+   * @param $fresh
+   *   Bool whether to forcibly reload extensions list from canonical store.
    * @return array - array(array('prefix' => $, 'file' => $))
    */
   public function getActiveModuleFiles($fresh = FALSE) {
@@ -331,7 +330,7 @@ class CRM_Extension_Mapper {
   }
 
   /**
-   * @param $name
+   * @param string $name
    *
    * @return bool
    */
@@ -364,9 +363,9 @@ class CRM_Extension_Mapper {
   /**
    * Given the class, provides the template path.
    *
-   * @access public
    *
-   * @param string $clazz extension class name
+   * @param string $clazz
+   *   Extension class name.
    *
    * @return string path to extension's templates directory
    */
@@ -385,9 +384,9 @@ class CRM_Extension_Mapper {
    * Given te class, provides the template name.
    * @todo consider multiple templates, support for one template for now
    *
-   * @access public
    *
-   * @param string $clazz extension class name
+   * @param string $clazz
+   *   Extension class name.
    *
    * @return string extension's template name
    */