Commit | Line | Data |
---|---|---|
19b53e5b | 1 | <?php |
380f3545 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
41498ac5 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
380f3545 | 5 | | | |
41498ac5 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
380f3545 TO |
9 | +--------------------------------------------------------------------+ |
10 | */ | |
19b53e5b C |
11 | namespace Civi\Api4; |
12 | ||
13 | /** | |
14 | * Contacts - Individuals, Organizations, Households. | |
15 | * | |
16 | * This is the central entity in the CiviCRM database, and links to | |
17 | * many other entities (Email, Phone, Participant, etc.). | |
18 | * | |
19 | * Creating a new contact requires at minimum a name or email address. | |
20 | * | |
0493ec47 | 21 | * @see https://docs.civicrm.org/user/en/latest/organising-your-data/contacts/ |
aa998597 | 22 | * @searchable primary |
076fe09a | 23 | * @orderBy sort_name |
d44cc3cb | 24 | * @since 5.19 |
19b53e5b C |
25 | * @package Civi\Api4 |
26 | */ | |
27 | class Contact extends Generic\DAOEntity { | |
28 | ||
e15f9453 | 29 | /** |
6764a9d3 CW |
30 | * @param bool $checkPermissions |
31 | * @return Action\Contact\GetChecksum | |
e15f9453 | 32 | */ |
6764a9d3 CW |
33 | public static function getChecksum($checkPermissions = TRUE) { |
34 | return (new Action\Contact\GetChecksum(__CLASS__, __FUNCTION__)) | |
35 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
36 | } |
37 | ||
e15f9453 | 38 | /** |
6764a9d3 CW |
39 | * @param bool $checkPermissions |
40 | * @return Action\Contact\ValidateChecksum | |
e15f9453 | 41 | */ |
6764a9d3 CW |
42 | public static function validateChecksum($checkPermissions = TRUE) { |
43 | return (new Action\Contact\ValidateChecksum(__CLASS__, __FUNCTION__)) | |
44 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
45 | } |
46 | ||
47 | } |