Table of Contents
-
AVAILABLE_GEOMETRY_TYPE
= ['Point', 'MultiPoint', 'LineString', 'MultiLineString', 'Polygon', 'MultiPolygon', 'GeometryCollection']
-
$_id
: ObjectId
-
$geometryType
: string
-
$members
: array<string|int, mixed>
-
$nodes
: array<string|int, mixed>
-
$properties
: stdClass
-
$systemProperties
: stdClass
-
$type
: string
-
__construct()
: mixed
-
__toString()
: string
-
addAirlayErrorToProperty()
: self
-
addAirlayWarningToProperty()
: self
-
bsonSerialize()
: array<string|int, mixed>
-
bsonUnSerialize()
: void
-
createFromArray()
: RelationEntity
-
deleteAirlayErrorsFromProperties()
: void
-
deleteAirlayWarningsFromProperties()
: void
-
deleteAllMembers()
: void
-
deleteMember()
: self
-
deleteProperty()
: self
-
deleteSystemProperty()
: void
-
deleteValidationErrors()
: void
-
findMember()
: mixed
-
getBarycenter()
: null|ObjectId|array<string|int, mixed>
-
getCategory()
: ObjectId|null
-
getGeometryType()
: string
-
getHasFeature()
: bool
-
getId()
: ObjectId
-
getInfoForError()
: array<string|int, mixed>
-
getMemberIndex()
: int|false
-
getMembers()
: array<string|int, mixed>
-
getNodes()
: array<string|int, \MongoDB\BSON\ObjectId|\MongoDB\BSON\ObjectId[]>
-
getOptions()
: array<string|int, mixed>|null
-
getProperties()
: array<string|int, mixed>
-
getProperty()
: mixed
-
getPropertyByPath()
: mixed
-
getSystemProperties()
: array<string|int, mixed>
-
getSystemProperty()
: mixed
-
hasGeometryError()
: bool
-
insertMember()
: self
-
insertMembers()
: self
-
isDeleted()
: bool
-
jsonSerialize()
: array<string|int, mixed>
-
markAsDeleted()
: self
-
parseObjectId()
: ObjectId|null
-
replaceMembers()
: $this
-
setBarycenter()
: self
-
setCategory()
: self
-
setGeometryType()
: self
-
setHasFeature()
: self
-
setId()
: self
-
setMembers()
: self
-
setNodes()
: $this
-
setOptions()
: self
-
setProperties()
: self
-
setProperty()
: self
-
setSystemProperties()
: self
-
setSystemProperty()
: self
-
toArray()
: array<string|int, mixed>
-
unsetBarycenter()
: self
-
getPropertyLikeMongo()
: mixed
-
setPropertyLikeMongo()
: array<string|int, mixed>|mixed
AVAILABLE_GEOMETRY_TYPE
private
mixed
AVAILABLE_GEOMETRY_TYPE
= ['Point', 'MultiPoint', 'LineString', 'MultiLineString', 'Polygon', 'MultiPolygon', 'GeometryCollection']
$_id
protected
ObjectId
$_id
$geometryType
private
string
$geometryType
= 'Point'
$members
private
array<string|int, mixed>
$members
= []
$nodes
private
array<string|int, mixed>
$nodes
= []
$properties
private
stdClass
$properties
$systemProperties
private
stdClass
$systemProperties
$type
private
string
$type
= 'geometry'
__construct()
public
__construct([ObjectId|null $id = null ]) : mixed
Parameters
-
$id
: ObjectId|null
= null
-
Return values
mixed
—
__toString()
public
__toString() : string
Return values
string
—
addAirlayErrorToProperty()
public
addAirlayErrorToProperty(ErrorInterface $error) : self
Parameters
-
$error
: ErrorInterface
-
Return values
self
—
addAirlayWarningToProperty()
public
addAirlayWarningToProperty(AirlayError $error) : self
Parameters
-
$error
: AirlayError
-
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
—
createFromArray()
public
static createFromArray(array<string|int, mixed> $relationArray) : RelationEntity
Parameters
-
$relationArray
: array<string|int, mixed>
-
Return values
RelationEntity
—
deleteAirlayErrorsFromProperties()
public
deleteAirlayErrorsFromProperties() : void
Return values
void
—
deleteAirlayWarningsFromProperties()
public
deleteAirlayWarningsFromProperties() : void
Return values
void
—
deleteAllMembers()
public
deleteAllMembers() : void
Return values
void
—
deleteMember()
public
deleteMember(ObjectId $id) : self
Parameters
-
$id
: ObjectId
-
Return values
self
—
deleteProperty()
public
deleteProperty(string $key) : self
Parameters
-
$key
: string
-
Return values
self
—
deleteSystemProperty()
public
deleteSystemProperty(string $key) : void
Parameters
-
$key
: string
-
Return values
void
—
deleteValidationErrors()
public
deleteValidationErrors() : void
Return values
void
—
findMember()
public
findMember(ObjectId $id) : mixed
Parameters
-
$id
: ObjectId
-
Return values
mixed
—
getBarycenter()
public
getBarycenter() : null|ObjectId|array<string|int, mixed>
Return values
null|ObjectId|array<string|int, mixed>
—
getCategory()
public
getCategory() : ObjectId|null
Return values
ObjectId|null
—
getGeometryType()
public
getGeometryType() : string
Return values
string
—
getHasFeature()
public
getHasFeature() : bool
Return values
bool
—
getId()
public
getId() : ObjectId
Return values
ObjectId
—
getInfoForError()
public
getInfoForError() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getMemberIndex()
public
getMemberIndex(ObjectId $memberId) : int|false
Parameters
-
$memberId
: ObjectId
-
Return values
int|false
—
getMembers()
public
getMembers() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getNodes()
public
getNodes() : array<string|int, \MongoDB\BSON\ObjectId|\MongoDB\BSON\ObjectId[]>
Return values
array<string|int, \MongoDB\BSON\ObjectId|\MongoDB\BSON\ObjectId[]>
—
getOptions()
public
getOptions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null
—
getProperties()
public
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getProperty()
public
getProperty(string $key) : mixed
Parameters
-
$key
: string
-
Return values
mixed
—
getPropertyByPath()
public
getPropertyByPath(string $path) : mixed
Parameters
-
$path
: string
-
Return values
mixed
—
getSystemProperties()
public
getSystemProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
getSystemProperty()
public
getSystemProperty(string $key) : mixed
Parameters
-
$key
: string
-
Return values
mixed
—
hasGeometryError()
public
hasGeometryError() : bool
Return values
bool
—
insertMember()
public
insertMember(array<string|int, mixed> $member[, int|null $index = null ]) : self
Parameters
-
$member
: array<string|int, mixed>
-
-
$index
: int|null
= null
-
Return values
self
—
insertMembers()
public
insertMembers(array<string|int, mixed> $members) : self
Parameters
-
$members
: array<string|int, mixed>
-
Return values
self
—
isDeleted()
public
isDeleted() : 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
—
replaceMembers()
public
replaceMembers(array<string|int, ObjectId> $oldMembersIds, array<string|int, ObjectId> $newMembersIds, string $type) : $this
Parameters
-
$oldMembersIds
: array<string|int, ObjectId>
-
-
$newMembersIds
: array<string|int, ObjectId>
-
-
$type
: string
-
Return values
$this
—
setBarycenter()
public
setBarycenter(ObjectId|array<string|int, mixed> $nodeId) : self
Parameters
-
$nodeId
: ObjectId|array<string|int, mixed>
-
Return values
self
—
setCategory()
public
setCategory(ObjectId $categoryId) : self
Parameters
-
$categoryId
: ObjectId
-
Return values
self
—
setGeometryType()
public
setGeometryType(string $geometryType) : self
Parameters
-
$geometryType
: string
-
Return values
self
—
setHasFeature()
public
setHasFeature(bool $hasFeature) : self
Parameters
-
$hasFeature
: bool
-
Return values
self
—
setId()
public
setId(ObjectId $id) : self
Parameters
-
$id
: ObjectId
-
Return values
self
—
setMembers()
public
setMembers(array<string|int, mixed> $members) : self
Parameters
-
$members
: array<string|int, mixed>
-
Return values
self
—
setNodes()
public
setNodes(array<string|int, \MongoDB\BSON\ObjectId|\MongoDB\BSON\ObjectId[]> $nodes) : $this
Parameters
-
$nodes
: array<string|int, \MongoDB\BSON\ObjectId|\MongoDB\BSON\ObjectId[]>
-
Return values
$this
—
setOptions()
public
setOptions(array<string|int, mixed> $options) : self
Parameters
-
$options
: array<string|int, mixed>
-
Return values
self
—
setProperties()
public
setProperties(array<string|int, mixed> $properties) : self
Parameters
-
$properties
: array<string|int, mixed>
-
Return values
self
—
setProperty()
public
setProperty(string $key, mixed $value) : self
Parameters
-
$key
: string
-
-
$value
: mixed
-
Return values
self
—
setSystemProperties()
public
setSystemProperties(array<string|int, mixed> $systemProperties) : self
Parameters
-
$systemProperties
: array<string|int, mixed>
-
Return values
self
—
setSystemProperty()
public
setSystemProperty(string $key, mixed $value) : self
Parameters
-
$key
: string
-
-
$value
: mixed
-
Return values
self
—
toArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
—
unsetBarycenter()
public
unsetBarycenter() : self
Return values
self
—
getPropertyLikeMongo()
private
getPropertyLikeMongo(mixed $properties, array<string|int, mixed> $path) : mixed
Parameters
-
$properties
: mixed
-
-
$path
: array<string|int, mixed>
-
Return values
mixed
—
setPropertyLikeMongo()
private
static setPropertyLikeMongo(array<string|int, mixed>|object $properties, array<string|int, mixed> $path, mixed $value) : array<string|int, mixed>|mixed
Parameters
-
$properties
: array<string|int, mixed>|object
-
-
$path
: array<string|int, mixed>
-
-
$value
: mixed
-
Return values
array<string|int, mixed>|mixed
—