CRM-17645 - More consistent function naming
authorColeman Watts <coleman@civicrm.org>
Fri, 15 Jan 2016 01:33:52 +0000 (20:33 -0500)
committerColeman Watts <coleman@civicrm.org>
Fri, 15 Jan 2016 04:57:00 +0000 (23:57 -0500)
CRM/Case/BAO/Case.php
CRM/Case/BAO/CaseContact.php
CRM/Case/BAO/Query.php
CRM/Contact/BAO/Contact.php
CRM/Contact/BAO/Relationship.php
CRM/Core/BAO/UFMatch.php
CRM/Core/DAO.php
CRM/Core/DAO/permissions.php
Civi/API/SelectQuery.php

index fc1ec2930840f8acf73714aa8626198ef2c27d5c..b3e77b25abaa7cd0fe9a265f31ef2e8d332ff647 100644 (file)
@@ -3121,7 +3121,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
   /**
    * @inheritDoc
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     $clauses = array(
       'id' => array(),
       // Only case admins can view deleted cases
index dbb50a0287015be3e5d27bca91afefd2e2d63337..08751a224ceff06b2750001f3897971661a86475 100644 (file)
@@ -80,7 +80,7 @@ class CRM_Case_BAO_CaseContact extends CRM_Case_DAO_CaseContact {
   /**
    * @inheritDoc
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     // In order to make things easier for downstream developers, we reuse and adapt case acls here.
     // This doesn't yield the most straightforward query, but hopefully the sql engine will sort it out.
     $clauses = array(
@@ -90,7 +90,7 @@ class CRM_Case_BAO_CaseContact extends CRM_Case_DAO_CaseContact {
     );
     $caseSubclauses = array();
     $caseBao = new CRM_Case_BAO_Case();
-    foreach ($caseBao->apiWhereClause() as $field => $fieldClauses) {
+    foreach ($caseBao->addSelectWhereClause() as $field => $fieldClauses) {
       if ($field == 'id' && $fieldClauses) {
         $clauses['case_id'] = array_merge($clauses['case_id'], (array) $fieldClauses);
       }
index cbfb04b1e717146433b0df5e450308142e605dcc..19867be3c0e570246711d9b2cc6715a056f5de5c 100644 (file)
@@ -233,7 +233,7 @@ class CRM_Case_BAO_Query {
       }
     }
     // Add acl clause
-    $aclClauses = array_filter(CRM_Case_BAO_Case::getAclClause());
+    $aclClauses = array_filter(CRM_Case_BAO_Case::getSelectWhereClause());
     foreach ($aclClauses as $clause) {
       $query->_where[0][] = $clause;
     }
index 5d7819955dbbcd752b9be2ed732ab74c1d621abe..a8813dc2831b6dbe27ad6dc7b3b9d761962643d5 100644 (file)
@@ -3428,7 +3428,7 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id )
   /**
    * @inheritDoc
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     $clauses = array(
       'id' => CRM_Contact_BAO_Contact_Permission::cacheSubquery(),
     );
index cf5b9402510857f550bdc7c4394524beca86f59c..58ed491d0fd5a5868ee8e12de8ef37e895d83292 100644 (file)
@@ -2104,7 +2104,7 @@ AND cc.sort_name LIKE '%$name%'";
   /**
    * @inheritDoc
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     // Generate an acl clause for both contacts in the relationship
     $clauses = array(
       'contact_id_a' => CRM_Contact_BAO_Contact_Permission::cacheSubquery(),
index af8d7f35137cf5f8d73287f2a3f9cc62d9fb6ccf..151252ce811b614a6e0064da2a98464f9ea97037 100644 (file)
@@ -636,7 +636,7 @@ AND    domain_id    = %4
   /**
    * @inheritDoc
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     // Prevent default behavior of joining ACLs onto the contact_id field
     $clauses = array();
     CRM_Utils_Hook::selectWhereClause($this, $clauses);
index 43e88b961035ec9a671813dc6a34be110b667427..1fed8486c70c3d042b18c05a309f147fbc66b8f0 100644 (file)
@@ -2453,7 +2453,7 @@ SELECT contact_id
   }
 
   /**
-   * Generates clauses suitable for adding to WHERE or ON when doing an api.get for this entity
+   * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
    *
    * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
    * @code
@@ -2466,7 +2466,7 @@ SELECT contact_id
    *
    * @return array
    */
-  public function apiWhereClause() {
+  public function addSelectWhereClause() {
     $clauses = array();
     $fields = $this->fields();
     $cidField = CRM_Utils_Array::value('contact_id', $fields);
@@ -2481,13 +2481,13 @@ SELECT contact_id
    * @param string $tableAlias
    * @return array
    */
-  public static function getAclClause($tableAlias = NULL) {
+  public static function getSelectWhereClause($tableAlias = NULL) {
     $bao = new static();
     if ($tableAlias === NULL) {
       $tableAlias = $bao->tableName();
     }
     $clauses = array();
-    foreach ((array) $bao->apiWhereClause() as $field => $vals) {
+    foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
       $clauses[$field] = NULL;
       if ($vals) {
         $clauses[$field] = "`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals);
index a09cbadbcedb2dedf2235c8f0f60a2e2e6581b3a..dab7812857421610d51760660d0c6f9811c6f5ff 100644 (file)
@@ -108,7 +108,7 @@ function _civicrm_api3_permissions($entity, $action, &$params) {
   // Contact-related data permissions.
   // CRM-14094 - Users can edit and delete contact-related objects using inline edit with 'edit all contacts' permission
   $permissions['address'] = array(
-    // get is managed by BAO::apiWhereClause
+    // get is managed by BAO::addSelectWhereClause
     'get' => array(),
     'default' => array(
       'access CiviCRM',
@@ -119,7 +119,7 @@ function _civicrm_api3_permissions($entity, $action, &$params) {
   $permissions['phone'] = $permissions['address'];
   $permissions['website'] = $permissions['address'];
   $permissions['im'] = $permissions['address'];
-  // @todo - implement CRM_Core_BAO_EntityTag::apiWhereClause and remove this heavy-handed restriction
+  // @todo - implement CRM_Core_BAO_EntityTag::addSelectWhereClause and remove this heavy-handed restriction
   $permissions['entity_tag'] = array('get' => array('access CiviCRM', 'view all contacts')) + $permissions['address'];
   // @todo - ditto
   $permissions['note'] = $permissions['entity_tag'];
@@ -134,7 +134,7 @@ function _civicrm_api3_permissions($entity, $action, &$params) {
 
   //relationship permissions
   $permissions['relationship'] = array(
-    // get is managed by BAO::apiWhereClause
+    // get is managed by BAO::addSelectWhereClause
     'get' => array(),
     'delete' => array(
       'access CiviCRM',
@@ -179,7 +179,7 @@ function _civicrm_api3_permissions($entity, $action, &$params) {
       'delete in CiviCase',
     ),
     'default' => array(
-      // This is the minimum permission needed. Finer-grained access is controlled by CRM_Case_BAO_Case::apiWhereClause
+      // This is the minimum permission needed. Finer-grained access is controlled by CRM_Case_BAO_Case::addSelectWhereClause
       'access my cases and activities',
     ),
   );
index ceea6f5a1d6eecb391c482336b91a15f0995e32b..728f9377a25298ae91d3544c646a85da9a2b80f1 100644 (file)
@@ -518,7 +518,7 @@ class SelectQuery {
     if (count($stack) === 1 && in_array($stack[0], $this->aclFields)) {
       return NULL;
     }
-    $clauses = $baoName::getAclClause($tableAlias);
+    $clauses = $baoName::getSelectWhereClause($tableAlias);
     if (!$stack) {
       // Track field clauses added to the main entity
       $this->aclFields = array_keys($clauses);