:wqrefactor[index]: mark 'Full Index' and 'Edge' indexes classes as deprecated

Author: lucassouzavieira

docs/classes/ArangoDB-Collection-Contracts-IndexInterface.html

@@ -416,7 +416,7 @@ <h4 class="phpdocumentor-element__name" id="method_getCollection">
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
         <span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-Collection-Collection.html"><abbr title="\ArangoDB\Collection\Collection">Collection</abbr></a>|null</span>
                     &mdash;
-                <section class="phpdocumentor-description"><p>A collection object or null if the index was not set to an collection yet</p>
+                <section class="phpdocumentor-description"><p>A collection object or null if the index was not set to a collection yet</p>
 </section>
 
             </section>
@@ -620,7 +620,7 @@ <h4 class="phpdocumentor-element__name" id="method_isNew">
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
         <span class="phpdocumentor-signature__response_type">bool</span>
                     &mdash;
-                <section class="phpdocumentor-description"><p>True for new one index. False for a existing index.</p>
+                <section class="phpdocumentor-description"><p>True for new one index. False for an existing index.</p>
 </section>
 
             </section>

docs/classes/ArangoDB-Collection-Index-EdgeIndex.html

@@ -268,14 +268,20 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/EdgeIndex.php"><a href="files/src-collection-index-edgeindex.html"><abbr title="src/Collection/Index/EdgeIndex.php">EdgeIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">15</span>
+    <span class="phpdocumentor-element-found-in__line">16</span>
 
-            <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.15" class="phpdocumentor-element-found-in__source" data-line="15" data-modal="source-view" data-src="files/src/Collection/Index/EdgeIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.16" class="phpdocumentor-element-found-in__source" data-line="16" data-modal="source-view" data-src="files/src/Collection/Index/EdgeIndex.php.txt"></a>
     </aside>
 
             <p class="phpdocumentor-summary">Represents an edge index on a collection</p>
 
-
+            <div class="phpdocumentor-admonition">
+        <svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
+            <article>
+                
+            </article>
+        </div>
+    
 
 
     <h5 class="phpdocumentor-tag-list__heading" id="tags">
@@ -338,7 +344,7 @@ <h4 id="toc-properties">
     <span>
                         &nbsp;: string            </span>
 </dt>
-<dd>Index Id.</dd>
+<dd>Index ID.</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a class="" href="classes/ArangoDB-Collection-Index-Index.html#property_indexTypes">$indexTypes</a>
@@ -417,7 +423,7 @@ <h4 id="toc-methods">
     <span>
                                 &nbsp;: array&lt;string|int, mixed&gt;    </span>
 </dt>
-<dd>This type of Index cannot be create/deleted explicitly by user.</dd>
+<dd>This type of Index cannot be created/deleted explicitly by user.</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a class="" href="classes/ArangoDB-Collection-Index-Index.html#method_getFields">getFields()</a>
@@ -486,7 +492,7 @@ <h4 id="toc-methods">
     <span>
                                 &nbsp;: array&lt;string|int, mixed&gt;    </span>
 </dt>
-<dd>Returns a array representation of entity</dd>
+<dd>Returns an array representation of entity</dd>
 
     </dl>
 
@@ -603,7 +609,7 @@ <h4 class="phpdocumentor-element__name" id="property_id">
             <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/Collection/Index/Index.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Index Id.</p>
+        <p class="phpdocumentor-summary">Index ID.</p>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
@@ -884,9 +890,9 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/EdgeIndex.php"><a href="files/src-collection-index-edgeindex.html"><abbr title="src/Collection/Index/EdgeIndex.php">EdgeIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">24</span>
+    <span class="phpdocumentor-element-found-in__line">25</span>
 
-            <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/Collection/Index/EdgeIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.25" class="phpdocumentor-element-found-in__source" data-line="25" data-modal="source-view" data-src="files/src/Collection/Index/EdgeIndex.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">EdgeIndex constructor.</p>
@@ -1037,7 +1043,7 @@ <h4 class="phpdocumentor-element__name" id="method_getCreateData">
             <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.37" class="phpdocumentor-element-found-in__source" data-line="37" data-modal="source-view" data-src="files/src/Collection/Index/PrimaryIndex.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">This type of Index cannot be create/deleted explicitly by user.</p>
+        <p class="phpdocumentor-summary">This type of Index cannot be created/deleted explicitly by user.</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
@@ -1489,7 +1495,7 @@ <h4 class="phpdocumentor-element__name" id="method_toArray">
             <a href="classes/ArangoDB-Collection-Index-EdgeIndex.html#source-view.230" class="phpdocumentor-element-found-in__source" data-line="230" data-modal="source-view" data-src="files/src/Collection/Index/Index.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Returns a array representation of entity</p>
+        <p class="phpdocumentor-summary">Returns an array representation of entity</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>

docs/classes/ArangoDB-Collection-Index-FullTextIndex.html

@@ -268,14 +268,20 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">15</span>
+    <span class="phpdocumentor-element-found-in__line">16</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.15" class="phpdocumentor-element-found-in__source" data-line="15" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.16" class="phpdocumentor-element-found-in__source" data-line="16" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
             <p class="phpdocumentor-summary">Represents a fulltext index</p>
 
-
+            <div class="phpdocumentor-admonition">
+        <svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
+            <article>
+                
+            </article>
+        </div>
+    
 
 
     <h5 class="phpdocumentor-tag-list__heading" id="tags">
@@ -338,7 +344,7 @@ <h4 id="toc-properties">
     <span>
                         &nbsp;: string            </span>
 </dt>
-<dd>Index Id.</dd>
+<dd>Index ID.</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a class="" href="classes/ArangoDB-Collection-Index-Index.html#property_indexTypes">$indexTypes</a>
@@ -500,7 +506,7 @@ <h4 id="toc-methods">
     <span>
                                 &nbsp;: array&lt;string|int, mixed&gt;    </span>
 </dt>
-<dd>Returns a array representation of index</dd>
+<dd>Returns an array representation of index</dd>
 
     </dl>
 
@@ -617,7 +623,7 @@ <h4 class="phpdocumentor-element__name" id="property_id">
             <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/Collection/Index/Index.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Index Id.</p>
+        <p class="phpdocumentor-summary">Index ID.</p>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
@@ -733,9 +739,9 @@ <h4 class="phpdocumentor-element__name" id="property_minLength">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">22</span>
+    <span class="phpdocumentor-element-found-in__line">23</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.22" class="phpdocumentor-element-found-in__source" data-line="22" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.23" class="phpdocumentor-element-found-in__source" data-line="23" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">Minimum length of index</p>
@@ -938,9 +944,9 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">33</span>
+    <span class="phpdocumentor-element-found-in__line">34</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.34" class="phpdocumentor-element-found-in__source" data-line="34" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">FullTextIndex constructor.</p>
@@ -1097,9 +1103,9 @@ <h4 class="phpdocumentor-element__name" id="method_getCreateData">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">54</span>
+    <span class="phpdocumentor-element-found-in__line">55</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.54" class="phpdocumentor-element-found-in__source" data-line="54" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.55" class="phpdocumentor-element-found-in__source" data-line="55" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">Return data for create index on server</p>
@@ -1217,9 +1223,9 @@ <h4 class="phpdocumentor-element__name" id="method_getMinLength">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">44</span>
+    <span class="phpdocumentor-element-found-in__line">45</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.44" class="phpdocumentor-element-found-in__source" data-line="44" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.45" class="phpdocumentor-element-found-in__source" data-line="45" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">Return index minimum length</p>
@@ -1572,12 +1578,12 @@ <h4 class="phpdocumentor-element__name" id="method_toArray">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Collection/Index/FullTextIndex.php"><a href="files/src-collection-index-fulltextindex.html"><abbr title="src/Collection/Index/FullTextIndex.php">FullTextIndex.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">73</span>
+    <span class="phpdocumentor-element-found-in__line">74</span>
 
-            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.73" class="phpdocumentor-element-found-in__source" data-line="73" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
+            <a href="classes/ArangoDB-Collection-Index-FullTextIndex.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view" data-src="files/src/Collection/Index/FullTextIndex.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Returns a array representation of index</p>
+        <p class="phpdocumentor-summary">Returns an array representation of index</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>

docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html

@@ -273,7 +273,7 @@ <h2 class="phpdocumentor-content__title">
             <a href="classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#source-view.15" class="phpdocumentor-element-found-in__source" data-line="15" data-modal="source-view" data-src="files/src/Collection/Index/GeoSpatialIndex.php.txt"></a>
     </aside>
 
-            <p class="phpdocumentor-summary">Represents a geo-spatial index on a collection</p>
+            <p class="phpdocumentor-summary">Represents a geospatial index on a collection</p>
 
 
 
@@ -338,7 +338,7 @@ <h4 id="toc-properties">
     <span>
                         &nbsp;: bool            </span>
 </dt>
-<dd>If a geo-spatial index on a location is constructed
+<dd>If a geospatial index on a location is constructed
 and geoJson is true, then the order within the array is longitude
 followed by latitude.</dd>
 
@@ -347,7 +347,7 @@ <h4 id="toc-properties">
     <span>
                         &nbsp;: string            </span>
 </dt>
-<dd>Index Id.</dd>
+<dd>Index ID.</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a class="" href="classes/ArangoDB-Collection-Index-Index.html#property_indexTypes">$indexTypes</a>
@@ -502,7 +502,7 @@ <h4 id="toc-methods">
     <span>
                                 &nbsp;: array&lt;string|int, mixed&gt;    </span>
 </dt>
-<dd>Returns a array representation of index</dd>
+<dd>Returns an array representation of index</dd>
 
     </dl>
 
@@ -619,7 +619,7 @@ <h4 class="phpdocumentor-element__name" id="property_geoJson">
             <a href="classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#source-view.25" class="phpdocumentor-element-found-in__source" data-line="25" data-modal="source-view" data-src="files/src/Collection/Index/GeoSpatialIndex.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">If a geo-spatial index on a location is constructed
+        <p class="phpdocumentor-summary">If a geospatial index on a location is constructed
 and geoJson is true, then the order within the array is longitude
 followed by latitude.</p>
 
@@ -675,7 +675,7 @@ <h4 class="phpdocumentor-element__name" id="property_id">
             <a href="classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/Collection/Index/Index.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Index Id.</p>
+        <p class="phpdocumentor-summary">Index ID.</p>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
@@ -1593,7 +1593,7 @@ <h4 class="phpdocumentor-element__name" id="method_toArray">
             <a href="classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/Collection/Index/GeoSpatialIndex.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Returns a array representation of index</p>
+        <p class="phpdocumentor-summary">Returns an array representation of index</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>

docs/classes/ArangoDB-Collection-Index-HashIndex.html

@@ -356,7 +356,7 @@ <h4 id="toc-properties">
     <span>
                         &nbsp;: string            </span>
 </dt>
-<dd>Index Id.</dd>
+<dd>Index ID.</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a class="" href="classes/ArangoDB-Collection-Index-Index.html#property_indexTypes">$indexTypes</a>
@@ -708,7 +708,7 @@ <h4 class="phpdocumentor-element__name" id="property_id">
             <a href="classes/ArangoDB-Collection-Index-HashIndex.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/Collection/Index/Index.php.txt"></a>
     </aside>
 
-        <p class="phpdocumentor-summary">Index Id.</p>
+        <p class="phpdocumentor-summary">Index ID.</p>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">