Civi/Api4/Generic/DAOCreateAction.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  * Create a new object from supplied values.
  42  *
  43  * This function will create 1 new object. It cannot be used to update existing objects. Use the Update or Replace actions for that.
  44  */
  45 class DAOCreateAction extends AbstractCreateAction {
  46   use Traits\DAOActionTrait;
  47
  48   /**
  49    * @inheritDoc
  50    */
  51   public function _run(Result $result) {
  52     $this->validateValues();
  53     $params = $this->values;
  54     $this->fillDefaults($params);
  55
  56     $resultArray = $this->writeObjects([$params]);
  57
  58     $result->exchangeArray($resultArray);
  59   }
  60
  61   /**
  62    * @throws \API_Exception
  63    */
  64   protected function validateValues() {
  65     if (!empty($this->values['id'])) {
  66       throw new \API_Exception('Cannot pass id to Create action. Use Update action instead.');
  67     }
  68     parent::validateValues();
  69   }
  70
  71 }