Civi/Api4/Contact.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  */
  18
  19
  20 namespace Civi\Api4;
  21
  22 /**
  23  * Contacts - Individuals, Organizations, Households.
  24  *
  25  * This is the central entity in the CiviCRM database, and links to
  26  * many other entities (Email, Phone, Participant, etc.).
  27  *
  28  * Creating a new contact requires at minimum a name or email address.
  29  *
  30  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/contacts/
  31  * @searchable primary
  32  * @package Civi\Api4
  33  */
  34 class Contact extends Generic\DAOEntity {
  35
  36   /**
  37    * @param bool $checkPermissions
  38    * @return Action\Contact\GetChecksum
  39    */
  40   public static function getChecksum($checkPermissions = TRUE) {
  41     return (new Action\Contact\GetChecksum(__CLASS__, __FUNCTION__))
  42       ->setCheckPermissions($checkPermissions);
  43   }
  44
  45   /**
  46    * @param bool $checkPermissions
  47    * @return Action\Contact\ValidateChecksum
  48    */
  49   public static function validateChecksum($checkPermissions = TRUE) {
  50     return (new Action\Contact\ValidateChecksum(__CLASS__, __FUNCTION__))
  51       ->setCheckPermissions($checkPermissions);
  52   }
  53
  54 }