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 | * Address Entity. | |
15 | * | |
27d31a0f | 16 | * This entity holds the address information of a contact. Each contact may hold |
19b53e5b C |
17 | * one or more addresses but must have different location types respectively. |
18 | * | |
19 | * Creating a new address requires at minimum a contact's ID and location type ID | |
27d31a0f | 20 | * and other attributes (although optional) like street address, city, country etc. |
19b53e5b | 21 | * |
117fcbd3 CW |
22 | * @ui_join_filters is_primary |
23 | * | |
aa998597 | 24 | * @searchable secondary |
d44cc3cb | 25 | * @since 5.19 |
19b53e5b C |
26 | * @package Civi\Api4 |
27 | */ | |
28 | class Address extends Generic\DAOEntity { | |
29 | ||
30 | /** | |
6764a9d3 CW |
31 | * @param bool $checkPermissions |
32 | * @return Action\Address\Create | |
19b53e5b | 33 | */ |
6764a9d3 CW |
34 | public static function create($checkPermissions = TRUE) { |
35 | return (new Action\Address\Create(__CLASS__, __FUNCTION__)) | |
36 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
37 | } |
38 | ||
39 | /** | |
6764a9d3 CW |
40 | * @param bool $checkPermissions |
41 | * @return Action\Address\Save | |
19b53e5b | 42 | */ |
6764a9d3 CW |
43 | public static function save($checkPermissions = TRUE) { |
44 | return (new Action\Address\Save(__CLASS__, __FUNCTION__)) | |
45 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
46 | } |
47 | ||
48 | /** | |
6764a9d3 CW |
49 | * @param bool $checkPermissions |
50 | * @return Action\Address\Update | |
19b53e5b | 51 | */ |
6764a9d3 CW |
52 | public static function update($checkPermissions = TRUE) { |
53 | return (new Action\Address\Update(__CLASS__, __FUNCTION__)) | |
54 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
55 | } |
56 | ||
57 | } |