Merge branch '4.5' of https://github.com/civicrm/civicrm-core
[civicrm-core.git] / CRM / Core / Permission / Drupal6.php
index 3959a9db6a3c93a5a148b8f02bcdd0b51410e941..f23ca272ee2247fe2397facacea1aa537e1cd574 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -39,7 +39,7 @@
 class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase {
 
   /**
-   * is this user someone with access for the entire system
+   * Is this user someone with access for the entire system
    *
    * @var boolean
    */
@@ -47,14 +47,14 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase {
   protected $_editAdminUser = FALSE;
 
   /**
-   * am in in view permission or edit permission?
+   * Am in in view permission or edit permission?
    * @var boolean
    */
   protected $_viewPermission = FALSE;
   protected $_editPermission = FALSE;
 
   /**
-   * the current set of permissioned groups for the user
+   * The current set of permissioned groups for the user
    *
    * @var array
    */
@@ -62,10 +62,12 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase {
   protected $_editPermissionedGroups;
 
   /**
-   * given a permission string, check for access requirements
+   * Given a permission string, check for access requirements
    *
    * @param string $str the permission to check
    *
+   * @param int $contactID
+   *
    * @return boolean true if yes, else false
    * @access public
    */
@@ -194,6 +196,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase {
    * Get the permissions defined in the hook_civicrm_permission implementation
    * of the given module.
    *
+   * @param $module
+   *
    * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
    */
   static function getModulePermissions($module) {