Civi/Api4/GroupContact.php

   1 <?php
   2
   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
  38 namespace Civi\Api4;
  39
  40 /**
  41  * GroupContact entity - link between groups and contacts.
  42  *
  43  * A contact can either be "Added" "Removed" or "Pending" in a group.
  44  * CiviCRM only considers them to be "in" a group if their status is "Added".
  45  *
  46  * @package Civi\Api4
  47  */
  48 class GroupContact extends Generic\DAOEntity {
  49
  50   /**
  51    * @return Action\GroupContact\Create
  52    */
  53   public static function create() {
  54     return new Action\GroupContact\Create(__CLASS__, __FUNCTION__);
  55   }
  56
  57   /**
  58    * @return Action\GroupContact\Save
  59    */
  60   public static function save() {
  61     return new Action\GroupContact\Save(__CLASS__, __FUNCTION__);
  62   }
  63
  64   /**
  65    * @return Action\GroupContact\Update
  66    */
  67   public static function update() {
  68     return new Action\GroupContact\Update(__CLASS__, __FUNCTION__);
  69   }
  70
  71 }