Documentation

OpenStreetMap_Coordinate_Model extends Base
in package

Coordiante model.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Tomasz Kur t.kur@yetiforce.com

Table of Contents

EARTH_RADIUS  = 6378137
Radius earth.
$colors  : mixed
$value  : mixed
__construct()  : mixed
Constructor.
addCache()  : mixed
Adding records to the clipboard.
deleteCache()  : mixed
Removes records in the clipbord.
get()  : mixed
Function to get the value for a given key.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getCachedRecords()  : array<string|int, mixed>
Get total count of records in the clipboard.
getCoordinatesCenter()  : array<string|int, mixed>
Function to get coordinates of center point.
getCoordinatesCustomView()  : array<string|int, mixed>
Get coordinates for select records.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getInstance()  : self
Function to get instance.
getKeys()  : array<string|int, string>
Function to get keys.
getLabelsToPopupById()  : string
Function get label in popup.
getLabelToPopupByArray()  : string
Function to get content in popup.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
readAllCoordinatesFromCustomeView()  : array<string|int, mixed>
Get coordinates for all records in the listview.
readCoordinates()  : array<string|int, mixed>
Function to get coordinates for record.
readCoordinatesByRecords()  : array<string|int, mixed>
Function to get coordinates for many records.
readCoordinatesCache()  : array<string|int, mixed>
Get coordinates for records from the clipboard.
remove()  : mixed
Function to remove the value.
saveAllRecordsToCache()  : mixed
Function to set all records from module to cache.
saveCache()  : mixed
Save records to clipboard.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
getMargins()  : array<string|int, float>
The function return the border coordinates for the point.
getMarkerColor()  : string
Draws color.

Constants

EARTH_RADIUS

Radius earth.

public mixed EARTH_RADIUS = 6378137

Properties

$value

protected mixed $value

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, mixed> = []
Return values
mixed

addCache()

Adding records to the clipboard.

public addCache(type $record) : mixed
Parameters
$record : type
Return values
mixed

deleteCache()

Removes records in the clipbord.

public deleteCache() : mixed
Return values
mixed

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getCachedRecords()

Get total count of records in the clipboard.

public getCachedRecords() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCoordinatesCenter()

Function to get coordinates of center point.

public getCoordinatesCenter() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCoordinatesCustomView()

Get coordinates for select records.

public getCoordinatesCustomView() : array<string|int, mixed>
Return values
array<string|int, mixed>

getData()

Function to get all the values of the Object.

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed

Value for the given key

getInstance()

Function to get instance.

public static getInstance() : self
Return values
self

getKeys()

Function to get keys.

public getKeys() : array<string|int, string>
Return values
array<string|int, string>

getLabelsToPopupById()

Function get label in popup.

public getLabelsToPopupById(int $crmid) : string
Parameters
$crmid : int
Return values
string

getLabelToPopupByArray()

Function to get content in popup.

public getLabelToPopupByArray(array<string|int, mixed> $data, string $moduleName) : string
Parameters
$data : array<string|int, mixed>
$moduleName : string
Return values
string

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

readAllCoordinatesFromCustomeView()

Get coordinates for all records in the listview.

public readAllCoordinatesFromCustomeView() : array<string|int, mixed>
Return values
array<string|int, mixed>

readCoordinates()

Function to get coordinates for record.

public readCoordinates(int $recordId) : array<string|int, mixed>
Parameters
$recordId : int
Return values
array<string|int, mixed>

readCoordinatesByRecords()

Function to get coordinates for many records.

public readCoordinatesByRecords(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>

Array with id of records

Return values
array<string|int, mixed>

readCoordinatesCache()

Get coordinates for records from the clipboard.

public readCoordinatesCache() : array<string|int, mixed>
Return values
array<string|int, mixed>

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

saveAllRecordsToCache()

Function to set all records from module to cache.

public saveAllRecordsToCache() : mixed
Return values
mixed

saveCache()

Save records to clipboard.

public saveCache(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

Array with records id

Return values
mixed

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

getMargins()

The function return the border coordinates for the point.

private getMargins(array<string|int, mixed> $coordinates, int $radius) : array<string|int, float>
Parameters
$coordinates : array<string|int, mixed>
$radius : int
Return values
array<string|int, float>

getMarkerColor()

Draws color.

private getMarkerColor(string $value) : string
Parameters
$value : string
Tags
staticvar

int $indexColor

Return values
string

color

Search results