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 | ||
19b53e5b C |
19 | namespace Civi\Api4; |
20 | ||
21 | /** | |
22 | * GroupContact entity - link between groups and contacts. | |
23 | * | |
24 | * A contact can either be "Added" "Removed" or "Pending" in a group. | |
25 | * CiviCRM only considers them to be "in" a group if their status is "Added". | |
26 | * | |
0493ec47 CW |
27 | * @see \Civi\Api4\Group |
28 | * | |
19b53e5b C |
29 | * @package Civi\Api4 |
30 | */ | |
465bc32a CW |
31 | class GroupContact extends Generic\DAOEntity { |
32 | use Generic\Traits\EntityBridge; | |
19b53e5b C |
33 | |
34 | /** | |
6764a9d3 | 35 | * @param bool $checkPermissions |
19b53e5b C |
36 | * @return Action\GroupContact\Create |
37 | */ | |
6764a9d3 CW |
38 | public static function create($checkPermissions = TRUE) { |
39 | return (new Action\GroupContact\Create(__CLASS__, __FUNCTION__)) | |
40 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
41 | } |
42 | ||
43 | /** | |
6764a9d3 | 44 | * @param bool $checkPermissions |
19b53e5b C |
45 | * @return Action\GroupContact\Save |
46 | */ | |
6764a9d3 CW |
47 | public static function save($checkPermissions = TRUE) { |
48 | return (new Action\GroupContact\Save(__CLASS__, __FUNCTION__)) | |
49 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
50 | } |
51 | ||
52 | /** | |
6764a9d3 | 53 | * @param bool $checkPermissions |
19b53e5b C |
54 | * @return Action\GroupContact\Update |
55 | */ | |
6764a9d3 CW |
56 | public static function update($checkPermissions = TRUE) { |
57 | return (new Action\GroupContact\Update(__CLASS__, __FUNCTION__)) | |
58 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
59 | } |
60 | ||
61 | } |