API Documentation
\
Radar
Connect
Entity

\Radar\Connect\EntityLocation

Summary

Methods
Properties
Constants
className()
__construct()
set()
apiUri()
getUuid()
getVuuid()
getInternalId()
getInternalVid()
getTitle()
getAddressRaw()
getAddress()
getDirectionsRaw()
getDirections()
getLocationRaw()
getLocation()
$drupalId
$drupalVersionId
$uuid
$vuuid
$type
$title
$address
$directions
$map
$timezone
No constants found
No protected methods found
$apiUri
$apiBase
N/A
No private methods found
No private properties found
N/A

Properties

$drupalId

$drupalId :

Type

$drupalVersionId

$drupalVersionId :

Type

$uuid

$uuid :

Type

$vuuid

$vuuid :

Type

$type

$type :

Type

$title

$title :

Type

$address

$address :

Type

$directions

$directions :

Type

$map

$map :

Type

$timezone

$timezone :

Type

$apiUri

$apiUri :

Type

$apiBase

$apiBase :

Type

Methods

className()

className(  $type)

TODO move this to the controller Connect class.

Parameters

$type

__construct()

__construct(  $data = array())

Parameters

$data

set()

set(  $data)

Set data for entity.

Parameters

$data

apiUri()

apiUri() : string

Return the API URI for this entity.

Returns

string

getUuid()

getUuid() : string|null

Return the UUID for the entity.

Returns

string|null

getVuuid()

getVuuid() : string|null

Return the Version UUID for the entity.

Returns

string|null

getInternalId()

getInternalId() : integer|null

Return the Drupal internal ID for the entity.

Returns

integer|null

getInternalVid()

getInternalVid() : integer|null

Return the Drupal internal version ID for the entity.

Returns

integer|null

getTitle()

getTitle()

getAddressRaw()

getAddressRaw() : array

Return address array.

array ['country'] two letter code ['name_line'] locally known as ['first_name'] ['last_name'] ['organisation_name'] ['administrative_area'] ['sub_administrative_area'] ['locality'] city name ['dependent_locality'] ['postal_code'] postcode ['thoroughfare'] street ['premise']

Returns

array

getAddress()

getAddress(array  $include = array('name_line', 'thoroughfare', 'locality'), string  $seperator = ', ') : string

Return components of the address, glued with string.

Parameters

array $include

Key names. See self::getAddressRaw() for list.
string $seperator

Glue to join components.

Returns

string

getDirectionsRaw()

getDirectionsRaw()

getDirections()

getDirections() : string

Return the directions text field.

Free text field used for describing how to get to a location.

Returns

string

getLocationRaw()

getLocationRaw()

getLocation()

getLocation() : \geoPHP\Geometry

Return the geographic location.

Usually a point, geocoded or manually added.

Returns

\geoPHP\Geometry