class Geolocator (View source)

Represent Geolocator library.

Properties

protected int|null $glID The Geolocator ID.
protected string $glHandle The Geolocator handle.
protected string $glName The Geolocator name.
protected string $glDescription The Geolocator description.
protected array $glConfiguration The Geolocator configuration options.
protected Package|null $glPackage
protected bool $glActive Is this Geolocator the active one?

Methods

static 
create($handle, $name, Package $package = null)

Create a new Geolocator instance.

__construct()

Initialize the instance.

int|null
getGeolocatorID()

Get the Geolocator ID.

string
getGeolocatorHandle()

Get the Geolocator handle.

$this
setGeolocatorHandle(string $value)

Set the Geolocator handle.

string
getGeolocatorName()

Get the Geolocator name.

string
getGeolocatorDisplayName(string $format = 'html')

Get the Geolocator display name.

$this
setGeolocatorName(string $value)

Set the Geolocator name.

string
getGeolocatorDescription()

Get the Geolocator description.

string
getGeolocatorDisplayDescription(string $format = 'html')

Get the Geolocator display description.

$this
setGeolocatorDescription(string $value)

Set the Geolocator description.

array
getGeolocatorConfiguration()

Get the Geolocator configuration options.

$this
setGeolocatorConfiguration(array $value)

Set the Geolocator configuration options.

Package|null
getGeolocatorPackage()

Get the package associated to this Geolocator entity.

$this
setGeolocatorPackage(Package $value = null)

Set the package associated to this Geolocator entity.

bool
isActive()

Is this Geolocator the active one?

$this
setIsActive(bool $value)

Is this Geolocator the active one?

Details

static create($handle, $name, Package $package = null)

Create a new Geolocator instance.

Parameters

$handle
$name
Package $package

protected __construct()

Initialize the instance.

int|null getGeolocatorID()

Get the Geolocator ID.

Return Value

int|null returns null if the record is not (yet) persisted

string getGeolocatorHandle()

Get the Geolocator handle.

Return Value

string

$this setGeolocatorHandle(string $value)

Set the Geolocator handle.

Parameters

string $value

Return Value

$this

string getGeolocatorName()

Get the Geolocator name.

Return Value

string

string getGeolocatorDisplayName(string $format = 'html')

Get the Geolocator display name.

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

$this setGeolocatorName(string $value)

Set the Geolocator name.

Parameters

string $value

Return Value

$this

string getGeolocatorDescription()

Get the Geolocator description.

Return Value

string

string getGeolocatorDisplayDescription(string $format = 'html')

Get the Geolocator display description.

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display description won't be escaped.

Return Value

string

$this setGeolocatorDescription(string $value)

Set the Geolocator description.

Parameters

string $value

Return Value

$this

array getGeolocatorConfiguration()

Get the Geolocator configuration options.

Return Value

array

$this setGeolocatorConfiguration(array $value)

Set the Geolocator configuration options.

Parameters

array $value

Return Value

$this

Package|null getGeolocatorPackage()

Get the package associated to this Geolocator entity.

Return Value

Package|null

$this setGeolocatorPackage(Package $value = null)

Set the package associated to this Geolocator entity.

Parameters

Package $value

Return Value

$this

bool isActive()

Is this Geolocator the active one?

Return Value

bool

$this setIsActive(bool $value)

Is this Geolocator the active one?

Parameters

bool $value

Return Value

$this