X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FAction.php;h=068744b2a83fa1bd826a4bd2d783258ccd733895;hb=dc195289d598fae6feedab517c4ababcdb840541;hp=857f593f558952308efffc03a7c983d86d782bd8;hpb=55039e98512c204e7919bd586b9e99ab176e51ea;p=civicrm-core.git

diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php
index 857f593f55..068744b2a8 100644
--- a/CRM/Core/Action.php
+++ b/CRM/Core/Action.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -43,9 +43,8 @@ class CRM_Core_Action {
    *
    * @var integer const
    *
-   * @access public
    */
-  CONST
+  const
     NONE = 0,
     ADD = 1,
     UPDATE = 2,
@@ -65,8 +64,8 @@ class CRM_Core_Action {
     RENEW = 32768,
     DETACH = 65536,
     REVERT = 131072,
-    CLOSE        =  262144,
-    REOPEN       =  524288,
+    CLOSE        = 262144,
+    REOPEN       = 524288,
     MAX_ACTION   = 1048575;
 
   //make sure MAX_ACTION = 2^n - 1 ( n = total number of actions )
@@ -78,7 +77,6 @@ class CRM_Core_Action {
    *
    * @var array $_names  type of variable name to action constant
    *
-   * @access private
    * @static
    *
    */
@@ -113,13 +111,13 @@ class CRM_Core_Action {
   /**
    * Called by the request object to translate a string into a mask
    *
-   * @param string $str the action to be resolved
+   * @param string $str
+   *   The action to be resolved.
    *
    * @return int the action mask corresponding to the input string
-   * @access public
    * @static
    */
-  static function resolve($str) {
+  public static function resolve($str) {
     $action = 0;
     if ($str) {
       $items = explode('|', $str);
@@ -132,14 +130,14 @@ class CRM_Core_Action {
    * Given a string or an array of strings, determine the bitmask
    * for this set of actions
    *
-   * @param mixed $item either a single string or an array of strings
+   * @param mixed $item
+   *   Either a single string or an array of strings.
    *
    * @return int the action mask corresponding to the input args
-   * @access public
    * @static
    *
    */
-  static function map($item) {
+  public static function map($item) {
     $mask = 0;
 
     if (is_array($item)) {
@@ -156,14 +154,14 @@ class CRM_Core_Action {
   /**
    * Given a string determine the bitmask for this specific string
    *
-   * @param string $item the input action to process
+   * @param string $item
+   *   The input action to process.
    *
    * @return int the action mask corresponding to the input string
-   * @access public
    * @static
    *
    */
-  static function mapItem($item) {
+  public static function mapItem($item) {
     $mask = CRM_Utils_Array::value(trim($item), self::$_names);
     return $mask ? $mask : 0;
   }
@@ -172,14 +170,14 @@ class CRM_Core_Action {
    *
    * Given an action mask, find the corresponding description
    *
-   * @param int $mask the action mask
+   * @param int $mask
+   *   The action mask.
    *
    * @return string the corresponding action description
-   * @access public
    * @static
    *
    */
-  static function description($mask) {
+  public static function description($mask) {
     if (!isset($_description)) {
       self::$_description = array_flip(self::$_names);
     }
@@ -191,21 +189,26 @@ class CRM_Core_Action {
    * Given a set of links and a mask, return the html action string for
    * the links associated with the mask
    *
-   * @param array $links the set of link items
-   * @param int $mask the mask to be used. a null mask means all items
-   * @param array $values the array of values for parameter substitution in the link items
-   * @param string $extraULName enclosed extra links in this UL.
-   * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL.
+   * @param array $links
+   *   The set of link items.
+   * @param int $mask
+   *   The mask to be used. a null mask means all items.
+   * @param array $values
+   *   The array of values for parameter substitution in the link items.
+   * @param string $extraULName
+   *   Enclosed extra links in this UL.
+   * @param bool $enclosedAllInSingleUL
+   *   Force to enclosed all links in single UL.
    *
    * @param null $op
    * @param null $objectName
    * @param int $objectId
    *
    * @return string       the html string
-   * @access public
    * @static
    */
-  static function formLink($links,
+  static function formLink(
+    $links,
     $mask,
     $values,
     $extraULName = 'more',
@@ -275,7 +278,6 @@ class CRM_Core_Action {
       }
     }
 
-
     $mainLinks = $url;
     if ($enclosedAllInSingleUL) {
       $allLinks = '';
@@ -308,14 +310,15 @@ class CRM_Core_Action {
    * Given a string and an array of values, substitute the real values
    * in the placeholder in the str in the CiviCRM format
    *
-   * @param string $str    the string to be replaced
-   * @param array  $values the array of values for parameter substitution in the str
+   * @param string $str
+   *   The string to be replaced.
+   * @param array $values
+   *   The array of values for parameter substitution in the str.
    *
    * @return string        the substituted string
-   * @access public
    * @static
    */
-  static function &replace(&$str, &$values) {
+  public static function &replace(&$str, &$values) {
     foreach ($values as $n => $v) {
       $str = str_replace("%%$n%%", $v, $str);
     }
@@ -329,9 +332,8 @@ class CRM_Core_Action {
    *
    * @return int   the mask for the above permission
    * @static
-   * @access public
    */
-  static function mask($permissions) {
+  public static function mask($permissions) {
     $mask = NULL;
     if (!is_array($permissions) || CRM_Utils_System::isNull($permissions)) {
       return $mask;
@@ -352,4 +354,3 @@ class CRM_Core_Action {
     return $mask;
   }
 }
-