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

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   7  | This work is published under the GNU AGPLv3 license with some      |
   8  | permitted exceptions and without any warranty. For full license    |
   9  | and copyright information, see https://civicrm.org/licensing       |
  10  +--------------------------------------------------------------------+
  11  */
  12
  13 /**
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  * $Id$
  18  *
  19  */
  20
  21
  22 namespace Civi\Api4\Service\Spec\Provider;
  23
  24 use Civi\Api4\Service\Spec\FieldSpec;
  25 use Civi\Api4\Service\Spec\RequestSpec;
  26
  27 class CustomFieldCreationSpecProvider implements Generic\SpecProviderInterface {
  28
  29   /**
  30    * @inheritDoc
  31    */
  32   public function modifySpec(RequestSpec $spec) {
  33     $optionField = new FieldSpec('option_values', $spec->getEntity(), 'Array');
  34     $optionField->setTitle(ts('Option Values'));
  35     $optionField->setDescription('Pass an array of options (value => label) to create this field\'s option values');
  36     $spec->addFieldSpec($optionField);
  37     $spec->getFieldByName('data_type')->setDefaultValue('String')->setRequired(FALSE);
  38   }
  39
  40   /**
  41    * @inheritDoc
  42    */
  43   public function applies($entity, $action) {
  44     return $entity === 'CustomField' && $action === 'create';
  45   }
  46
  47 }