| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 5 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 12 | | under the terms of the GNU Affero General Public License | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 14 | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 18 | | See the GNU Affero General Public License for more details. | |
| 19 | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | |
| 21 | | License and the CiviCRM Licensing Exception along | |
| 22 | | with this program; if not, contact CiviCRM LLC | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 26 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * |
| 31 | * @package CRM |
| 32 | * @copyright CiviCRM LLC (c) 2004-2019 |
| 33 | * $Id$ |
| 34 | * |
| 35 | */ |
| 36 | |
| 37 | |
| 38 | namespace Civi\Api4; |
| 39 | |
| 40 | /** |
| 41 | * Address Entity. |
| 42 | * |
| 43 | * This entity holds the address informatiom of a contact. Each contact may hold |
| 44 | * one or more addresses but must have different location types respectively. |
| 45 | * |
| 46 | * Creating a new address requires at minimum a contact's ID and location type ID |
| 47 | * and other attributes (although optional) like street address, city, country etc. |
| 48 | * |
| 49 | * @package Civi\Api4 |
| 50 | */ |
| 51 | class Address extends Generic\DAOEntity { |
| 52 | |
| 53 | /** |
| 54 | * @return \Civi\Api4\Action\Address\Create |
| 55 | */ |
| 56 | public static function create() { |
| 57 | return new \Civi\Api4\Action\Address\Create(__CLASS__, __FUNCTION__); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * @return \Civi\Api4\Action\Address\Save |
| 62 | */ |
| 63 | public static function save() { |
| 64 | return new \Civi\Api4\Action\Address\Save(__CLASS__, __FUNCTION__); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * @return \Civi\Api4\Action\Address\Update |
| 69 | */ |
| 70 | public static function update() { |
| 71 | return new \Civi\Api4\Action\Address\Update(__CLASS__, __FUNCTION__); |
| 72 | } |
| 73 | |
| 74 | } |