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 namespace Civi\Api4;
  22
  23 /**
  24  * GroupContact entity - link between groups and contacts.
  25  *
  26  * A contact can either be "Added" "Removed" or "Pending" in a group.
  27  * CiviCRM only considers them to be "in" a group if their status is "Added".
  28  *
  29  * @see \Civi\Api4\Group
  30  *
  31  * @package Civi\Api4
  32  */
  33 class GroupContact extends Generic\DAOEntity {
  34
  35   /**
  36    * @return Action\GroupContact\Create
  37    */
  38   public static function create() {
  39     return new Action\GroupContact\Create(__CLASS__, __FUNCTION__);
  40   }
  41
  42   /**
  43    * @return Action\GroupContact\Save
  44    */
  45   public static function save() {
  46     return new Action\GroupContact\Save(__CLASS__, __FUNCTION__);
  47   }
  48
  49   /**
  50    * @return Action\GroupContact\Update
  51    */
  52   public static function update() {
  53     return new Action\GroupContact\Update(__CLASS__, __FUNCTION__);
  54   }
  55
  56 }