Civi/Api4/Service/Spec/Provider/MappingCreationSpecProvider.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\RequestSpec;
  25
  26 class MappingCreationSpecProvider implements Generic\SpecProviderInterface {
  27
  28   /**
  29    * This function runs for both Mapping and MappingField entities
  30    *
  31    * @param \Civi\Api4\Service\Spec\RequestSpec $spec
  32    */
  33   public function modifySpec(RequestSpec $spec) {
  34     $spec->getFieldByName('name')->setRequired(TRUE);
  35   }
  36
  37   /**
  38    * @param string $entity
  39    * @param string $action
  40    *
  41    * @return bool
  42    */
  43   public function applies($entity, $action) {
  44     return strpos($entity, 'Mapping') === 0 && $action === 'create';
  45   }
  46
  47 }