Civi/Api4/Service/Spec/Provider/CustomFieldCreationSpecProvider.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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-2020
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Service\Spec\Provider;
  39
  40 use Civi\Api4\Service\Spec\FieldSpec;
  41 use Civi\Api4\Service\Spec\RequestSpec;
  42
  43 class CustomFieldCreationSpecProvider implements Generic\SpecProviderInterface {
  44
  45   /**
  46    * @inheritDoc
  47    */
  48   public function modifySpec(RequestSpec $spec) {
  49     $optionField = new FieldSpec('option_values', $spec->getEntity(), 'Array');
  50     $optionField->setTitle(ts('Option Values'));
  51     $optionField->setDescription('Pass an array of options (value => label) to create this field\'s option values');
  52     $spec->addFieldSpec($optionField);
  53     $spec->getFieldByName('data_type')->setDefaultValue('String')->setRequired(FALSE);
  54   }
  55
  56   /**
  57    * @inheritDoc
  58    */
  59   public function applies($entity, $action) {
  60     return $entity === 'CustomField' && $action === 'create';
  61   }
  62
  63 }