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 | */ | |
90908aac | 31 | class GroupContact extends Generic\BridgeEntity { |
19b53e5b C |
32 | |
33 | /** | |
6764a9d3 | 34 | * @param bool $checkPermissions |
19b53e5b C |
35 | * @return Action\GroupContact\Create |
36 | */ | |
6764a9d3 CW |
37 | public static function create($checkPermissions = TRUE) { |
38 | return (new Action\GroupContact\Create(__CLASS__, __FUNCTION__)) | |
39 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
40 | } |
41 | ||
42 | /** | |
6764a9d3 | 43 | * @param bool $checkPermissions |
19b53e5b C |
44 | * @return Action\GroupContact\Save |
45 | */ | |
6764a9d3 CW |
46 | public static function save($checkPermissions = TRUE) { |
47 | return (new Action\GroupContact\Save(__CLASS__, __FUNCTION__)) | |
48 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
49 | } |
50 | ||
51 | /** | |
6764a9d3 | 52 | * @param bool $checkPermissions |
19b53e5b C |
53 | * @return Action\GroupContact\Update |
54 | */ | |
6764a9d3 CW |
55 | public static function update($checkPermissions = TRUE) { |
56 | return (new Action\GroupContact\Update(__CLASS__, __FUNCTION__)) | |
57 | ->setCheckPermissions($checkPermissions); | |
19b53e5b C |
58 | } |
59 | ||
60 | } |