Core/ServiceContext.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\IntuitServicesType

Package: Default
This Enumeration specifies which Intuit service to connect to. It is Either QBO or QBD.

Constants

>VConstantstring  QBD = "QBD"
QuickBooks Desktop Data through IDS.
QBD
string

QBD

>VConstantstring  QBO = "QBO"
QuickBooks Online Data through IDS.
QBO
string

QBO

>VConstantstring  IPP = "IPP"
Intuit Platform services.
IPP
string

IPP

>VConstantstring  None = "None"
None service type.
None
string

None

\ServiceContext

Package: Default
Intuit Partner Platform Service Context.

Properties

>VPropertypublic\IppConfiguration $IppConfiguration
Gets or sets the Ipp configuration.
Details
Type
\IppConfiguration
>VPropertyprivatestring $appToken
Application Token.
Details
Type
string
>VPropertypublicstring $baseserviceURL
Base Uri for IDS Service Call.
Details
Type
string
>VPropertyprivatestring $isCreateMethod
this flag indicates if static create methods of this class has been invoked.
Details
Type
string
>VPropertyprivatestring $messageValues
Temporary storage for serialization and compression values for request and reponse.
Details
Type
string
>VPropertypublic\MinorVersion $minorVersion
The Minor Version that would that returns additinoal fields from build v71
Details
Type
\MinorVersion
>VPropertypublicstring $realmId
The Realm Id.
Details
Type
string
>VPropertypublic\RequestValidator $requestValidator
The Request validator
Details
Type
\RequestValidator
>VPropertypublicstring $serviceType
Intuit Service Type(QBO/QB).
Details
Type
string

Methods

methodpublicGetBaseURL() : string

Gets the base Uri for a QBO user.

Returns
TypeDescription
stringReturns the base Uri endpoint for a user.
methodpublicUseDataServices() : void

Populates the values of the service context like realmId, service type to the Data Services being targetted

methodpublicUsePlatformServices() : void

Populates the values of the service context like service type and base url to Platform Services.

methodpublic__construct(string $realmId, \IntuitServicesType $serviceType, \RequestValidator $requestValidator = NULL) : \ServiceContext

Initializes a new instance of the ServiceContext class.

Parameters
NameTypeDescription
$realmIdstring

The realm id.

$serviceType\IntuitServicesType

Service Type - QBO/QB.

$requestValidator\RequestValidator

The request validate.

Returns
TypeDescription
\ServiceContextReturns ServiceContext object.
Throws
ExceptionDescription
\IdsExceptionIf arguments are null or empty.
\InvalidRealmExceptionIf realm id is invalid.
\InvalidTokenExceptionIf the token is invalid.
methodpublicdisableSSlCheck() : void

Documentation was generated by phpDocumentor 2.8.5.