Civi/Api4/Generic/AbstractUpdateAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Generic;
  39
  40 /**
  41  * Base class for all "Update" api actions
  42  *
  43  * @method $this setValues(array $values) Set all field values from an array of key => value pairs.
  44  * @method $this addValue($field, $value) Set field value.
  45  * @method array getValues() Get field values.
  46  * @method $this setReload(bool $reload) Specify whether complete objects will be returned after saving.
  47  * @method bool getReload()
  48  *
  49  * @package Civi\Api4\Generic
  50  */
  51 abstract class AbstractUpdateAction extends AbstractBatchAction {
  52
  53   /**
  54    * Field values to update.
  55    *
  56    * @var array
  57    * @required
  58    */
  59   protected $values = [];
  60
  61   /**
  62    * Reload objects after saving.
  63    *
  64    * Setting to TRUE will load complete records and return them as the api result.
  65    * If FALSE the api usually returns only the fields specified to be updated.
  66    *
  67    * @var bool
  68    */
  69   protected $reload = FALSE;
  70
  71   /**
  72    * @param string $key
  73    *
  74    * @return mixed|null
  75    */
  76   public function getValue($key) {
  77     return isset($this->values[$key]) ? $this->values[$key] : NULL;
  78   }
  79
  80 }