Civi/Api4/Action/Contact/ValidateChecksum.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Action\Contact;
  39
  40 use Civi\Api4\Generic\Result;
  41
  42 /**
  43  * Generate a security checksum for anonymous access to CiviCRM.
  44  *
  45  * @method $this setContactId(int $cid) Set contact ID (required)
  46  * @method int getContactId() Get contact ID param
  47  * @method $this setChecksum(string $checksum) Set checksum param (required)
  48  * @method string getChecksum() Get checksum param
  49  */
  50 class ValidateChecksum extends \Civi\Api4\Generic\AbstractAction {
  51
  52   /**
  53    * ID of contact
  54    *
  55    * @var int
  56    * @required
  57    */
  58   protected $contactId;
  59
  60   /**
  61    * Value of checksum
  62    *
  63    * @var string
  64    * @required
  65    */
  66   protected $checksum;
  67
  68   /**
  69    * @param \Civi\Api4\Generic\Result $result
  70    */
  71   public function _run(Result $result) {
  72     $result[] = [
  73       'valid' => \CRM_Contact_BAO_Contact_Utils::validChecksum($this->contactId, $this->checksum),
  74     ];
  75   }
  76
  77 }