Table of Contents
-
ALLOWED_GEOCODING_QUEUES
= ['address', 'rosreestr', 'fias']
-
ALLOWED_MASTER_TYPE
= ['geoIntersect', 'area', 'near', 'updateFieldTime', 'script', 'alternativeCoordinates']
-
ALLOWED_MEASURE
= ['kilometers', 'meters']
-
DELETE_PERMISSION
= 8
-
DOWNLOAD_PERMISSION
= 16
-
READ_PERMISSION
= 1
-
SET_CATEGORY_PERMISSION
= 4
-
WRITE_PERMISSION
= 2
-
ALLOWED_TYPE
= ['simple', 'related', 'dependent', 'track', 'routes']
-
$_id
: ObjectId
-
$areaField
: string|null
-
$author
: array<string|int, mixed>|null
-
$authorField
: string|null
-
$categories
: Categories
-
$categoryHistory
: bool
-
$cluster
: ClusterDataSetEntity
-
$connections
: array<string|int, mixed>
-
$createDateField
: string|null
-
$dataSetStats
: array<string|int, mixed>
-
$description
: string
-
$editorField
: string|null
-
$geocodingQueue
: array<string|int, mixed>
-
$isGeocoding
: bool
-
$isIncrementUniqueValue
: bool|null
-
$lengthField
: string|null
-
$masterId
: ObjectId|null
-
$maxDistance
: float
-
$maxUniqueValue
: int
-
$measure
: string
-
$minEditorZoom
: int|null
-
$name
: string
-
$objectExpireTime
: int
-
$organizationId
: ObjectId
-
$possibleGeocoding
: array<string|int, mixed>
-
$private
: bool
-
$protected
: bool
-
$schemeId
: ObjectId|null
-
$sendable
: bool
-
$smallDescription
: string
-
$type
: string
-
$uniqueField
: string|null
-
$updateDateField
: string|null
-
$deleted
: bool|null
-
$displayObjectsLimit
: int
-
$findPolygonIntersections
: bool
-
$linkingField
: string|null
-
$withRestrictions
: bool
-
__construct()
: mixed
-
__toString()
: string
-
addConnection()
: self
-
bsonSerialize()
: array<string|int, mixed>
-
bsonUnserialize()
: void
-
checkAndSetMaxUniqueValue()
: self
-
createFromArray()
: DataSetEntity
-
getAreaField()
: string|null
-
getAuthor()
: array<string|int, mixed>|null
-
getAuthorField()
: string|null
-
getCategories()
: Categories
-
getCategoryHistory()
: bool
-
getCluster()
: ClusterDataSetEntity
-
getConnections()
: array<string|int, ConnectionInterface>
-
getCreateDateField()
: string|null
-
getDataSetStats()
: array<string|int, mixed>
-
getDeleted()
: bool|null
-
getDescription()
: string
-
getDisplayObjectsLimit()
: int
-
getEditorField()
: string|null
-
getGeocodingQueue()
: array<string|int, mixed>
-
getId()
: ObjectId
-
getIsIncrementUniqueValue()
: bool
-
getLengthField()
: string|null
-
getLinkingField()
: string|null
-
getMasterId()
: ObjectId
-
getMaxDistance()
: float
-
getMaxUniqueValue()
: int
-
getMeasure()
: string
-
getMinEditorZoom()
: int|null
-
getName()
: string
-
getObjectExpireTime()
: int
-
getOrganizationId()
: ObjectId
-
getPossibleGeocoding()
: array<string|int, mixed>
-
getSchemeId()
: ObjectId|null
-
getSmallDescription()
: string
-
getType()
: string
-
getUniqueField()
: string|null
-
getUpdateDateField()
: string|null
-
incAndGetMaxNumberUniqueValue()
: int
-
isFindPolygonIntersections()
: bool
-
isGeocoding()
: bool
-
isPrivate()
: bool
-
isProtected()
: bool
-
isSendable()
: bool
-
isWithRestrictions()
: bool
-
jsonSerialize()
: array<string|int, mixed>
-
markAsDeleted()
: self
-
parseObjectId()
: ObjectId|null
-
removeMaster()
: self
-
setAreaField()
: self
-
setAuthor()
: self
-
setAuthorField()
: self
-
setCategories()
: self
-
setCategoryHistory()
: self
-
setCluster()
: self
-
setConnections()
: self
-
setCreateDateField()
: self
-
setDataSetStats()
: self
-
setDeleted()
: DataSetEntity
-
setDescription()
: self
-
setDisplayObjectsLimit()
: self
-
setEditorField()
: self
-
setFindPolygonIntersections()
: self
-
setGeocodingQueue()
: self
-
setId()
: self
-
setIsGeocoding()
: self
-
setIsIncrementUniqueValue()
: self
-
setLengthField()
: self
-
setLinkingField()
: self
-
setMasterId()
: self
-
setMaxDistance()
: self
-
setMaxUniqueValue()
: self
-
setMeasure()
: self
-
setMinEditorZoom()
: self
-
setName()
: self
-
setObjectExpireTime()
: self
-
setOrganizationId()
: self
-
setPossibleGeocoding()
: self
-
setPrivate()
: DataSetEntity
-
setProtected()
: self
-
setSchemeId()
: self
-
setSendable()
: DataSetEntity
-
setSmallDescription()
: self
-
setUniqueField()
: self
-
setUpdateDateField()
: self
-
setWithRestrictions()
: self
-
toArray()
: array<string|int, mixed>
ALLOWED_GEOCODING_QUEUES
public
mixed
ALLOWED_GEOCODING_QUEUES
= ['address', 'rosreestr', 'fias']
ALLOWED_MASTER_TYPE
public
mixed
ALLOWED_MASTER_TYPE
= ['geoIntersect', 'area', 'near', 'updateFieldTime', 'script', 'alternativeCoordinates']
ALLOWED_MEASURE
public
mixed
ALLOWED_MEASURE
= ['kilometers', 'meters']
DELETE_PERMISSION
public
mixed
DELETE_PERMISSION
= 8
DOWNLOAD_PERMISSION
public
mixed
DOWNLOAD_PERMISSION
= 16
READ_PERMISSION
public
mixed
READ_PERMISSION
= 1
SET_CATEGORY_PERMISSION
public
mixed
SET_CATEGORY_PERMISSION
= 4
WRITE_PERMISSION
public
mixed
WRITE_PERMISSION
= 2
ALLOWED_TYPE
protected
mixed
ALLOWED_TYPE
= ['simple', 'related', 'dependent', 'track', 'routes']
$_id
protected
ObjectId
$_id
$areaField
protected
string|null
$areaField
= ''
$author
protected
array<string|int, mixed>|null
$author
= null
$authorField
protected
string|null
$authorField
= ''
$categories
protected
Categories
$categories
$categoryHistory
protected
bool
$categoryHistory
= false
$cluster
protected
ClusterDataSetEntity
$cluster
$connections
protected
array<string|int, mixed>
$connections
= []
$createDateField
protected
string|null
$createDateField
= ''
$dataSetStats
protected
array<string|int, mixed>
$dataSetStats
= ['usesCount' => ['day' => 0, 'week' => 0, 'month' => 0], 'size' => 0, 'author' => [], 'objectsCount' => 0]
$description
protected
string
$description
= ''
$editorField
protected
string|null
$editorField
= ''
$geocodingQueue
protected
array<string|int, mixed>
$geocodingQueue
= ['address', 'rosreestr', 'fias']
$isGeocoding
protected
bool
$isGeocoding
= false
$isIncrementUniqueValue
protected
bool|null
$isIncrementUniqueValue
= null
$lengthField
protected
string|null
$lengthField
= ''
$masterId
protected
ObjectId|null
$masterId
= null
$maxDistance
protected
float
$maxDistance
= 20100000
$maxUniqueValue
protected
int
$maxUniqueValue
= 0
$measure
protected
string
$measure
= self::ALLOWED_MEASURE[0]
$minEditorZoom
protected
int|null
$minEditorZoom
= null
$name
protected
string
$name
= 'undefined'
$objectExpireTime
protected
int
$objectExpireTime
= 0
$organizationId
protected
ObjectId
$organizationId
$possibleGeocoding
protected
array<string|int, mixed>
$possibleGeocoding
= ['addressField' => 'address', 'cadastreField' => 'cadastre', 'fiasField' => 'fias', 'additionInfoField' => 'additionInfo', 'additionInfoOnFirstLevel' => false, 'validation' => false, 'reverse' => false, 'reverseRosreestr' => false, 'geocodeOnAddressChange' => false]
$private
protected
bool
$private
= false
$protected
protected
bool
$protected
= false
$schemeId
protected
ObjectId|null
$schemeId
= null
$sendable
protected
bool
$sendable
= false
$smallDescription
protected
string
$smallDescription
= ''
$type
protected
string
$type
$uniqueField
protected
string|null
$uniqueField
= null
$updateDateField
protected
string|null
$updateDateField
= ''
$deleted
private
bool|null
$deleted
$displayObjectsLimit
private
int
$displayObjectsLimit
= 0
$findPolygonIntersections
private
bool
$findPolygonIntersections
= true
$linkingField
private
string|null
$linkingField
= null
$withRestrictions
private
bool
$withRestrictions
= true
__construct()
public
__construct(ObjectId $organizationId, ObjectId $masterId[, ObjectId|null $id = null ]) : mixed
Parameters
-
$organizationId
: ObjectId
-
-
$masterId
: ObjectId
-
-
$id
: ObjectId|null
= null
-
Return values
mixed
—
__toString()
public
__toString() : string
Return values
string
—
addConnection()
public
addConnection(ConnectionInterface $connection) : self
Parameters
-
$connection
: ConnectionInterface
-
Return values
self
—
bsonSerialize()
public
bsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
bsonUnserialize()
public
bsonUnserialize(array<string|int, mixed> $data) : void
Parameters
-
$data
: array<string|int, mixed>
-
Return values
void
—
checkAndSetMaxUniqueValue()
public
checkAndSetMaxUniqueValue(int $maxValue) : self
Parameters
-
$maxValue
: int
-
Return values
self
—
createFromArray()
public
static createFromArray(array<string|int, mixed> $data) : DataSetEntity
Parameters
-
$data
: array<string|int, mixed>
-
Return values
DataSetEntity
—
getAreaField()
public
getAreaField() : string|null
Return values
string|null
—
getAuthor()
public
getAuthor() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null
—
getAuthorField()
public
getAuthorField() : string|null
Return values
string|null
—
getCategories()
public
getCategories() : Categories
Return values
Categories
—
getCategoryHistory()
public
getCategoryHistory() : bool
Return values
bool
—
getCluster()
public
getCluster() : ClusterDataSetEntity
Return values
ClusterDataSetEntity
—
getConnections()
public
getConnections([string|null $type = null ]) : array<string|int, ConnectionInterface>
Parameters
-
$type
: string|null
= null
-
Return values
array<string|int, ConnectionInterface>
—
getCreateDateField()
public
getCreateDateField() : string|null
Return values
string|null
—
getDataSetStats()
public
getDataSetStats() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getDeleted()
public
getDeleted() : bool|null
Return values
bool|null
—
getDescription()
public
getDescription() : string
Return values
string
—
getDisplayObjectsLimit()
public
getDisplayObjectsLimit() : int
Return values
int
—
getEditorField()
public
getEditorField() : string|null
Return values
string|null
—
getGeocodingQueue()
public
getGeocodingQueue() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getId()
public
getId() : ObjectId
Return values
ObjectId
—
getIsIncrementUniqueValue()
public
getIsIncrementUniqueValue() : bool
Return values
bool
—
getLengthField()
public
getLengthField() : string|null
Return values
string|null
—
getLinkingField()
public
getLinkingField() : string|null
Return values
string|null
—
getMasterId()
public
getMasterId() : ObjectId
Return values
ObjectId
—
getMaxDistance()
public
getMaxDistance() : float
Return values
float
—
getMaxUniqueValue()
public
getMaxUniqueValue() : int
Return values
int
—
getMeasure()
public
getMeasure() : string
Return values
string
—
getMinEditorZoom()
public
getMinEditorZoom() : int|null
Return values
int|null
—
getName()
public
getName() : string
Return values
string
—
getObjectExpireTime()
public
getObjectExpireTime() : int
Return values
int
—
getOrganizationId()
public
getOrganizationId() : ObjectId
Return values
ObjectId
—
getPossibleGeocoding()
public
getPossibleGeocoding() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getSchemeId()
public
getSchemeId() : ObjectId|null
Return values
ObjectId|null
—
getSmallDescription()
public
getSmallDescription() : string
Return values
string
—
getType()
public
getType() : string
Return values
string
—
getUniqueField()
public
getUniqueField() : string|null
Return values
string|null
—
getUpdateDateField()
public
getUpdateDateField() : string|null
Return values
string|null
—
incAndGetMaxNumberUniqueValue()
public
incAndGetMaxNumberUniqueValue() : int
Return values
int
—
isFindPolygonIntersections()
public
isFindPolygonIntersections() : bool
Return values
bool
—
isGeocoding()
public
isGeocoding() : bool
Return values
bool
—
isPrivate()
public
isPrivate() : bool
Return values
bool
—
isProtected()
public
isProtected() : bool
Return values
bool
—
isSendable()
public
isSendable() : bool
Return values
bool
—
isWithRestrictions()
public
isWithRestrictions() : bool
Return values
bool
—
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
markAsDeleted()
public
markAsDeleted() : self
Return values
self
—
parseObjectId()
public
static parseObjectId(mixed $objectId) : ObjectId|null
Parameters
-
$objectId
: mixed
-
Return values
ObjectId|null
—
removeMaster()
public
removeMaster(ObjectId $masterId) : self
Parameters
-
$masterId
: ObjectId
-
Return values
self
—
setAreaField()
public
setAreaField(string $areaField) : self
Parameters
-
$areaField
: string
-
Return values
self
—
setAuthor()
public
setAuthor(UserEntity|array<string|int, mixed> $user) : self
Parameters
-
$user
: UserEntity|array<string|int, mixed>
-
Return values
self
—
setAuthorField()
public
setAuthorField(string|null $authorField) : self
Parameters
-
$authorField
: string|null
-
Return values
self
—
setCategories()
public
setCategories(Categories $category) : self
Parameters
-
$category
: Categories
-
Return values
self
—
setCategoryHistory()
public
setCategoryHistory(bool $categoryHistory) : self
Parameters
-
$categoryHistory
: bool
-
Return values
self
—
setCluster()
public
setCluster(ClusterDataSetEntity $cluster) : self
Parameters
-
$cluster
: ClusterDataSetEntity
-
Return values
self
—
setConnections()
public
setConnections(array<string|int, mixed> $connections) : self
Parameters
-
$connections
: array<string|int, mixed>
-
Return values
self
—
setCreateDateField()
public
setCreateDateField(string|null $createDateField) : self
Parameters
-
$createDateField
: string|null
-
Return values
self
—
setDataSetStats()
public
setDataSetStats(array<string|int, mixed> $dataSetStats) : self
Parameters
-
$dataSetStats
: array<string|int, mixed>
-
Return values
self
—
setDeleted()
public
setDeleted(bool|null $deleted) : DataSetEntity
Parameters
-
$deleted
: bool|null
-
Return values
DataSetEntity
—
setDescription()
public
setDescription(string $description) : self
Parameters
-
$description
: string
-
Return values
self
—
setDisplayObjectsLimit()
public
setDisplayObjectsLimit(int $displayObjectsLimit) : self
Parameters
-
$displayObjectsLimit
: int
-
Return values
self
—
setEditorField()
public
setEditorField(string|null $editorField) : self
Parameters
-
$editorField
: string|null
-
Return values
self
—
setFindPolygonIntersections()
public
setFindPolygonIntersections(bool $findPolygonIntersections) : self
Parameters
-
$findPolygonIntersections
: bool
-
Return values
self
—
setGeocodingQueue()
public
setGeocodingQueue(array<string|int, mixed> $geocodingQueue) : self
Parameters
-
$geocodingQueue
: array<string|int, mixed>
-
Return values
self
—
setId()
public
setId(ObjectId $id) : self
Parameters
-
$id
: ObjectId
-
Return values
self
—
setIsGeocoding()
public
setIsGeocoding(bool $isGeocoding) : self
Parameters
-
$isGeocoding
: bool
-
Return values
self
—
setIsIncrementUniqueValue()
public
setIsIncrementUniqueValue(bool $isIncrementUniqueValue) : self
Parameters
-
$isIncrementUniqueValue
: bool
-
Return values
self
—
setLengthField()
public
setLengthField(string $lengthField) : self
Parameters
-
$lengthField
: string
-
Return values
self
—
setLinkingField()
public
setLinkingField(string|null $fieldName) : self
Parameters
-
$fieldName
: string|null
-
Return values
self
—
setMasterId()
public
setMasterId(ObjectId $masterId) : self
Parameters
-
$masterId
: ObjectId
-
Return values
self
—
setMaxDistance()
public
setMaxDistance(float $distance) : self
Parameters
-
$distance
: float
-
Return values
self
—
setMaxUniqueValue()
public
setMaxUniqueValue(int $maxValue) : self
Parameters
-
$maxValue
: int
-
Return values
self
—
setMeasure()
public
setMeasure(string $measure) : self
Parameters
-
$measure
: string
-
Return values
self
—
setMinEditorZoom()
public
setMinEditorZoom(int $minEditorZoom) : self
Parameters
-
$minEditorZoom
: int
-
Return values
self
—
setName()
public
setName(string $name) : self
Parameters
-
$name
: string
-
Return values
self
—
setObjectExpireTime()
public
setObjectExpireTime(int $objectExpireTime) : self
Parameters
-
$objectExpireTime
: int
-
Return values
self
—
setOrganizationId()
public
setOrganizationId(ObjectId $organizationId) : self
Parameters
-
$organizationId
: ObjectId
-
Return values
self
—
setPossibleGeocoding()
public
setPossibleGeocoding(array<string|int, mixed> $geocoding) : self
Parameters
-
$geocoding
: array<string|int, mixed>
-
Return values
self
—
setPrivate()
public
setPrivate(bool $private) : DataSetEntity
Parameters
-
$private
: bool
-
Return values
DataSetEntity
—
setProtected()
public
setProtected(bool $protected) : self
Parameters
-
$protected
: bool
-
Return values
self
—
setSchemeId()
public
setSchemeId(ObjectId|null $schemeId) : self
Parameters
-
$schemeId
: ObjectId|null
-
Return values
self
—
setSendable()
public
setSendable(bool $send) : DataSetEntity
Parameters
-
$send
: bool
-
Return values
DataSetEntity
—
setSmallDescription()
public
setSmallDescription(string $smallDescription) : self
Parameters
-
$smallDescription
: string
-
Return values
self
—
setUniqueField()
public
setUniqueField(string $uniqueField) : self
Parameters
-
$uniqueField
: string
-
Return values
self
—
setUpdateDateField()
public
setUpdateDateField(string $updateDateField) : self
Parameters
-
$updateDateField
: string
-
Return values
self
—
setWithRestrictions()
public
setWithRestrictions(bool $withRestrictions) : self
Parameters
-
$withRestrictions
: bool
-
Return values
self
—
toArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
—