Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <?php |
2 | ||
380f3545 TO |
3 | /* |
4 | +--------------------------------------------------------------------+ | |
5 | | CiviCRM version 5 | | |
6 | +--------------------------------------------------------------------+ | |
7 | | Copyright CiviCRM LLC (c) 2004-2019 | | |
8 | +--------------------------------------------------------------------+ | |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * | |
31 | * @package CRM | |
32 | * @copyright CiviCRM LLC (c) 2004-2019 | |
33 | * $Id$ | |
34 | * | |
35 | */ | |
36 | ||
37 | ||
19b53e5b C |
38 | namespace Civi\Api4\Action\GroupContact; |
39 | ||
40 | /** | |
41 | * @inheritDoc | |
42 | * | |
43 | * @method $this setMethod(string $method) Indicate who added/removed the group. | |
44 | * @method string getMethod() | |
45 | * @method $this setTracking(string $tracking) Specify ip address or other tracking info. | |
46 | * @method string getTracking() | |
47 | */ | |
48 | trait GroupContactSaveTrait { | |
49 | ||
50 | /** | |
51 | * String to indicate who added/removed the group. | |
52 | * | |
53 | * @var string | |
54 | */ | |
55 | protected $method = 'API'; | |
56 | ||
57 | /** | |
58 | * IP address or other tracking info about who performed this group subscription. | |
59 | * | |
60 | * @var string | |
61 | */ | |
62 | protected $tracking = ''; | |
63 | ||
64 | /** | |
65 | * @inheritDoc | |
66 | */ | |
67 | protected function writeObjects($items) { | |
68 | foreach ($items as &$item) { | |
69 | $item['method'] = $this->method; | |
70 | $item['tracking'] = $this->tracking; | |
71 | } | |
72 | return parent::writeObjects($items); | |
73 | } | |
74 | ||
75 | } |