Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ivopetkov committed Jan 1, 2021
1 parent ad7efff commit 1f58dae
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/markdown/ivopetkov.objectstorage.class.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Enables storing and manipulating data objects in the directory specified.

##### public array|null [get](ivopetkov.objectstorage.get.method.md) ( array $parameters )

      Retrieves object data for a specified key.
      Retrieves object data for the specified key.

      Returns: An array containing the result data if existent, NULL otherwise.

Expand Down
4 changes: 2 additions & 2 deletions docs/markdown/ivopetkov.objectstorage.get.method.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# IvoPetkov\ObjectStorage::get

Retrieves object data for a specified key.
Retrieves object data for the specified key.

```php
public array|null get ( array $parameters )
Expand All @@ -10,7 +10,7 @@ public array|null get ( array $parameters )

      `$parameters`

            Data in the following format: ['key' => 'example1', 'result' => ['body', 'metadata.year']]
            Data in the following format: ['key' => 'example1', 'result' => ['body', 'body.length', 'body.range(*,*)', 'metadata.year']]

## Returns

Expand Down
6 changes: 3 additions & 3 deletions docs/markdown/ivopetkov.objectstorage.search.method.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ public array search ( array $parameters )
'where' => [
['key', ['book-1449392776', 'book-1430268158']]
],
'result' => ['key', 'body', 'metadata.title']
'result' => ['key', 'body', 'body.length', 'body.range(*,*)', 'metadata.title']
]
// Finds objects by metadata
[
'where' => [
['metadata.year', '2013']
],
'result' => ['key', 'body', 'metadata.title']
'result' => ['key', 'body', 'body.length', 'body.range(*,*)', 'metadata.title']
]
// Finds objects by regular expression
[
'where' => [
['key', '^prefix1\/', 'regExp']
],
'result' => ['key', 'body', 'metadata.title']
'result' => ['key', 'body', 'body.length', 'body.range(*,*)', 'metadata.title']
]

## Returns
Expand Down

0 comments on commit 1f58dae

Please sign in to comment.