Documentation

Documents
in package
implements ArrayAccess

Class Documents

Tags
date

4/5/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Interfaces

ArrayAccess

Constants

RESOURCE_PATH  = 'documents'

Properties

$apiCall  : ApiCall
$collectionName  : string
$documents  : array<string|int, mixed>

Methods

__construct()  : mixed
Documents constructor.
create()  : array<string|int, mixed>
createMany()  : array<string|int, mixed>
delete()  : array<string|int, mixed>
export()  : string
import()  : string|array<string|int, mixed>
offsetExists()  : bool
offsetGet()  : Document
offsetSet()  : void
offsetUnset()  : void
search()  : array<string|int, mixed>
update()  : array<string|int, mixed>
upsert()  : array<string|int, mixed>
endPointPath()  : string

Constants

RESOURCE_PATH

public mixed RESOURCE_PATH = 'documents'

Properties

$collectionName

private string $collectionName

$documents

private array<string|int, mixed> $documents = []

Methods

__construct()

Documents constructor.

public __construct(string $collectionName, ApiCall $apiCall) : mixed
Parameters
$collectionName : string
$apiCall : ApiCall

create()

public create(array<string|int, mixed> $document[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$document : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

createMany()

public createMany(array<string|int, mixed> $documents[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$documents : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception|JsonException
Return values
array<string|int, mixed>

delete()

public delete([array<string|int, mixed> $queryParams = [] ]) : array<string|int, mixed>
Parameters
$queryParams : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

export()

public export([array<string|int, mixed> $queryParams = [] ]) : string
Parameters
$queryParams : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception
Return values
string

import()

public import(string|array<string|int, mixed> $documents[, array<string|int, mixed> $options = [] ]) : string|array<string|int, mixed>
Parameters
$documents : string|array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
TypesenseClientError
throws
JsonException|Exception
Return values
string|array<string|int, mixed>

offsetExists()

public offsetExists(mixed $documentId) : bool
Parameters
$documentId : mixed
Return values
bool

offsetGet()

public offsetGet(mixed $documentId) : Document
Parameters
$documentId : mixed
Tags
inheritDoc
Return values
Document

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Tags
inheritDoc

offsetUnset()

public offsetUnset(mixed $documentId) : void
Parameters
$documentId : mixed
Tags
inheritDoc

search()

public search(array<string|int, mixed> $searchParams) : array<string|int, mixed>
Parameters
$searchParams : array<string|int, mixed>
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

update()

public update(array<string|int, mixed> $document[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$document : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

upsert()

public upsert(array<string|int, mixed> $document[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$document : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
TypesenseClientError|Exception
Return values
array<string|int, mixed>

endPointPath()

private endPointPath([string $action = '' ]) : string
Parameters
$action : string = ''
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results