Added domain classes for address ontology. EmailAddress and TelNumber use the same JSON standard for the polymorphic type.

Author: fabiankessler

src/org/nameapi/client/services/ServiceFactory.php

@@ -21,6 +21,8 @@
 require_once(__DIR__.'/../../ontology/input/entities/contact/EmailAddressFactory.php');
 require_once(__DIR__.'/../../ontology/input/entities/contact/TelNumberFactory.php');
 require_once(__DIR__.'/../../ontology/input/entities/person/NaturalInputPersonBuilder.php');
+require_once(__DIR__.'/../../ontology/input/entities/address/StructuredAddressBuilder.php');
+require_once(__DIR__.'/../../ontology/input/entities/address/UseForAllAddressRelation.php');
 
 
 

src/org/nameapi/ontology/input/entities/address/AddressRelation.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+
+/**
+ * Specifies for what purposes a certain InputAddress is, for example for AddressUsage CORRESPONDENCE.
+ */
+abstract class AddressRelation implements \JsonSerializable {
+
+}
+

src/org/nameapi/ontology/input/entities/address/AddressUsage.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+
+/**
+ * Lists the possible purposes of an InputAddress.
+ *
+ * Possible values are: DOMICILE, CORRESPONDENCE, INVOICE, DELIVERY, OTHER
+ *
+ * @package org\nameapi\ontology\input\entities\address
+ */
+final class AddressUsage {
+
+    /**
+     * @var string $value
+     */
+    private $value = null;
+
+    public function __construct($value) {
+        if ($value!='DOMICILE' && $value!='CORRESPONDENCE' && $value!='INVOICE' && $value!='DELIVERY' && $value!='OTHER') {
+            throw new \Exception('Invalid value for AddressUsage: '.$value.'!');
+        }
+        $this->value = $value;
+    }
+
+
+
+    public function __toString() {
+        return $this->value;
+    }
+
+}
+

src/org/nameapi/ontology/input/entities/address/InputAddress.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+
+/**
+ * Represents a physical address which can be an address to a house, a postbox, a "packet pickup station" etc.
+ *
+ * @see StructuredAddressBuilder
+ */
+abstract class InputAddress implements \JsonSerializable {
+
+}
+

src/org/nameapi/ontology/input/entities/address/PlaceInfo.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+
+/**
+ * Information about the locality, possibly including:
+ *  - locality
+ *  - postal code
+ *  - neighborhood
+ *  - region (state)
+ *  - country
+ *
+ */
+abstract class PlaceInfo implements \JsonSerializable {
+
+}
+

src/org/nameapi/ontology/input/entities/address/StreetInfo.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+
+/**
+ * Information about the house, possibly including:
+ *  - street name
+ *  - street number
+ *  - block, entrance, floor
+ *  - apartment/suite
+ *
+ */
+abstract class StreetInfo implements \JsonSerializable {
+
+}
+

src/org/nameapi/ontology/input/entities/address/StructuredAddress.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+require_once(__DIR__.'/InputAddress.php');
+require_once(__DIR__.'/StructuredStreetInfoBuilder.php');
+require_once(__DIR__.'/StructuredPlaceInfoBuilder.php');
+
+/**
+ * An address where the individual parts (street name, postal code, ...) are structured into separate values.
+ *
+ * @see StructuredAddressBuilder
+ */
+class StructuredAddress extends InputAddress {
+
+    /**
+     * @return StructuredAddressBuilder
+     */
+    static function builder() {
+        return new StructuredAddressBuilder();
+    }
+
+
+    /**
+     * @var StreetInfo|null $streetInfo
+     */
+    public $streetInfo;
+    /**
+     * @var string|null $pobox
+     */
+    public $pobox;
+    /**
+     * @var PlaceInfo|null $placeInfo
+     */
+    public $placeInfo;
+
+    /**
+     * @param StreetInfo $streetInfo
+     * @param string $pobox
+     * @param PlaceInfo $placeInfo
+     */
+    public function __construct($streetInfo, $pobox, $placeInfo) {
+        $this->streetInfo = $streetInfo;
+        $this->pobox = $pobox;
+        $this->placeInfo = $placeInfo;
+    }
+
+    public function jsonSerialize() {
+        return array(
+            'type'       => "StructuredAddress",
+            'streetInfo' => $this->streetInfo,
+            'pobox'      => $this->pobox,
+            'placeInfo'  => $this->placeInfo,
+        );
+    }
+
+
+}
+

src/org/nameapi/ontology/input/entities/address/StructuredAddressBuilder.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+require_once(__DIR__.'/StructuredAddress.php');
+
+/**
+ * Builder for a StructuredAddress.
+ *
+ * <p>The setters don't do anything other than setting the value. They don't check if the value was
+ * set already, they don't trim the values.</p>
+ */
+class StructuredAddressBuilder {
+
+    /**
+     * @var StreetInfo|null $streetInfo
+     */
+    private $streetInfo;
+    /**
+     * @var string|null $pobox
+     */
+    private $pobox;
+    /**
+     * @var PlaceInfo|null $placeInfo
+     */
+    private $placeInfo;
+
+
+    function __construct() {
+    }
+
+
+    /**
+     * @param StreetInfo|null $streetInfo
+     * @return StructuredAddressBuilder
+     */
+    public function streetInfo($streetInfo) {
+        $this->streetInfo = $streetInfo;
+        return $this;
+    }
+
+    /**
+     * @param string|null $pobox
+     * @return StructuredAddressBuilder
+     */
+    public function pobox($pobox) {
+        $this->pobox = $pobox;
+        return $this;
+    }
+
+    /**
+     * @param PlaceInfo|null $placeInfo
+     * @return StructuredAddressBuilder
+     */
+    public function placeInfo($placeInfo) {
+        $this->placeInfo = $placeInfo;
+        return $this;
+    }
+
+
+    /**
+     * @return StructuredAddress
+     */
+    public function build() {
+        return new StructuredAddress(
+            $this->streetInfo,
+            $this->pobox,
+            $this->placeInfo
+        );
+    }
+
+}
+

src/org/nameapi/ontology/input/entities/address/StructuredPlaceInfo.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace org\nameapi\ontology\input\entities\address;
+
+require_once(__DIR__.'/PlaceInfo.php');
+
+/**
+ * @see StructuredPlaceInfoBuilder
+ */
+class StructuredPlaceInfo extends PlaceInfo {
+
+    /**
+     * @return StructuredPlaceInfoBuilder
+     */
+    static function builder() {
+        return new StructuredPlaceInfoBuilder();
+    }
+
+
+    /**
+     * @var string|null $locality
+     */
+    public $locality;
+    /**
+     * @var string|null $postalCode
+     */
+    public $postalCode;
+    /**
+     * @var string|null $neighborhood
+     */
+    public $neighborhood;
+    /**
+     * @var string|null $region
+     */
+    public $region;
+    /**
+     * @var string|null $country
+     */
+    public $country;
+
+    /**
+     * @param string $locality
+     * @param string $postalCode
+     * @param string $neighborhood
+     * @param string $region
+     * @param string $country
+     */
+    public function __construct($locality, $postalCode, $neighborhood, $region, $country) {
+        $this->locality     = $locality;
+        $this->postalCode   = $postalCode;
+        $this->neighborhood = $neighborhood;
+        $this->region       = $region;
+        $this->country      = $country;
+    }
+
+
+    public function jsonSerialize() {
+        return array(
+            'type'           => "StructuredPlaceInfo",
+            'locality'       => $this->locality,
+            'postalCode'     => $this->postalCode,
+            'neighborhood'   => $this->neighborhood,
+            'region'         => $this->region,
+            'country'        => $this->country,
+        );
+    }
+
+}
+