Geolocator
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
Initialize the instance.
Get the Geolocator ID.
Get the Geolocator handle.
Set the Geolocator handle.
Get the Geolocator name.
Get the Geolocator display name.
Set the Geolocator name.
Get the Geolocator description.
Get the Geolocator display description.
Set the Geolocator description.
Get the Geolocator configuration options.
Set the Geolocator configuration options.
Get the package associated to this Geolocator entity.
Is this Geolocator the active one?
Is this Geolocator the active one?
Details
static
create($handle, $name, Package $package = null)
Create a new Geolocator instance.
protected
__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?