OPCApiService
extends BaseProfileApiService
in package
Table of Contents
Methods
- __construct() : mixed
- downloadInfomodel() : array<string|int, mixed>
- Download an infomodel based on the given id asynchronously
- findInfomodels() : array<string|int, mixed>
- Find infomodels based on the given search criteria asynchronously
- getInfomodelNamespaces() : array<string|int, mixed>
- Get infomodel namespaces asynchronously
- uploadInfomodel() : array<string|int, mixed>
- Upload an infomodel asynchronously
- handleKeywords() : string
- Creates an string of keywords to be used in the search
Methods
__construct()
public
__construct(ApiService $apiBase) : mixed
Parameters
- $apiBase : ApiService
downloadInfomodel()
Download an infomodel based on the given id asynchronously
public
downloadInfomodel(int $id[, bool $nodesetXMLOnly = false ][, bool $metadataOnly = false ]) : array<string|int, mixed>
Parameters
- $id : int
-
- The id of the infomodel to download
- $nodesetXMLOnly : bool = false
-
- Whether to download only the nodeset XML
- $metadataOnly : bool = false
-
- Whether to download only the metadata
Return values
array<string|int, mixed> —- The results of the download
findInfomodels()
Find infomodels based on the given search criteria asynchronously
public
findInfomodels([array<string|int, mixed> $search = ['*'] ][, int $limit = 300 ]) : array<string|int, mixed>
Parameters
- $search : array<string|int, mixed> = ['*']
-
- The search criteria to use
- $limit : int = 300
-
- The maximum number of results to return
Return values
array<string|int, mixed> —- The results of the search
getInfomodelNamespaces()
Get infomodel namespaces asynchronously
public
getInfomodelNamespaces() : array<string|int, mixed>
Return values
array<string|int, mixed> —- The infomodel namespaces
uploadInfomodel()
Upload an infomodel asynchronously
public
uploadInfomodel([array<string|int, mixed> $body = [] ][, bool $overwrite = false ]) : array<string|int, mixed>
Parameters
- $body : array<string|int, mixed> = []
-
- The body of the request containing the infomodel data
- $overwrite : bool = false
-
- An optional flag if existing OPC UA Information models in the library should be overwritten.
Return values
array<string|int, mixed> —- The response from the upload
handleKeywords()
Creates an string of keywords to be used in the search
protected
handleKeywords(array<string|int, mixed> $search) : string
Parameters
- $search : array<string|int, mixed>
-
- The search criteria to use
Return values
string —- The keywords to use in the search