Skip to content

Commit 5136f23

Browse files
lucassouzavieiralucassouzavieira
authored
fix[indexes]: Inverted index to use default options (#21)
* fix[indexes]: Inverted index to use default options as defined in its class * chore[docs]: rebuild documentation * refactor[collection]: group index related methods into 'IndexableTrait'
1 parent 89b65c6 commit 5136f23

File tree

99 files changed

+64289
-408
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+64289
-408
lines changed

‎docs/classes/ArangoDB-AQL-AQL.html‎

Lines changed: 194 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,14 +309,198 @@ <h3 id="toc">
309309

310310

311311

312+
<h4 id="toc-methods">
313+
Methods
314+
<a href="classes/ArangoDB-AQL-AQL.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
312315

316+
</h4>
317+
<dl class="phpdocumentor-table-of-contents">
318+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
319+
<a class="" href="classes/ArangoDB-AQL-AQL.html#method_functions">functions()</a>
320+
<span>
321+
&nbsp;: <a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a> </span>
322+
</dt>
323+
<dd>Returns all registered AQL user functions.</dd>
324+
325+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
326+
<a class="" href="classes/ArangoDB-AQL-AQL.html#method_validateQuery">validateQuery()</a>
327+
<span>
328+
&nbsp;: bool </span>
329+
</dt>
330+
<dd>Validates a given AQL statement</dd>
331+
332+
</dl>
313333

314334

315-
316335

317336

318337

319338

339+
340+
<section class="phpdocumentor-methods">
341+
<h3 class="phpdocumentor-elements__header" id="methods">
342+
Methods
343+
<a href="classes/ArangoDB-AQL-AQL.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
344+
345+
</h3>
346+
<article
347+
class="phpdocumentor-element
348+
-method
349+
-public
350+
-static "
351+
>
352+
<h4 class="phpdocumentor-element__name" id="method_functions">
353+
functions()
354+
<a href="classes/ArangoDB-AQL-AQL.html#method_functions" class="headerlink"><i class="fas fa-link"></i></a>
355+
356+
</h4>
357+
<aside class="phpdocumentor-element-found-in">
358+
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/AQL.php"><a href="files/src-aql-aql.html"><abbr title="src/AQL/AQL.php">AQL.php</abbr></a></abbr>
359+
:
360+
<span class="phpdocumentor-element-found-in__line">63</span>
361+
362+
<a href="classes/ArangoDB-AQL-AQL.html#source-view.63" class="phpdocumentor-element-found-in__source" data-line="63" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
363+
</aside>
364+
365+
<p class="phpdocumentor-summary">Returns all registered AQL user functions.</p>
366+
367+
<code class="phpdocumentor-code phpdocumentor-signature ">
368+
<span class="phpdocumentor-signature__visibility">public</span>
369+
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">functions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$connection</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$namespace</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a></span></code>
370+
371+
<div class="phpdocumentor-label-line">
372+
</div>
373+
374+
375+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
376+
<dl class="phpdocumentor-argument-list">
377+
<dt class="phpdocumentor-argument-list__entry">
378+
<span class="phpdocumentor-signature__argument__name">$connection</span>
379+
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a></span>
380+
</dt>
381+
<dd class="phpdocumentor-argument-list__definition">
382+
<section class="phpdocumentor-description"><p>Connection object to use.</p>
383+
</section>
384+
385+
</dd>
386+
<dt class="phpdocumentor-argument-list__entry">
387+
<span class="phpdocumentor-signature__argument__name">$namespace</span>
388+
: <span class="phpdocumentor-signature__argument__return-type">string</span>
389+
= <span class="phpdocumentor-signature__argument__default-value">&quot;&quot;</span> </dt>
390+
<dd class="phpdocumentor-argument-list__definition">
391+
<section class="phpdocumentor-description"><p>Returns all registered AQL user functions from namespace 'namespace' under result.</p>
392+
</section>
393+
394+
</dd>
395+
</dl>
396+
397+
398+
<h5 class="phpdocumentor-tag-list__heading" id="tags">
399+
Tags
400+
<a href="classes/ArangoDB-AQL-AQL.html#method_functions#tags" class="headerlink"><i class="fas fa-link"></i></a>
401+
402+
</h5>
403+
<dl class="phpdocumentor-tag-list">
404+
<dt class="phpdocumentor-tag-list__entry">
405+
<span class="phpdocumentor-tag__name">throws</span>
406+
</dt>
407+
<dd class="phpdocumentor-tag-list__definition">
408+
<span class="phpdocumentor-tag-link"><a href="classes/ArangoDB-Exceptions-ServerException.html"><abbr title="\ArangoDB\Exceptions\ServerException">ServerException</abbr></a>|<abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>
409+
410+
411+
</dd>
412+
</dl>
413+
414+
415+
416+
<section>
417+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
418+
<span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a></span>
419+
&mdash;
420+
<section class="phpdocumentor-description"><p>ArrayList with all AQL functions from server.</p>
421+
</section>
422+
423+
</section>
424+
425+
</article>
426+
<article
427+
class="phpdocumentor-element
428+
-method
429+
-public
430+
-static "
431+
>
432+
<h4 class="phpdocumentor-element__name" id="method_validateQuery">
433+
validateQuery()
434+
<a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery" class="headerlink"><i class="fas fa-link"></i></a>
435+
436+
</h4>
437+
<aside class="phpdocumentor-element-found-in">
438+
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/AQL.php"><a href="files/src-aql-aql.html"><abbr title="src/AQL/AQL.php">AQL.php</abbr></a></abbr>
439+
:
440+
<span class="phpdocumentor-element-found-in__line">35</span>
441+
442+
<a href="classes/ArangoDB-AQL-AQL.html#source-view.35" class="phpdocumentor-element-found-in__source" data-line="35" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
443+
</aside>
444+
445+
<p class="phpdocumentor-summary">Validates a given AQL statement</p>
446+
447+
<code class="phpdocumentor-code phpdocumentor-signature ">
448+
<span class="phpdocumentor-signature__visibility">public</span>
449+
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">validateQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$connection</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
450+
451+
<div class="phpdocumentor-label-line">
452+
</div>
453+
454+
455+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
456+
<dl class="phpdocumentor-argument-list">
457+
<dt class="phpdocumentor-argument-list__entry">
458+
<span class="phpdocumentor-signature__argument__name">$statement</span>
459+
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a></span>
460+
</dt>
461+
<dd class="phpdocumentor-argument-list__definition">
462+
<section class="phpdocumentor-description"><p>Statement to be validated.</p>
463+
</section>
464+
465+
</dd>
466+
<dt class="phpdocumentor-argument-list__entry">
467+
<span class="phpdocumentor-signature__argument__name">$connection</span>
468+
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a></span>
469+
</dt>
470+
<dd class="phpdocumentor-argument-list__definition">
471+
<section class="phpdocumentor-description"><p>Connection object to use.</p>
472+
</section>
473+
474+
</dd>
475+
</dl>
476+
477+
478+
<h5 class="phpdocumentor-tag-list__heading" id="tags">
479+
Tags
480+
<a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery#tags" class="headerlink"><i class="fas fa-link"></i></a>
481+
482+
</h5>
483+
<dl class="phpdocumentor-tag-list">
484+
<dt class="phpdocumentor-tag-list__entry">
485+
<span class="phpdocumentor-tag__name">throws</span>
486+
</dt>
487+
<dd class="phpdocumentor-tag-list__definition">
488+
<span class="phpdocumentor-tag-link"><a href="classes/ArangoDB-AQL-Exceptions-AQLException.html"><abbr title="\ArangoDB\AQL\Exceptions\AQLException">AQLException</abbr></a>|<abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>
489+
490+
491+
</dd>
492+
</dl>
493+
494+
495+
496+
<section>
497+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
498+
<span class="phpdocumentor-signature__response_type">bool</span>
499+
</section>
500+
501+
</article>
502+
</section>
503+
320504
<div class="phpdocumentor-modal" id="source-view">
321505
<div class="phpdocumentor-modal-bg" data-exit-button></div>
322506
<div class="phpdocumentor-modal-container">
@@ -422,10 +606,18 @@ <h3 id="toc">
422606
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
423607
<li>
424608
<ul class="phpdocumentor-list -clean">
425-
</ul>
609+
<li><a href="classes/ArangoDB-AQL-AQL.html#toc-methods">Methods</a></li>
610+
</ul>
426611
</li>
427612

428613

614+
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
615+
<li>
616+
<ul class="phpdocumentor-list -clean">
617+
<li class=""><a href="classes/ArangoDB-AQL-AQL.html#method_functions">functions()</a></li>
618+
<li class=""><a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery">validateQuery()</a></li>
619+
</ul>
620+
</li>
429621
</ul>
430622
</section>
431623

0 commit comments

Comments
 (0)