Civi/Api4/GroupContact.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   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       |
  10  +--------------------------------------------------------------------+
  11  */
  12
  13 /**
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  * $Id$
  18  *
  19  */
  20
  21
  22 namespace Civi\Api4;
  23
  24 /**
  25  * GroupContact entity - link between groups and contacts.
  26  *
  27  * A contact can either be "Added" "Removed" or "Pending" in a group.
  28  * CiviCRM only considers them to be "in" a group if their status is "Added".
  29  *
  30  * @package Civi\Api4
  31  */
  32 class GroupContact extends Generic\DAOEntity {
  33
  34   /**
  35    * @return Action\GroupContact\Create
  36    */
  37   public static function create() {
  38     return new Action\GroupContact\Create(__CLASS__, __FUNCTION__);
  39   }
  40
  41   /**
  42    * @return Action\GroupContact\Save
  43    */
  44   public static function save() {
  45     return new Action\GroupContact\Save(__CLASS__, __FUNCTION__);
  46   }
  47
  48   /**
  49    * @return Action\GroupContact\Update
  50    */
  51   public static function update() {
  52     return new Action\GroupContact\Update(__CLASS__, __FUNCTION__);
  53   }
  54
  55 }