Civi/Api4/Service/Spec/Provider/NoteCreationSpecProvider.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 NoteCreationSpecProvider implements Generic\SpecProviderInterface {
  27
  28   /**
  29    * @param \Civi\Api4\Service\Spec\RequestSpec $spec
  30    */
  31   public function modifySpec(RequestSpec $spec) {
  32     $spec->getFieldByName('note')->setRequired(TRUE);
  33     $spec->getFieldByName('entity_table')->setDefaultValue('civicrm_contact');
  34   }
  35
  36   /**
  37    * @param string $entity
  38    * @param string $action
  39    *
  40    * @return bool
  41    */
  42   public function applies($entity, $action) {
  43     return $entity === 'Note' && $action === 'create';
  44   }
  45
  46 }