CRM/Core/Permission/UnitTests.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  */
  39 class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base {
  40
  41   /**
  42    * permission mapping to stub check() calls
  43    * @var array
  44    */
  45   public $permissions = NULL;
  46
  47   /**
  48    * Given a permission string, check for access requirements
  49    *
  50    * @param string $str
  51    *   The permission to check.
  52    * @param int $userId
  53    *
  54    * @return bool
  55    *   true if yes, else false
  56    */
  57   public function check($str, $userId = NULL) {
  58     if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
  59       return FALSE;
  60     }
  61     if ($str == CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  62       return TRUE;
  63     }
  64
  65     // return the stubbed permission (defaulting to true if the array is missing)
  66     return is_array($this->permissions) ? in_array($str, $this->permissions) : TRUE;
  67   }
  68
  69   /**
  70    * Get the permissioned where clause for the user.
  71    *
  72    * @param int $type
  73    *   The type of permission needed.
  74    * @param array $tables
  75    *   (reference ) add the tables that are needed for the select clause.
  76    * @param array $whereTables
  77    *   (reference ) add the tables that are needed for the where clause.
  78    *
  79    * @return string
  80    *   the group where clause for this user
  81    */
  82   public function whereClause($type, &$tables, &$whereTables) {
  83     return '( 1 )';
  84   }
  85
  86 }