Merge pull request #16161 from civicrm/5.21

[civicrm-core.git] / CRM / Utils / API / AbstractFieldCoder.php

diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php
index 0d28cbffbdb4a4418a3abb5dbd77d8ea900349c0..b26d3b82de4a370fe17a55f44e54ebd2e15e5e79 100644 (file)
--- a/CRM/Utils/API/AbstractFieldCoder.php
+++ b/CRM/Utils/API/AbstractFieldCoder.php
@@ -1,27 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019                                |
- +--------------------------------------------------------------------+
- | 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.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | 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        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 
@@ -30,7 +14,7 @@
  * of all fields (except for some black-listed skip-fields).
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2019
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
  */
 
 require_once 'api/Wrapper.php';
@@ -79,7 +63,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
     }
     // Field can take multiple entries, eg. fieldName[1], fieldName[2], etc.
     // We remove the index and check again if the fieldName in the list of skipped fields.
-    $matches = array();
+    $matches = [];
     if (preg_match('/^(.*)\[\d+\]/', $fldName, $matches) && in_array($matches[1], $skipFields)) {
       return TRUE;
     }
@@ -92,7 +76,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
    *
    * @param array|string $values the field value from the API
    */
-  public abstract function encodeInput(&$values);
+  abstract public function encodeInput(&$values);
 
   /**
    * Decode output.
@@ -101,14 +85,14 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
    *
    * @return mixed
    */
-  public abstract function decodeOutput(&$values);
+  abstract public function decodeOutput(&$values);
 
   /**
    * @inheritDoc
    */
   public function fromApiInput($apiRequest) {
     $lowerAction = strtolower($apiRequest['action']);
-    if ($apiRequest['version'] == 3 && in_array($lowerAction, array('get', 'create'))) {
+    if ($apiRequest['version'] == 3 && in_array($lowerAction, ['get', 'create'])) {
       // note: 'getsingle', 'replace', 'update', and chaining all build on top of 'get'/'create'
       foreach ($apiRequest['params'] as $key => $value) {
         // Don't apply escaping to API control parameters (e.g. 'api.foo' or 'options.foo')
@@ -133,7 +117,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper {
    */
   public function toApiOutput($apiRequest, $result) {
     $lowerAction = strtolower($apiRequest['action']);
-    if ($apiRequest['version'] == 3 && in_array($lowerAction, array('get', 'create', 'setvalue', 'getquick'))) {
+    if ($apiRequest['version'] == 3 && in_array($lowerAction, ['get', 'create', 'setvalue', 'getquick'])) {
       foreach ($result as $key => $value) {
         // Don't apply escaping to API control parameters (e.g. 'api.foo' or 'options.foo')
         // and don't apply to other skippable fields