-
-
Notifications
You must be signed in to change notification settings - Fork 825
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Most of api4 is in an extension - these are the changes needed to core.
- Loading branch information
Showing
10 changed files
with
388 additions
and
316 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| <?php | ||
| /* | ||
| +--------------------------------------------------------------------+ | ||
| | CiviCRM version 4.7 | | ||
| +--------------------------------------------------------------------+ | ||
| | Copyright CiviCRM LLC (c) 2004-2015 | | ||
| +--------------------------------------------------------------------+ | ||
| | This file is a part of CiviCRM. | | ||
| | | | ||
| | CiviCRM is free software; you can copy, modify, and distribute it | | ||
| | under the terms of the GNU Affero General Public License | | ||
| | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | ||
| | | | ||
| | CiviCRM is distributed in the hope that it will be useful, but | | ||
| | WITHOUT ANY WARRANTY; without even the implied warranty of | | ||
| | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | ||
| | See the GNU Affero General Public License for more details. | | ||
| | | | ||
| | You should have received a copy of the GNU Affero General Public | | ||
| | License and the CiviCRM Licensing Exception along | | ||
| | with this program; if not, contact CiviCRM LLC | | ||
| | at info[AT]civicrm[DOT]org. If you have questions about the | | ||
| | GNU Affero General Public License or the licensing of CiviCRM, | | ||
| | see the CiviCRM license FAQ at http://civicrm.org/licensing | | ||
| +--------------------------------------------------------------------+ | ||
| */ | ||
| namespace Civi\API; | ||
|
|
||
| /** | ||
| */ | ||
| class Api3SelectQuery extends SelectQuery { | ||
|
|
||
| protected $apiVersion = 3; | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| protected function buildWhereClause() { | ||
| foreach ($this->where as $key => $value) { | ||
| $table_name = NULL; | ||
| $column_name = NULL; | ||
|
|
||
| if (substr($key, 0, 7) == 'filter.') { | ||
| // Legacy support for old filter syntax per the test contract. | ||
| // (Convert the style to the later one & then deal with them). | ||
| $filterArray = explode('.', $key); | ||
| $value = array($filterArray[1] => $value); | ||
| $key = 'filters'; | ||
| } | ||
|
|
||
| // Legacy support for 'filter's construct. | ||
| if ($key == 'filters') { | ||
| foreach ($value as $filterKey => $filterValue) { | ||
| if (substr($filterKey, -4, 4) == 'high') { | ||
| $key = substr($filterKey, 0, -5); | ||
| $value = array('<=' => $filterValue); | ||
| } | ||
|
|
||
| if (substr($filterKey, -3, 3) == 'low') { | ||
| $key = substr($filterKey, 0, -4); | ||
| $value = array('>=' => $filterValue); | ||
| } | ||
|
|
||
| if ($filterKey == 'is_current' || $filterKey == 'isCurrent') { | ||
| // Is current is almost worth creating as a 'sql filter' in the DAO function since several entities have the concept. | ||
| $todayStart = date('Ymd000000', strtotime('now')); | ||
| $todayEnd = date('Ymd235959', strtotime('now')); | ||
| $a = self::MAIN_TABLE_ALIAS; | ||
| $this->query->where("($a.start_date <= '$todayStart' OR $a.start_date IS NULL) | ||
| AND ($a.end_date >= '$todayEnd' OR $a.end_date IS NULL) | ||
| AND a.is_active = 1"); | ||
| } | ||
| } | ||
| } | ||
| // Ignore the "options" param if it is referring to api options and not a field in this entity | ||
| if ( | ||
| $key === 'options' && is_array($value) | ||
| && !in_array(\CRM_Utils_Array::first(array_keys($value)), \CRM_Core_DAO::acceptedSQLOperators()) | ||
| ) { | ||
| continue; | ||
| } | ||
| $field = $this->getField($key); | ||
| if ($field) { | ||
| $key = $field['name']; | ||
| } | ||
| if (in_array($key, $this->entityFieldNames)) { | ||
| $table_name = self::MAIN_TABLE_ALIAS; | ||
| $column_name = $key; | ||
| } | ||
| elseif (($cf_id = \CRM_Core_BAO_CustomField::getKeyID($key)) != FALSE) { | ||
| list($table_name, $column_name) = $this->addCustomField($this->apiFieldSpec['custom_' . $cf_id], 'INNER'); | ||
| } | ||
| elseif (strpos($key, '.')) { | ||
| $fkInfo = $this->addFkField($key, 'INNER'); | ||
| if ($fkInfo) { | ||
| list($table_name, $column_name) = $fkInfo; | ||
| $this->validateNestedInput($key, $value); | ||
| } | ||
| } | ||
| // I don't know why I had to specifically exclude 0 as a key - wouldn't the others have caught it? | ||
| // We normally silently ignore null values passed in - if people want IS_NULL they can use acceptedSqlOperator syntax. | ||
| if ((!$table_name) || empty($key) || is_null($value)) { | ||
| // No valid filter field. This might be a chained call or something. | ||
| // Just ignore this for the $where_clause. | ||
| continue; | ||
| } | ||
| if (!is_array($value)) { | ||
| $this->query->where(array("`$table_name`.`$column_name` = @value"), array( | ||
| "@value" => $value, | ||
| )); | ||
| } | ||
| else { | ||
| // We expect only one element in the array, of the form | ||
| // "operator" => "rhs". | ||
| $operator = \CRM_Utils_Array::first(array_keys($value)); | ||
| if (!in_array($operator, \CRM_Core_DAO::acceptedSQLOperators())) { | ||
| $this->query->where(array("{$table_name}.{$column_name} = @value"), array("@value" => $value)); | ||
| } | ||
| else { | ||
| $this->query->where(\CRM_Core_DAO::createSQLFilter("{$table_name}.{$column_name}", $value)); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| protected function getFields() { | ||
| require_once 'api/v3/Generic.php'; | ||
| // Call this function directly instead of using the api wrapper to force unique field names off | ||
| $apiSpec = \civicrm_api3_generic_getfields(array( | ||
| 'entity' => $this->entity, | ||
| 'version' => 3, | ||
| 'params' => array('action' => 'get'), | ||
| ), FALSE); | ||
| return $apiSpec['values']; | ||
| } | ||
|
|
||
| /** | ||
| * Fetch a field from the getFields list | ||
| * | ||
| * Searches by name, uniqueName, and api.aliases | ||
| */ | ||
| protected function getField($fieldName) { | ||
| if (!$fieldName) { | ||
| return NULL; | ||
| } | ||
| if (isset($this->apiFieldSpec[$fieldName])) { | ||
| return $this->apiFieldSpec[$fieldName]; | ||
| } | ||
| foreach ($this->apiFieldSpec as $field) { | ||
| if ( | ||
| $fieldName == \CRM_Utils_Array::value('uniqueName', $field) || | ||
| array_search($fieldName, \CRM_Utils_Array::value('api.aliases', $field, array())) !== FALSE | ||
| ) { | ||
| return $field; | ||
| } | ||
| } | ||
| return NULL; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.