X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FAction.php;h=857f593f558952308efffc03a7c983d86d782bd8;hb=695825992bea24f7d9cf88635518037eb32bd4b8;hp=f619f75e032bc2824f87c04b9aab84256ef530d4;hpb=b319421df58cfbeb99ca3016a8315b56690458ba;p=civicrm-core.git diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index f619f75e03..857f593f55 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -41,7 +41,7 @@ class CRM_Core_Action { * Different possible actions are defined here. Keep in sync with the * constant from CRM_Core_Form for various modes. * - * @var const + * @var integer const * * @access public */ @@ -72,11 +72,11 @@ class CRM_Core_Action { //make sure MAX_ACTION = 2^n - 1 ( n = total number of actions ) /** - * map the action names to the relevant constant. We perform + * Map the action names to the relevant constant. We perform * bit manipulation operations so we can perform multiple * actions on the same object if needed * - * @var array _names tupe of variable name to action constant + * @var array $_names type of variable name to action constant * * @access private * @static @@ -103,7 +103,7 @@ class CRM_Core_Action { ); /** - * the flipped version of the names array, initialized when used + * The flipped version of the names array, initialized when used * * @var array * @static @@ -111,15 +111,13 @@ class CRM_Core_Action { static $_description; /** + * Called by the request object to translate a string into a mask * - * called by the request object to translate a string into a mask - * - * @param string $action 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) { $action = 0; @@ -134,7 +132,7 @@ class CRM_Core_Action { * Given a string or an array of strings, determine the bitmask * for this set of actions * - * @param mixed 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 @@ -158,7 +156,7 @@ class CRM_Core_Action { /** * Given a string determine the bitmask for this specific string * - * @param string 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 @@ -174,7 +172,7 @@ class CRM_Core_Action { * * Given an action mask, find the corresponding description * - * @param int the action mask + * @param int $mask the action mask * * @return string the corresponding action description * @access public @@ -190,14 +188,18 @@ class CRM_Core_Action { } /** - * given a set of links and a mask, return the html action string for + * 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 $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 string $extraULName enclosed extra links in this UL. + * @param boolean $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 @@ -303,7 +305,7 @@ class CRM_Core_Action { } /** - * given a string and an array of values, substitute the real values + * 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 @@ -321,7 +323,7 @@ class CRM_Core_Action { } /** - * get the mask for a permission (view, edit or null) + * Get the mask for a permission (view, edit or null) * * @param string the permission *