Documentation

IFCApi
in package

BIMworks

IFCApi Class Doc Comment

Constants

contentTypes = ['check' => ['application/json'], 'compare' => ['application/json'], 'query' => ['application/json']]

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
check() : CheckResultsResponse|ErrorResponse: Operation check
checkAsync() : PromiseInterface: Operation checkAsync
checkAsyncWithHttpInfo() : PromiseInterface: Operation checkAsyncWithHttpInfo
checkRequest() : Request: Create request for operation 'check'
checkWithHttpInfo() : array<string|int, mixed>: Operation checkWithHttpInfo
compare() : mixed|ErrorResponse: Operation compare
compareAsync() : PromiseInterface: Operation compareAsync
compareAsyncWithHttpInfo() : PromiseInterface: Operation compareAsyncWithHttpInfo
compareRequest() : Request: Create request for operation 'compare'
compareWithHttpInfo() : array<string|int, mixed>: Operation compareWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
query() : object|ErrorResponse: Operation query
queryAsync() : PromiseInterface: Operation queryAsync
queryAsyncWithHttpInfo() : PromiseInterface: Operation queryAsyncWithHttpInfo
queryRequest() : Request: Create request for operation 'query'
queryWithHttpInfo() : array<string|int, mixed>: Operation queryWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['check' => ['application/json'], 'compare' => ['application/json'], 'query' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

check()

Operation check


    public
                    check(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : CheckResultsResponse|ErrorResponse

Check one or more models

Parameters

$check_request : CheckRequest: check_request (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

CheckResultsResponse|ErrorResponse

checkAsync()

Operation checkAsync


    public
                    checkAsync(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : PromiseInterface

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

PromiseInterface

checkAsyncWithHttpInfo()

Operation checkAsyncWithHttpInfo


    public
                    checkAsyncWithHttpInfo(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : PromiseInterface

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

PromiseInterface

checkRequest()

Create request for operation 'check'


    public
                    checkRequest(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : Request

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

Request

checkWithHttpInfo()

Operation checkWithHttpInfo


    public
                    checkWithHttpInfo(CheckRequest $check_request[, string $contentType = self::contentTypes['check'][0] ]) : array<string|int, mixed>

Check one or more models

Parameters

$check_request : CheckRequest: (required)
$contentType : string = self::contentTypes['check'][0]: The value for the Content-Type header. Check self::contentTypes['check'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \BIMworks\Model\CheckResultsResponse|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

compare()

Operation compare


    public
                    compare(CompareRequest $compare_request[, string $contentType = self::contentTypes['compare'][0] ]) : mixed|ErrorResponse

Compare two models

Parameters

$compare_request : CompareRequest: compare_request (required)
$contentType : string = self::contentTypes['compare'][0]: The value for the Content-Type header. Check self::contentTypes['compare'] to see the possible values for this operation

Return values

mixed|ErrorResponse

compareAsync()

Operation compareAsync


    public
                    compareAsync(CompareRequest $compare_request[, string $contentType = self::contentTypes['compare'][0] ]) : PromiseInterface

Compare two models

Parameters

$compare_request : CompareRequest: (required)
$contentType : string = self::contentTypes['compare'][0]: The value for the Content-Type header. Check self::contentTypes['compare'] to see the possible values for this operation

Return values

PromiseInterface

compareAsyncWithHttpInfo()

Operation compareAsyncWithHttpInfo


    public
                    compareAsyncWithHttpInfo(CompareRequest $compare_request[, string $contentType = self::contentTypes['compare'][0] ]) : PromiseInterface

Compare two models

Parameters

$compare_request : CompareRequest: (required)
$contentType : string = self::contentTypes['compare'][0]: The value for the Content-Type header. Check self::contentTypes['compare'] to see the possible values for this operation

Return values

PromiseInterface

compareRequest()

Create request for operation 'compare'


    public
                    compareRequest(CompareRequest $compare_request[, string $contentType = self::contentTypes['compare'][0] ]) : Request

Parameters

$compare_request : CompareRequest: (required)
$contentType : string = self::contentTypes['compare'][0]: The value for the Content-Type header. Check self::contentTypes['compare'] to see the possible values for this operation

Return values

Request

compareWithHttpInfo()

Operation compareWithHttpInfo


    public
                    compareWithHttpInfo(CompareRequest $compare_request[, string $contentType = self::contentTypes['compare'][0] ]) : array<string|int, mixed>

Compare two models

Parameters

$compare_request : CompareRequest: (required)
$contentType : string = self::contentTypes['compare'][0]: The value for the Content-Type header. Check self::contentTypes['compare'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of mixed|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

query()

Operation query


    public
                    query(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : object|ErrorResponse

Query one or more IFC models

Parameters

$query_request : QueryRequest: query_request (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

object|ErrorResponse

queryAsync()

Operation queryAsync


    public
                    queryAsync(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : PromiseInterface

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

PromiseInterface

queryAsyncWithHttpInfo()

Operation queryAsyncWithHttpInfo


    public
                    queryAsyncWithHttpInfo(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : PromiseInterface

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

PromiseInterface

queryRequest()

Create request for operation 'query'


    public
                    queryRequest(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : Request

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

Request

queryWithHttpInfo()

Operation queryWithHttpInfo


    public
                    queryWithHttpInfo(QueryRequest $query_request[, string $contentType = self::contentTypes['query'][0] ]) : array<string|int, mixed>

Query one or more IFC models

Parameters

$query_request : QueryRequest: (required)
$contentType : string = self::contentTypes['query'][0]: The value for the Content-Type header. Check self::contentTypes['query'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of object|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

IFCApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

check()

Parameters

Tags

Return values

checkAsync()

Parameters

Tags

Return values

checkAsyncWithHttpInfo()

Parameters

Tags

Return values

checkRequest()

Parameters

Tags

Return values

checkWithHttpInfo()

Parameters

Tags

Return values

compare()

Parameters

Tags

Return values

compareAsync()

Parameters

Tags

Return values

compareAsyncWithHttpInfo()

Parameters

Tags

Return values

compareRequest()

Parameters

Tags

Return values

compareWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

query()

Parameters

Tags

Return values

queryAsync()

Parameters

Tags

Return values

queryAsyncWithHttpInfo()

Parameters

Tags

Return values

queryRequest()

Parameters

Tags

Return values

queryWithHttpInfo()

Parameters

Tags

Return values

IFCApi
in package

BIMworks