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