Civi/Api4/Address.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  * Address Entity.
  26  *
  27  * This entity holds the address informatiom of a contact. Each contact may hold
  28  * one or more addresses but must have different location types respectively.
  29  *
  30  * Creating a new address requires at minimum a contact's ID and location type ID
  31  *  and other attributes (although optional) like street address, city, country etc.
  32  *
  33  * @package Civi\Api4
  34  */
  35 class Address extends Generic\DAOEntity {
  36
  37   /**
  38    * @return \Civi\Api4\Action\Address\Create
  39    */
  40   public static function create() {
  41     return new \Civi\Api4\Action\Address\Create(__CLASS__, __FUNCTION__);
  42   }
  43
  44   /**
  45    * @return \Civi\Api4\Action\Address\Save
  46    */
  47   public static function save() {
  48     return new \Civi\Api4\Action\Address\Save(__CLASS__, __FUNCTION__);
  49   }
  50
  51   /**
  52    * @return \Civi\Api4\Action\Address\Update
  53    */
  54   public static function update() {
  55     return new \Civi\Api4\Action\Address\Update(__CLASS__, __FUNCTION__);
  56   }
  57
  58 }