Oihana PHP Arango

getDocuments.php

Table of Contents

Functions

getDocuments()  : Documents|null
Resolves a {@see Documents} instance from various types of input definitions.

Functions

getDocuments()

Resolves a {@see Documents} instance from various types of input definitions.

getDocuments([array<string|int, mixed>|string|Documents|null $definition = null ][, ContainerInterface|null $container = null ][, string $key = Arango::DOCUMENTS ][, Documents|null $default = null ]) : Documents|null

This helper function returns a Documents object from: a direct instance, an array definition, a service name within a PSR-11 container, or falls back to a provided default value.

Behavior:

  • If $definition is a Documents instance, it is returned as-is.
  • If $definition is an array, the function looks for the $key (default: Arango::DOCUMENTS).
  • If $definition is a non-empty string and $container contains a service with that name, the corresponding service is fetched.
  • If none of the above conditions are met, the $default value is returned.
Parameters
$definition : array<string|int, mixed>|string|Documents|null = null

Input definition that may represent an Documents instance, an associative array containing one, or a container service name.

$container : ContainerInterface|null = null

Optional PSR-11 container used to resolve string service names.

$key : string = Arango::DOCUMENTS

Array key to look for when $definition is an array

$default : Documents|null = null

Default Documents instance to return if resolution fails. (defaults to Arango::DOCUMENTS).

Tags
throws
ContainerExceptionInterface

If an error occurs while retrieving the service from the container.

NotFoundExceptionInterface

If the service is not found in the container.

example 
use oihana\arango\models\helpers\getDocuments;
use oihana\arango\models\Documents;
use oihana\arango\enums\Arango;
use Psr\Container\ContainerInterface;

$docs = new Documents(['_key' => 'user_1']);

// Example 1: Direct instance
$result = getDocuments($docs);
// → returns the same $docs instance

// Example 2: From array definition
$result = getDocuments([Arango::DOCUMENTS => $docs]);
// → returns the $docs instance from the array

// Example 3: From container service
$container->method('has')->willReturn(true);
$container->method('get')->willReturn($docs);
$result = getDocuments('my.documents.service', $container);
// → returns the $docs instance from the container

// Example 4: Default fallback
$default = new Documents(['_key' => 'fallback']);
$result  = getDocuments(null, null, $default);
// → returns $default
author

Marc Alcaraz (eKameleon)

version
1.0.0
Return values
Documents|null —

Returns the resolved Documents instance or the default value if not found.

On this page

Search results