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 information 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  * @ui_join_filters location_type_id
  32  *
  33  * @searchable secondary
  34  * @package Civi\Api4
  35  */
  36 class Address extends Generic\DAOEntity {
  37
  38   /**
  39    * @param bool $checkPermissions
  40    * @return Action\Address\Create
  41    */
  42   public static function create($checkPermissions = TRUE) {
  43     return (new Action\Address\Create(__CLASS__, __FUNCTION__))
  44       ->setCheckPermissions($checkPermissions);
  45   }
  46
  47   /**
  48    * @param bool $checkPermissions
  49    * @return Action\Address\Save
  50    */
  51   public static function save($checkPermissions = TRUE) {
  52     return (new Action\Address\Save(__CLASS__, __FUNCTION__))
  53       ->setCheckPermissions($checkPermissions);
  54   }
  55
  56   /**
  57    * @param bool $checkPermissions
  58    * @return Action\Address\Update
  59    */
  60   public static function update($checkPermissions = TRUE) {
  61     return (new Action\Address\Update(__CLASS__, __FUNCTION__))
  62       ->setCheckPermissions($checkPermissions);
  63   }
  64
  65 }