A collection object or null if the index was not set to an collection yet
+A collection object or null if the index was not set to a collection yet
True for new one index. False for a existing index.
+True for new one index. False for an existing index.
Represents an edge index on a collection
- +Index Id.
+Index ID.
@@ -884,9 +890,9 @@
EdgeIndex constructor.
@@ -1037,7 +1043,7 @@
-
This type of Index cannot be create/deleted explicitly by user.
+ This type of Index cannot be created/deleted explicitly by user.
public
@@ -1489,7 +1495,7 @@
-
Returns a array representation of entity
+ Returns an array representation of entity
public
diff --git a/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html b/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html
index f3fc536..cda27aa 100644
--- a/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html
@@ -268,14 +268,20 @@
Represents a fulltext index
-
+
+
+
+
+
+
+
@@ -338,7 +344,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -500,7 +506,7 @@
: array<string|int, mixed>
-Returns a array representation of index
+Returns an array representation of index
@@ -617,7 +623,7 @@
-
Index Id.
+ Index ID.
@@ -733,9 +739,9 @@
Minimum length of index
@@ -938,9 +944,9 @@
FullTextIndex constructor.
@@ -1097,9 +1103,9 @@
Return data for create index on server
@@ -1217,9 +1223,9 @@
Return index minimum length
@@ -1572,12 +1578,12 @@
-
Returns a array representation of index
+ Returns an array representation of index
public
diff --git a/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html b/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html
index cd2ab87..9997670 100644
--- a/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html
@@ -273,7 +273,7 @@
-
Represents a geo-spatial index on a collection
+ Represents a geospatial index on a collection
@@ -338,7 +338,7 @@
: bool
-If a geo-spatial index on a location is constructed
+If a geospatial index on a location is constructed
and geoJson is true, then the order within the array is longitude
followed by latitude.
@@ -347,7 +347,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -502,7 +502,7 @@
: array<string|int, mixed>
-Returns a array representation of index
+Returns an array representation of index
@@ -619,7 +619,7 @@
-
If a geo-spatial index on a location is constructed
+
If a geospatial index on a location is constructed
and geoJson is true, then the order within the array is longitude
followed by latitude.
@@ -675,7 +675,7 @@
-
Index Id.
+ Index ID.
@@ -1593,7 +1593,7 @@
-
Returns a array representation of index
+ Returns an array representation of index
public
diff --git a/docs/classes/ArangoDB-Collection-Index-HashIndex.html b/docs/classes/ArangoDB-Collection-Index-HashIndex.html
index fe7c171..c3fa900 100644
--- a/docs/classes/ArangoDB-Collection-Index-HashIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-HashIndex.html
@@ -356,7 +356,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -708,7 +708,7 @@
-
Index Id.
+ Index ID.
diff --git a/docs/classes/ArangoDB-Collection-Index-Index.html b/docs/classes/ArangoDB-Collection-Index-Index.html
index 98925a6..853e5fa 100644
--- a/docs/classes/ArangoDB-Collection-Index-Index.html
+++ b/docs/classes/ArangoDB-Collection-Index-Index.html
@@ -342,7 +342,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -490,7 +490,7 @@
: array<string|int, mixed>
-Returns a array representation of entity
+Returns an array representation of entity
@@ -607,7 +607,7 @@
-
Index Id.
+ Index ID.
@@ -1487,7 +1487,7 @@
-
Returns a array representation of entity
+ Returns an array representation of entity
public
diff --git a/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html b/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html
index 95f60d5..9ff60e8 100644
--- a/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html
@@ -345,7 +345,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -493,7 +493,7 @@
: array<string|int, mixed>
-Returns a array representation of entity
+Returns an array representation of entity
@@ -657,7 +657,7 @@
-
Index Id.
+ Index ID.
@@ -1530,7 +1530,7 @@
-
Returns a array representation of entity
+ Returns an array representation of entity
public
diff --git a/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html b/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html
index ec4fb76..bac95ba 100644
--- a/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html
@@ -345,7 +345,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -493,7 +493,7 @@
: array<string|int, mixed>
-Returns a array representation of entity
+Returns an array representation of entity
@@ -650,7 +650,7 @@
-
Index Id.
+ Index ID.
@@ -1519,7 +1519,7 @@
-
Returns a array representation of entity
+ Returns an array representation of entity
public
diff --git a/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html b/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html
index 49cedab..fcdfd81 100644
--- a/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html
@@ -336,7 +336,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -415,7 +415,7 @@
: array<string|int, mixed>
-This type of Index cannot be create/deleted explicitly by user.
+This type of Index cannot be created/deleted explicitly by user.
getFields()
@@ -484,7 +484,7 @@
: array<string|int, mixed>
-Returns a array representation of entity
+Returns an array representation of entity
@@ -601,7 +601,7 @@
-
Index Id.
+ Index ID.
@@ -1035,7 +1035,7 @@
-
This type of Index cannot be create/deleted explicitly by user.
+ This type of Index cannot be created/deleted explicitly by user.
public
@@ -1487,7 +1487,7 @@
-
Returns a array representation of entity
+ Returns an array representation of entity
public
diff --git a/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html b/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html
index 8ae2163..d3b7c4e 100644
--- a/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html
@@ -358,7 +358,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -710,7 +710,7 @@
-
Index Id.
+ Index ID.
diff --git a/docs/classes/ArangoDB-Collection-Index-TTLIndex.html b/docs/classes/ArangoDB-Collection-Index-TTLIndex.html
index 6c5a562..a45cec5 100644
--- a/docs/classes/ArangoDB-Collection-Index-TTLIndex.html
+++ b/docs/classes/ArangoDB-Collection-Index-TTLIndex.html
@@ -331,7 +331,7 @@
: int
-Time (in seconds) after a document's creation after which the documents counts as expired
+Time (in seconds) after a document's creation after which the documents count as expired
$fields
@@ -345,7 +345,7 @@
: string
-Index Id.
+Index ID.
$indexTypes
@@ -500,7 +500,7 @@
: array<string|int, mixed>
-Returns a array representation of index
+Returns an array representation of index
@@ -577,7 +577,7 @@
-
Time (in seconds) after a document's creation after which the documents counts as expired
+ Time (in seconds) after a document's creation after which the documents count as expired
@@ -657,7 +657,7 @@
-
Index Id.
+ Index ID.
@@ -1577,7 +1577,7 @@
-
Returns a array representation of index
+ Returns an array representation of index
public
diff --git a/docs/files/src-collection-index-geospatialindex.html b/docs/files/src-collection-index-geospatialindex.html
index 469c3d7..b9cc93e 100644
--- a/docs/files/src-collection-index-geospatialindex.html
+++ b/docs/files/src-collection-index-geospatialindex.html
@@ -260,7 +260,7 @@
- - GeoSpatialIndex
- Represents a geo-spatial index on a collection
+ GeoSpatialIndex Represents a geospatial index on a collection
diff --git a/docs/files/src/Collection/Collection.php.txt b/docs/files/src/Collection/Collection.php.txt
index 6bb0ae4..ff0c636 100644
--- a/docs/files/src/Collection/Collection.php.txt
+++ b/docs/files/src/Collection/Collection.php.txt
@@ -501,7 +501,7 @@ class Collection implements JsonSerializable
*
* @throws DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException
*/
- public function findByKey(string $key, bool $isVertex = false)
+ public function findByKey(string $key, bool $isVertex = false): Document|false
{
try {
$uri = Api::buildDatabaseUri($this->connection->getBaseUri(), $this->connection->getDatabaseName(), Api::DOCUMENT);
diff --git a/docs/files/src/Collection/Contracts/IndexInterface.php.txt b/docs/files/src/Collection/Contracts/IndexInterface.php.txt
index 3bdd2af..44ffeac 100644
--- a/docs/files/src/Collection/Contracts/IndexInterface.php.txt
+++ b/docs/files/src/Collection/Contracts/IndexInterface.php.txt
@@ -17,7 +17,7 @@ interface IndexInterface extends \JsonSerializable
/**
* If the index is a new one
*
- * @return bool True for new one index. False for a existing index.
+ * @return bool True for new one index. False for an existing index.
*/
public function isNew(): bool;
@@ -66,7 +66,7 @@ interface IndexInterface extends \JsonSerializable
/**
* Returns the collection where the index belongs to
*
- * @return Collection|null A collection object or null if the index was not set to an collection yet
+ * @return Collection|null A collection object or null if the index was not set to a collection yet
*/
public function getCollection();
}
diff --git a/docs/files/src/Collection/Index/EdgeIndex.php.txt b/docs/files/src/Collection/Index/EdgeIndex.php.txt
index a24d892..3fa68a4 100644
--- a/docs/files/src/Collection/Index/EdgeIndex.php.txt
+++ b/docs/files/src/Collection/Index/EdgeIndex.php.txt
@@ -11,6 +11,7 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException;
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
+ * @deprecated
*/
final class EdgeIndex extends PrimaryIndex
{
diff --git a/docs/files/src/Collection/Index/FullTextIndex.php.txt b/docs/files/src/Collection/Index/FullTextIndex.php.txt
index d1fd3c1..694b236 100644
--- a/docs/files/src/Collection/Index/FullTextIndex.php.txt
+++ b/docs/files/src/Collection/Index/FullTextIndex.php.txt
@@ -11,6 +11,7 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException;
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
+ * @deprecated
*/
final class FullTextIndex extends Index
{
@@ -19,7 +20,7 @@ final class FullTextIndex extends Index
*
* @var int
*/
- protected $minLength;
+ protected int $minLength;
/**
* FullTextIndex constructor.
@@ -66,7 +67,7 @@ final class FullTextIndex extends Index
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/
diff --git a/docs/files/src/Collection/Index/GeoSpatialIndex.php.txt b/docs/files/src/Collection/Index/GeoSpatialIndex.php.txt
index c844391..e6a8b9e 100644
--- a/docs/files/src/Collection/Index/GeoSpatialIndex.php.txt
+++ b/docs/files/src/Collection/Index/GeoSpatialIndex.php.txt
@@ -7,7 +7,7 @@ namespace ArangoDB\Collection\Index;
use ArangoDB\Validation\Exceptions\InvalidParameterException;
/**
- * Represents a geo-spatial index on a collection
+ * Represents a geospatial index on a collection
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
@@ -15,14 +15,14 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException;
final class GeoSpatialIndex extends Index
{
/**
- * If a geo-spatial index on a location is constructed
+ * If a geospatial index on a location is constructed
* and geoJson is true, then the order within the array is longitude
* followed by latitude.
*
* @link https://geojson.org/geojson-spec.html#positions
* @var bool
*/
- protected $geoJson;
+ protected bool $geoJson;
/**
* GeoSpatialIndex constructor.
@@ -64,7 +64,7 @@ final class GeoSpatialIndex extends Index
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/
diff --git a/docs/files/src/Collection/Index/Index.php.txt b/docs/files/src/Collection/Index/Index.php.txt
index 0e0fec1..2bc3132 100644
--- a/docs/files/src/Collection/Index/Index.php.txt
+++ b/docs/files/src/Collection/Index/Index.php.txt
@@ -17,7 +17,7 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException;
class Index implements IndexInterface
{
/**
- * Index Id.
+ * Index ID.
*
* @var string
*/
@@ -223,7 +223,7 @@ class Index implements IndexInterface
}
/**
- * Returns a array representation of entity
+ * Returns an array representation of entity
*
* @return array
*/
diff --git a/docs/files/src/Collection/Index/PersistentIndex.php.txt b/docs/files/src/Collection/Index/PersistentIndex.php.txt
index fc7c5c3..d9515a9 100644
--- a/docs/files/src/Collection/Index/PersistentIndex.php.txt
+++ b/docs/files/src/Collection/Index/PersistentIndex.php.txt
@@ -19,7 +19,7 @@ final class PersistentIndex extends Index
*
* @var array
*/
- protected $defaultsOptions = [
+ protected array $defaultsOptions = [
'unique' => true,
'sparse' => true,
];
diff --git a/docs/files/src/Collection/Index/PrimaryIndex.php.txt b/docs/files/src/Collection/Index/PrimaryIndex.php.txt
index 025c74b..3b9c7ab 100644
--- a/docs/files/src/Collection/Index/PrimaryIndex.php.txt
+++ b/docs/files/src/Collection/Index/PrimaryIndex.php.txt
@@ -28,7 +28,7 @@ class PrimaryIndex extends Index
}
/**
- * This type of Index cannot be create/deleted explicitly by user.
+ * This type of Index cannot be created/deleted explicitly by user.
* Throws an exception if an attempt of create one is made
*
* @return array
diff --git a/docs/files/src/Collection/Index/TTLIndex.php.txt b/docs/files/src/Collection/Index/TTLIndex.php.txt
index fb0a3bb..5ced972 100644
--- a/docs/files/src/Collection/Index/TTLIndex.php.txt
+++ b/docs/files/src/Collection/Index/TTLIndex.php.txt
@@ -15,11 +15,11 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException;
final class TTLIndex extends Index
{
/**
- * Time (in seconds) after a document's creation after which the documents counts as expired
+ * Time (in seconds) after a document's creation after which the documents count as expired
*
* @var int
*/
- protected $expiresAfter;
+ protected int $expiresAfter;
/**
* TTLIndex constructor.
@@ -61,7 +61,7 @@ final class TTLIndex extends Index
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/
diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js
index fc63acd..68bfbd0 100644
--- a/docs/js/searchIndex.js
+++ b/docs/js/searchIndex.js
@@ -938,7 +938,7 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003AtoArray\u0028\u0029",
"name": "toArray",
- "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index",
+ "summary": "Returns\u0020an\u0020array\u0020representation\u0020of\u0020index",
"url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#method_toArray"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003A\u0024minLength",
@@ -948,7 +948,7 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex",
"name": "GeoSpatialIndex",
- "summary": "Represents\u0020a\u0020geo\u002Dspatial\u0020index\u0020on\u0020a\u0020collection",
+ "summary": "Represents\u0020a\u0020geospatial\u0020index\u0020on\u0020a\u0020collection",
"url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003A__construct\u0028\u0029",
@@ -968,12 +968,12 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003AtoArray\u0028\u0029",
"name": "toArray",
- "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index",
+ "summary": "Returns\u0020an\u0020array\u0020representation\u0020of\u0020index",
"url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#method_toArray"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003A\u0024geoJson",
"name": "geoJson",
- "summary": "If\u0020a\u0020geo\u002Dspatial\u0020index\u0020on\u0020a\u0020location\u0020is\u0020constructed\nand\u0020geoJson\u0020is\u0020true,\u0020then\u0020the\u0020order\u0020within\u0020the\u0020array\u0020is\u0020longitude\nfollowed\u0020by\u0020latitude.",
+ "summary": "If\u0020a\u0020geospatial\u0020index\u0020on\u0020a\u0020location\u0020is\u0020constructed\nand\u0020geoJson\u0020is\u0020true,\u0020then\u0020the\u0020order\u0020within\u0020the\u0020array\u0020is\u0020longitude\nfollowed\u0020by\u0020latitude.",
"url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#property_geoJson"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex",
@@ -1073,7 +1073,7 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AtoArray\u0028\u0029",
"name": "toArray",
- "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020entity",
+ "summary": "Returns\u0020an\u0020array\u0020representation\u0020of\u0020entity",
"url": "classes/ArangoDB-Collection-Index-Index.html#method_toArray"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetCreateData\u0028\u0029",
@@ -1088,7 +1088,7 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024id",
"name": "id",
- "summary": "Index\u0020Id.",
+ "summary": "Index\u0020ID.",
"url": "classes/ArangoDB-Collection-Index-Index.html#property_id"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024name",
@@ -1173,7 +1173,7 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\PrimaryIndex\u003A\u003AgetCreateData\u0028\u0029",
"name": "getCreateData",
- "summary": "This\u0020type\u0020of\u0020Index\u0020cannot\u0020be\u0020create\/deleted\u0020explicitly\u0020by\u0020user.",
+ "summary": "This\u0020type\u0020of\u0020Index\u0020cannot\u0020be\u0020created\/deleted\u0020explicitly\u0020by\u0020user.",
"url": "classes/ArangoDB-Collection-Index-PrimaryIndex.html#method_getCreateData"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\SkipListIndex",
@@ -1208,12 +1208,12 @@ Search.appendIndex(
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003AtoArray\u0028\u0029",
"name": "toArray",
- "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index",
+ "summary": "Returns\u0020an\u0020array\u0020representation\u0020of\u0020index",
"url": "classes/ArangoDB-Collection-Index-TTLIndex.html#method_toArray"
}, {
"fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003A\u0024expiresAfter",
"name": "expiresAfter",
- "summary": "Time\u0020\u0028in\u0020seconds\u0029\u0020after\u0020a\u0020document\u0027s\u0020creation\u0020after\u0020which\u0020the\u0020documents\u0020counts\u0020as\u0020expired",
+ "summary": "Time\u0020\u0028in\u0020seconds\u0029\u0020after\u0020a\u0020document\u0027s\u0020creation\u0020after\u0020which\u0020the\u0020documents\u0020count\u0020as\u0020expired",
"url": "classes/ArangoDB-Collection-Index-TTLIndex.html#property_expiresAfter"
}, {
"fqsen": "\\ArangoDB\\Collection\\IndexableTrait",
diff --git a/docs/namespaces/arangodb-collection-index.html b/docs/namespaces/arangodb-collection-index.html
index 1fd74f1..c5ed39f 100644
--- a/docs/namespaces/arangodb-collection-index.html
+++ b/docs/namespaces/arangodb-collection-index.html
@@ -256,7 +256,7 @@
- - EdgeIndex
- Represents an edge index on a collection
- Factory
- Index Factory class
- FullTextIndex
- Represents a fulltext index
- GeoSpatialIndex
- Represents a geo-spatial index on a collection
- HashIndex
- Represents a hash index on a collection
- Index
- Represents a collection index.
- InvertedIndex
- Inverted index representation
- PersistentIndex
- Represents a persistent index on a collection
- PrimaryIndex
- Represents a primary index on a collection
- SkipListIndex
- Represents a skip-list index on a collection
- TTLIndex
- Represents a TTL index on a collection
+ EdgeIndex Represents an edge index on a collection Factory Index Factory class FullTextIndex Represents a fulltext index GeoSpatialIndex Represents a geospatial index on a collection HashIndex Represents a hash index on a collection Index Represents a collection index. InvertedIndex Inverted index representation PersistentIndex Represents a persistent index on a collection PrimaryIndex Represents a primary index on a collection SkipListIndex Represents a skip-list index on a collection TTLIndex Represents a TTL index on a collection
diff --git a/docs/packages/ArangoDB-Collection-Index.html b/docs/packages/ArangoDB-Collection-Index.html
index e276dac..6daa5ea 100644
--- a/docs/packages/ArangoDB-Collection-Index.html
+++ b/docs/packages/ArangoDB-Collection-Index.html
@@ -256,7 +256,7 @@
- - EdgeIndex
- Represents an edge index on a collection
- Factory
- Index Factory class
- FullTextIndex
- Represents a fulltext index
- GeoSpatialIndex
- Represents a geo-spatial index on a collection
- HashIndex
- Represents a hash index on a collection
- InvertedIndex
- Inverted index representation
- PersistentIndex
- Represents a persistent index on a collection
- PrimaryIndex
- Represents a primary index on a collection
- SkipListIndex
- Represents a skip-list index on a collection
- TTLIndex
- Represents a TTL index on a collection
+ EdgeIndex Represents an edge index on a collection Factory Index Factory class FullTextIndex Represents a fulltext index GeoSpatialIndex Represents a geospatial index on a collection HashIndex Represents a hash index on a collection InvertedIndex Inverted index representation PersistentIndex Represents a persistent index on a collection PrimaryIndex Represents a primary index on a collection SkipListIndex Represents a skip-list index on a collection TTLIndex Represents a TTL index on a collection
diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html
index 0093116..1ec6027 100644
--- a/docs/reports/deprecated.html
+++ b/docs/reports/deprecated.html
@@ -243,6 +243,12 @@ Deprecated
Table of Contents
+ src/Collection/Index/EdgeIndex.php
+
+
+ src/Collection/Index/FullTextIndex.php
+
+
src/Collection/Index/HashIndex.php
@@ -250,6 +256,34 @@ Table of Contents
+
+ EdgeIndex.php
+
+
+ Line
+ Element
+ Reason
+
+
+ 16
+ EdgeIndex
+
+
+
+ FullTextIndex.php
+
+
+ Line
+ Element
+ Reason
+
+
+ 16
+ FullTextIndex
+
+
HashIndex.php
diff --git a/src/Collection/Collection.php b/src/Collection/Collection.php
index 6bb0ae4..ff0c636 100644
--- a/src/Collection/Collection.php
+++ b/src/Collection/Collection.php
@@ -501,7 +501,7 @@ public function truncate(): bool
*
* @throws DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException
*/
- public function findByKey(string $key, bool $isVertex = false)
+ public function findByKey(string $key, bool $isVertex = false): Document|false
{
try {
$uri = Api::buildDatabaseUri($this->connection->getBaseUri(), $this->connection->getDatabaseName(), Api::DOCUMENT);
diff --git a/src/Collection/Contracts/IndexInterface.php b/src/Collection/Contracts/IndexInterface.php
index 3bdd2af..44ffeac 100644
--- a/src/Collection/Contracts/IndexInterface.php
+++ b/src/Collection/Contracts/IndexInterface.php
@@ -17,7 +17,7 @@ interface IndexInterface extends \JsonSerializable
/**
* If the index is a new one
*
- * @return bool True for new one index. False for a existing index.
+ * @return bool True for new one index. False for an existing index.
*/
public function isNew(): bool;
@@ -66,7 +66,7 @@ public function getCreateData(): array;
/**
* Returns the collection where the index belongs to
*
- * @return Collection|null A collection object or null if the index was not set to an collection yet
+ * @return Collection|null A collection object or null if the index was not set to a collection yet
*/
public function getCollection();
}
diff --git a/src/Collection/Index/EdgeIndex.php b/src/Collection/Index/EdgeIndex.php
index a24d892..3fa68a4 100644
--- a/src/Collection/Index/EdgeIndex.php
+++ b/src/Collection/Index/EdgeIndex.php
@@ -11,6 +11,7 @@
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
+ * @deprecated
*/
final class EdgeIndex extends PrimaryIndex
{
diff --git a/src/Collection/Index/FullTextIndex.php b/src/Collection/Index/FullTextIndex.php
index d1fd3c1..694b236 100644
--- a/src/Collection/Index/FullTextIndex.php
+++ b/src/Collection/Index/FullTextIndex.php
@@ -11,6 +11,7 @@
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
+ * @deprecated
*/
final class FullTextIndex extends Index
{
@@ -19,7 +20,7 @@ final class FullTextIndex extends Index
*
* @var int
*/
- protected $minLength;
+ protected int $minLength;
/**
* FullTextIndex constructor.
@@ -66,7 +67,7 @@ public function getCreateData(): array
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/
diff --git a/src/Collection/Index/GeoSpatialIndex.php b/src/Collection/Index/GeoSpatialIndex.php
index c844391..e6a8b9e 100644
--- a/src/Collection/Index/GeoSpatialIndex.php
+++ b/src/Collection/Index/GeoSpatialIndex.php
@@ -7,7 +7,7 @@
use ArangoDB\Validation\Exceptions\InvalidParameterException;
/**
- * Represents a geo-spatial index on a collection
+ * Represents a geospatial index on a collection
*
* @package ArangoDB\Collection\Index
* @author Lucas S. Vieira
@@ -15,14 +15,14 @@
final class GeoSpatialIndex extends Index
{
/**
- * If a geo-spatial index on a location is constructed
+ * If a geospatial index on a location is constructed
* and geoJson is true, then the order within the array is longitude
* followed by latitude.
*
* @link https://geojson.org/geojson-spec.html#positions
* @var bool
*/
- protected $geoJson;
+ protected bool $geoJson;
/**
* GeoSpatialIndex constructor.
@@ -64,7 +64,7 @@ public function getCreateData(): array
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/
diff --git a/src/Collection/Index/Index.php b/src/Collection/Index/Index.php
index 0e0fec1..2bc3132 100644
--- a/src/Collection/Index/Index.php
+++ b/src/Collection/Index/Index.php
@@ -17,7 +17,7 @@
class Index implements IndexInterface
{
/**
- * Index Id.
+ * Index ID.
*
* @var string
*/
@@ -223,7 +223,7 @@ public function setCollection(Collection $collection): void
}
/**
- * Returns a array representation of entity
+ * Returns an array representation of entity
*
* @return array
*/
diff --git a/src/Collection/Index/PersistentIndex.php b/src/Collection/Index/PersistentIndex.php
index fc7c5c3..d9515a9 100644
--- a/src/Collection/Index/PersistentIndex.php
+++ b/src/Collection/Index/PersistentIndex.php
@@ -19,7 +19,7 @@ final class PersistentIndex extends Index
*
* @var array
*/
- protected $defaultsOptions = [
+ protected array $defaultsOptions = [
'unique' => true,
'sparse' => true,
];
diff --git a/src/Collection/Index/PrimaryIndex.php b/src/Collection/Index/PrimaryIndex.php
index 025c74b..3b9c7ab 100644
--- a/src/Collection/Index/PrimaryIndex.php
+++ b/src/Collection/Index/PrimaryIndex.php
@@ -28,7 +28,7 @@ public function __construct(array $fields, array $attributes = [])
}
/**
- * This type of Index cannot be create/deleted explicitly by user.
+ * This type of Index cannot be created/deleted explicitly by user.
* Throws an exception if an attempt of create one is made
*
* @return array
diff --git a/src/Collection/Index/TTLIndex.php b/src/Collection/Index/TTLIndex.php
index fb0a3bb..5ced972 100644
--- a/src/Collection/Index/TTLIndex.php
+++ b/src/Collection/Index/TTLIndex.php
@@ -15,11 +15,11 @@
final class TTLIndex extends Index
{
/**
- * Time (in seconds) after a document's creation after which the documents counts as expired
+ * Time (in seconds) after a document's creation after which the documents count as expired
*
* @var int
*/
- protected $expiresAfter;
+ protected int $expiresAfter;
/**
* TTLIndex constructor.
@@ -61,7 +61,7 @@ public function getCreateData(): array
}
/**
- * Returns a array representation of index
+ * Returns an array representation of index
*
* @return array
*/