Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <?php |
2 | ||
380f3545 TO |
3 | /* |
4 | +--------------------------------------------------------------------+ | |
41498ac5 | 5 | | Copyright CiviCRM LLC. All rights reserved. | |
380f3545 | 6 | | | |
41498ac5 TO |
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 | | |
380f3545 TO |
10 | +--------------------------------------------------------------------+ |
11 | */ | |
12 | ||
13 | /** | |
14 | * | |
15 | * @package CRM | |
ca5cec67 | 16 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
380f3545 TO |
17 | */ |
18 | ||
19 | ||
19b53e5b C |
20 | namespace Civi\Api4; |
21 | ||
22 | /** | |
23 | * Address Entity. | |
24 | * | |
27d31a0f | 25 | * This entity holds the address information of a contact. Each contact may hold |
19b53e5b C |
26 | * one or more addresses but must have different location types respectively. |
27 | * | |
28 | * Creating a new address requires at minimum a contact's ID and location type ID | |
27d31a0f | 29 | * and other attributes (although optional) like street address, city, country etc. |
19b53e5b | 30 | * |
2f616560 CW |
31 | * @ui_join_filters location_type_id |
32 | * | |
aa998597 | 33 | * @searchable secondary |
19b53e5b C |
34 | * @package Civi\Api4 |
35 | */ | |
36 | class Address extends Generic\DAOEntity { | |
37 | ||
38 | /** | |
6764a9d3 CW |
39 | * @param bool $checkPermissions |
40 | * @return Action\Address\Create | |
19b53e5b | 41 | */ |
6764a9d3 CW |
42 | public static function create($checkPermissions = TRUE) { |
43 | return (new Action\Address\Create(__CLASS__, __FUNCTION__)) | |
44 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
45 | } |
46 | ||
47 | /** | |
6764a9d3 CW |
48 | * @param bool $checkPermissions |
49 | * @return Action\Address\Save | |
19b53e5b | 50 | */ |
6764a9d3 CW |
51 | public static function save($checkPermissions = TRUE) { |
52 | return (new Action\Address\Save(__CLASS__, __FUNCTION__)) | |
53 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
54 | } |
55 | ||
56 | /** | |
6764a9d3 CW |
57 | * @param bool $checkPermissions |
58 | * @return Action\Address\Update | |
19b53e5b | 59 | */ |
6764a9d3 CW |
60 | public static function update($checkPermissions = TRUE) { |
61 | return (new Action\Address\Update(__CLASS__, __FUNCTION__)) | |
62 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
63 | } |
64 | ||
65 | } |