| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
/**
* Get the current permission of this user
*
- * @return string the permission of the user (edit or view or null)
+ * @return string
+ * the permission of the user (edit or view or null)
*/
public static function getPermission() {
$config = CRM_Core_Config::singleton();
/**
* Given a permission string or array, check for access requirements
- * @param mixed $permissions the permission to check as an array or string -see examples
- * arrays
+ * @param mixed $permissions
+ * The permission to check as an array or string -see examples.
+ * arrays
*
* Ex 1
*
* array('access CiviEvent', 'access CiviContribute')
* ),
*
- * @return boolean true if yes, else false
- * @static
+ * @return bool
+ * true if yes, else false
*/
public static function check($permissions) {
$permissions = (array) $permissions;
foreach ($permissions as $permission) {
- if(is_array($permission)) {
+ if (is_array($permission)) {
foreach ($permission as $orPerm) {
- if(self::check($orPerm)) {
+ if (self::check($orPerm)) {
//one of our 'or' permissions has succeeded - stop checking this permission
return TRUE;;
}
return FALSE;
}
else {
- if(!CRM_Core_Config::singleton()->userPermissionClass->check($permission)) {
+ if (!CRM_Core_Config::singleton()->userPermissionClass->check($permission)) {
//one of our 'and' conditions has not been met
return FALSE;
}
/**
* Given a group/role array, check for access requirements
*
- * @param array $array the group/role to check
+ * @param array $array
+ * The group/role to check.
*
- * @return boolean true if yes, else false
- * @static
+ * @return bool
+ * true if yes, else false
*/
public static function checkGroupRole($array) {
$config = CRM_Core_Config::singleton();
/**
* Get the permissioned where clause for the user
*
- * @param int $type the type of permission needed
- * @param array $tables (reference ) add the tables that are needed for the select clause
- * @param array $whereTables (reference ) add the tables that are needed for the where clause
+ * @param int $type
+ * The type of permission needed.
+ * @param array $tables
+ * (reference ) add the tables that are needed for the select clause.
+ * @param array $whereTables
+ * (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
$config = CRM_Core_Config::singleton();
* Get all groups from database, filtered by permissions
* for this user
*
- * @param string $groupType type of group(Access/Mailing)
- * @param bool|\boolen $excludeHidden exclude hidden groups.
+ * @param string $groupType
+ * Type of group(Access/Mailing).
+ * @param bool $excludeHidden
+ * exclude hidden groups.
*
- * @static
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public static function group($groupType, $excludeHidden = TRUE) {
$config = CRM_Core_Config::singleton();
* @return array|null
*/
public static function event($type = CRM_Core_Permission::VIEW, $eventID = NULL, $context = '') {
- if(!empty($context)) {
- if(CRM_Core_Permission::check($context)) {
+ if (!empty($context)) {
+ if (CRM_Core_Permission::check($context)) {
return TRUE;
}
}
/**
* Check permissions for delete and edit actions
*
- * @param string $module component name.
- * @param integer $action action to be check across component
+ * @param string $module
+ * Component name.
+ * @param int $action
+ * Action to be check across component.
*
*
* @return bool
static $permissions = array();
if (empty($permissions)) {
$permissions = array(
- 'administer CiviCRM'
+ 'administer CiviCRM',
);
$components = CRM_Core_Component::getComponents();
foreach ($components as $comp) {
'export own manual batches' => $prefix . ts('export own manual batches'),
'export all manual batches' => $prefix . ts('export all manual batches'),
'administer payment processors' => $prefix . ts('administer payment processors'),
+ 'edit message templates' => $prefix . ts('edit message templates'),
);
return $permissions;
* Validate user permission across
* edit or view or with supportable acls.
*
- * return boolean true/false.
- **/
+ * @return bool
+ */
public static function giveMeAllACLs() {
if (CRM_Core_Permission::check('view all contacts') ||
CRM_Core_Permission::check('edit all contacts')
*
* @param string $permission
*
- * return string $componentName the name of component.
- *
- * @return int|null|string
- * @static
+ * @return null|string
+ * the name of component.
*/
public static function getComponentName($permission) {
$componentName = NULL;
/**
* Get all the contact emails for users that have a specific permission
*
- * @param string $permissionName name of the permission we are interested in
+ * @param string $permissionName
+ * Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public static function permissionEmails($permissionName) {
$config = CRM_Core_Config::singleton();
/**
* Get all the contact emails for users that have a specific role
*
- * @param string $roleName name of the role we are interested in
+ * @param string $roleName
+ * Name of the role we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public static function roleEmails($roleName) {
$config = CRM_Core_Config::singleton();
'is_enabled'
) ? TRUE : FALSE;
}
+
}
projects / civicrm-core.git / blobdiff