Civi/Api4/Action/Contact/ValidateChecksum.php

   1 <?php
   2
   3 namespace Civi\Api4\Action\Contact;
   4
   5 use Civi\Api4\Generic\Result;
   6
   7 /**
   8  * Generate a security checksum for anonymous access to CiviCRM.
   9  *
  10  * @method $this setContactId(int $cid) Set contact ID (required)
  11  * @method int getContactId() Get contact ID param
  12  * @method $this setChecksum(string $checksum) Set checksum param (required)
  13  * @method string getChecksum() Get checksum param
  14  */
  15 class ValidateChecksum extends \Civi\Api4\Generic\AbstractAction {
  16
  17   /**
  18    * ID of contact
  19    *
  20    * @var int
  21    * @required
  22    */
  23   protected $contactId;
  24
  25   /**
  26    * Value of checksum
  27    *
  28    * @var string
  29    * @required
  30    */
  31   protected $checksum;
  32
  33   /**
  34    * @param \Civi\Api4\Generic\Result $result
  35    */
  36   public function _run(Result $result) {
  37     $result[] = [
  38       'valid' => \CRM_Contact_BAO_Contact_Utils::validChecksum($this->contactId, $this->checksum),
  39     ];
  40   }
  41
  42 }