Merge pull request #4871 from eileenmcnaughton/CRM-15795

[civicrm-core.git] / tests / phpunit / CRM / Group / Page / AjaxTest.php

diff --git a/tests/phpunit/CRM/Group/Page/AjaxTest.php b/tests/phpunit/CRM/Group/Page/AjaxTest.php
index 257afdec4dcfb492aa785d26ec9cedd7507dcd25..91348ff92bfed9ca00fdbd31a82efa2473fee3a7 100644 (file)
--- a/tests/phpunit/CRM/Group/Page/AjaxTest.php
+++ b/tests/phpunit/CRM/Group/Page/AjaxTest.php
@@ -21,18 +21,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
 
   protected $_params = array();
 
-  /**
-   * @return array
-   */
-  function get_info() {
-    return array(
-      'name' => 'Contact BAOs',
-      'description' => 'Test all Contact_BAO_Contact methods.',
-      'group' => 'CiviCRM BAO Tests',
-    );
-  }
-
-  function setUp() {
+  public function setUp() {
     parent::setUp();
     $this->_params = array(
       'sEcho' => '1',
@@ -51,7 +40,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->groupCreate(array('title' => 'not-me-active', 'is_active' => 1, 'name' => 'not-me-active'));
   }
 
-  function tearDown() {
+  public function tearDown() {
     CRM_Utils_Hook::singleton()->reset();
     $this->quickCleanup(array('civicrm_group'));
     $config = CRM_Core_Config::singleton();
@@ -62,7 +51,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * @param $permission
    */
-  function setPermissionAndRequest($permission) {
+  public function setPermissionAndRequest($permission) {
     CRM_Core_Config::singleton()->userPermissionClass->permissions = array($permission);
     CRM_Contact_BAO_Group::getPermissionClause(TRUE);
     global $_REQUEST;
@@ -73,7 +62,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
    * @param $permission
    * @param $hook
    */
-  function setHookAndRequest($permission, $hook) {
+  public function setHookAndRequest($permission, $hook) {
     CRM_Core_Config::singleton()->userPermissionClass->permissions = array($permission);
     $this->hookClass->setHook('civicrm_aclGroup', array($this, $hook));
     CRM_Contact_BAO_Group::getPermissionClause(TRUE);
@@ -81,9 +70,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $_REQUEST = $this->_params;
   }
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContacts() {
+  public function testGroupListViewAllContacts() {
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
     $this->assertEquals(2, $total);
@@ -92,11 +81,11 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts' permissioned user
+   * Retrieve groups as 'view all contacts' permissioned user
    * Without setting params the default is both enabled & disabled
    * (if you do set default it is enabled only)
    */
-  function testGroupListViewAllContactsFoundTitle() {
+  public function testGroupListViewAllContactsFoundTitle() {
     $this->_params['title'] = 'p';
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -106,18 +95,18 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsNotFoundTitle() {
+  public function testGroupListViewAllContactsNotFoundTitle() {
     $this->_params['title'] = 'z';
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
     $this->assertEquals(0, $total);
   }
   /**
-   * retrieve groups as 'edit all contacts'
+   * Retrieve groups as 'edit all contacts'
    */
-  function testGroupListEditAllContacts() {
+  public function testGroupListEditAllContacts() {
     $this->setPermissionAndRequest('edit all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
     $this->assertEquals(2, $total);
@@ -126,9 +115,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsEnabled() {
+  public function testGroupListViewAllContactsEnabled() {
     $this->_params['status'] = 1;
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -138,9 +127,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsDisabled() {
+  public function testGroupListViewAllContactsDisabled() {
     $this->_params['status'] = 2;
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -150,9 +139,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsDisabledNotFoundTitle() {
+  public function testGroupListViewAllContactsDisabledNotFoundTitle() {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'n';
     $this->setPermissionAndRequest('view all contacts');
@@ -162,9 +151,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsDisabledFoundTitle() {
+  public function testGroupListViewAllContactsDisabledFoundTitle() {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'p';
     $this->setPermissionAndRequest('view all contacts');
@@ -174,9 +163,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListViewAllContactsAll() {
+  public function testGroupListViewAllContactsAll() {
     $this->_params['status'] = 3;
     $this->setPermissionAndRequest('view all contacts');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -189,9 +178,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
 
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRM() {
+  public function testGroupListAccessCiviCRM() {
     $this->setPermissionAndRequest('access CiviCRM');
     $permissionClause = CRM_Contact_BAO_Group::getPermissionClause(TRUE);
     $this->assertEquals('1 = 0', $permissionClause);
@@ -200,9 +189,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
   }
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRMEnabled() {
+  public function testGroupListAccessCiviCRMEnabled() {
     $this->_params['status'] = 1;
     $this->setPermissionAndRequest('access CiviCRM');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -210,9 +199,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
   }
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRMDisabled() {
+  public function testGroupListAccessCiviCRMDisabled() {
     $this->_params['status'] = 2;
     $this->setPermissionAndRequest('access CiviCRM');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -221,9 +210,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRMAll() {
+  public function testGroupListAccessCiviCRMAll() {
     $this->_params['status'] = 2;
     $this->setPermissionAndRequest('access CiviCRM');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -232,9 +221,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRMFound() {
+  public function testGroupListAccessCiviCRMFound() {
     $this->_params['title'] = 'p';
     $this->setPermissionAndRequest('access CiviCRM');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -243,9 +232,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-   * retrieve groups as 'view all contacts'
+   * Retrieve groups as 'view all contacts'
    */
-  function testGroupListAccessCiviCRMNotFound() {
+  public function testGroupListAccessCiviCRMNotFound() {
     $this->_params['title'] = 'z';
     $this->setPermissionAndRequest('access CiviCRM');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -253,7 +242,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
   }
 
-  function testTraditionalACL () {
+  public function testTraditionalACL () {
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
     $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
@@ -261,7 +250,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals('pick-me-active', $groups[2]['group_name']);
   }
 
-  function testTraditionalACLNotFoundTitle () {
+  public function testTraditionalACLNotFoundTitle () {
     $this->_params['title'] = 'n';
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -269,7 +258,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals(0, $total, 'Total needs to be set correctly');
   }
 
-  function testTraditionalACLFoundTitle () {
+  public function testTraditionalACLFoundTitle () {
     $this->_params['title'] = 'p';
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -279,7 +268,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
   }
 
-  function testTraditionalACLDisabled () {
+  public function testTraditionalACLDisabled () {
     $this->_params['status'] = 2;
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -288,7 +277,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
   }
 
-  function testTraditionalACLDisabledFoundTitle () {
+  public function testTraditionalACLDisabledFoundTitle () {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'p';
     $this->setupACL();
@@ -298,7 +287,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
   }
 
-  function testTraditionalACLDisabledNotFoundTitle () {
+  public function testTraditionalACLDisabledNotFoundTitle () {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'n';
     $this->setupACL();
@@ -307,7 +296,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals(0, $total, 'Total needs to be set correctly');
   }
 
-  function testTraditionalACLEnabled () {
+  public function testTraditionalACLEnabled () {
     $this->_params['status'] = 1;
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -316,7 +305,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
     $this->assertEquals('pick-me-active', $groups[2]['group_name']);
   }
 
-  function testTraditionalACLAll () {
+  public function testTraditionalACLAll () {
     $this->_params['status'] = 3;
     $this->setupACL();
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -329,7 +318,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookDisabled() {
+  public function testGroupListAclGroupHookDisabled() {
     $this->_params['status'] = 2;
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -341,7 +330,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookDisabledFound() {
+  public function testGroupListAclGroupHookDisabledFound() {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'p';
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
@@ -354,7 +343,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookDisabledNotFound() {
+  public function testGroupListAclGroupHookDisabledNotFound() {
     $this->_params['status'] = 2;
     $this->_params['title'] = 'n';
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
@@ -367,7 +356,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHook() {
+  public function testGroupListAclGroupHook() {
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
     $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
@@ -378,7 +367,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookTitleNotFound() {
+  public function testGroupListAclGroupHookTitleNotFound() {
     $this->_params['title'] = 'n';
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -389,7 +378,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookTitleFound() {
+  public function testGroupListAclGroupHookTitleFound() {
     $this->_params['title'] = 'p';
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -402,7 +391,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookAll() {
+  public function testGroupListAclGroupHookAll() {
     $this->_params['status'] = 3;
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -415,7 +404,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   /**
    * ACL Group hook
    */
-  function testGroupListAclGroupHookEnabled() {
+  public function testGroupListAclGroupHookEnabled() {
     $this->_params['status'] = 1;
     $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
     list($groups, $total) = CRM_Group_Page_AJAX::getGroupList();
@@ -425,15 +414,15 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
   }
 
   /**
-  * Implements ACLGroup hook
-  * aclGroup function returns a list of permitted groups
-  * @param string $type
-  * @param integer $contactID
-  * @param string $tableName
-  * @param array $allGroups
-  * @param array $currentGroups
-  */
-  function hook_civicrm_aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
+   * Implements ACLGroup hook
+   * aclGroup function returns a list of permitted groups
+   * @param string $type
+   * @param int $contactID
+   * @param string $tableName
+   * @param array $allGroups
+   * @param array $currentGroups
+   */
+  public function hook_civicrm_aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
     //don't use api - you will get a loop
     $sql = " SELECT * FROM civicrm_group WHERE name LIKE '%pick%'";
     $groups = array();
@@ -442,7 +431,7 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
       $groups[] = $dao->id;
     }
 
-    if(!empty($allGroups)) {
+    if (!empty($allGroups)) {
       //all groups is empty if we really mean all groups but if a filter like 'is_disabled' is already applied
       // it is populated, ajax calls from Manage Groups will leave empty but calls from New Mailing pass in a filtered list
       $currentGroups = array_intersect($groups, array_flip($allGroups));