DataService/DataService.php

Show:

inherited

Classes
- \DataService

Table of Contents

Package: Default

\DataService
jump to top

Package: Default

This file contains DataService performs CRUD operations on IPP REST APIs.

Properties

\IEntitySerializer $requestSerializer

Serializer needs to be used for request object

Details

Type: \IEntitySerializer

\IEntitySerializer $responseSerializer

Serializer needs to be used fore responce object

Details

Type: \IEntitySerializer

\IRestHandler $restHandler

Rest Request Handler.

Details

Type: \IRestHandler

\ServiceContext $serviceContext

The Service context object.

Details

Type: \ServiceContext

boolean $verbose

If true, indicates a desire to echo verbose output

Details

Type: boolean

Methods

Add(\IPPIntuitEntity $entity) : \IPPIntuitEntity

Creates an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity	Entity to Create.

Returns

Type	Description
\IPPIntuitEntity	Returns the created version of the entity.

CDC( $entityList, $changedSince) : \IntuitCDCResponse

Returns List of entities changed after certain time.

Parameters

Name	Type	Description
$entityList
$changedSince

Returns

Type	Description
\IntuitCDCResponse	Returns an IntuitCDCResponse.

CreateNewBatch() : \Batch

Creates new batch

Returns

Type	Description
\Batch	returns the batch object

Delete(\IPPIntuitEntity $entity) : void

Deletes an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity	Entity to Delete.

Download(object $entity) : \IPPIntuitEntity

Returns an downloaded entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	object	Entity to Find

Returns

Type	Description
\IPPIntuitEntity	Returns an entity of specified Id.

DownloadPDF(\type $entity) : boolean

Returns PDF for entities which can be downloaded as PDF

Parameters

Name	Type	Description
$entity	\type

Returns

Type	Description
boolean

Throws

Exception	Description
\IdsException,	SdkException

FindAll( $entityName, $pageNumber = 0, $pageSize = 500) : array

Retrieves specified entity based passed page number and page size

Parameters

Name	Type	Description
$entityName
$pageNumber
$pageSize

Returns

Type	Description
array	Returns an array of entities of specified type.

FindById(object $entity) : \IPPIntuitEntity

Returns an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	object	Entity to Find

Returns

Type	Description
\IPPIntuitEntity	Returns an entity of specified Id.

Query(string $query, string $pageNumber = 0, string $pageSize = 500) : array

Retrieves specified entities based passed page number and page size and query

Parameters

Name	Type	Description
$query	string	Query to issue
$pageNumber	string	Starting page number
$pageSize	string	Page size

Returns

Type	Description
array	Returns an array of entities fulfilling the query.

Retrieve(object $entity) : \IPPIntuitEntity

Returns an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	object	Entity to Find

Returns

Type	Description
\IPPIntuitEntity	Returns an entity of specified Id.

SendEmail(\type $entity, $email = null) : boolean

Returns PDF for entities which can be downloaded as PDF

Parameters

Name	Type	Description
$entity	\type
$email

Returns

Type	Description
boolean

Throws

Exception	Description
\IdsException,	SdkException

Update(\IPPIntuitEntity $entity) : \IPPIntuitEntity

Updates an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity	Entity to Update.

Returns

Type	Description
\IPPIntuitEntity	Returns an updated version of the entity with updated identifier and sync token.

Upload(string $imgBits, string $fileName, string $mimeType, \IPPAttachable $objAttachable) : array

Uploads an image

Parameters

Name	Type	Description
$imgBits	string	image bytes
$fileName	string	Filename to use for this file
$mimeType	string	MIME type to send in the HTTP Headers
$objAttachable	\IPPAttachable	entity describing the attachement

Returns

Type	Description
array	Returns an array of entities fulfilling the query.

Void(\IPPIntuitEntity $entity) : void

Voids an entity under the specified realm. The realm must be set in the context.

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity	Entity to Void.

__construct(\ServiceContext $serviceContext) : void

Initializes a new instance of the DataService class.

Parameters

Name	Type	Description
$serviceContext	\ServiceContext	IPP Service Context

cleanPhpClassNameToIntuitEntityName(string $phpClassName) : string

static

Clean a POPO class name (like 'IPPClass') to be an IPP v3 Entity name (like 'Class')

Parameters

Name	Type	Description
$phpClassName	string	POPO class name

Returns

Type	Description
string	Intuit Entity name

convertToTimestamp(\type $str) : integer

Parse input date-time string into unix timestamp

Parameters

Name	Type	Description
$str	\type

Returns

Type	Description
integer	timestamp or false overwise

decorateIntuitEntityToPhpClassName( $intuitEntityName) : \POPO

static

Decorate an IPP v3 Entity name (like 'Class') to be a POPO class name (like 'IPPClass')

Parameters

Name	Type	Description
$intuitEntityName

Returns

Type	Description
\POPO	class name

executeObjectSerializer(\IPPIntuitEntity $entity, String $urlResource) : \type

Serializes oblect into specified format

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity
$urlResource	String

Returns

Type	Description
\type

fixTaxServicePayload( $entity, $content) : void

Methods provides workaround to succesfully process TaxService response

Parameters

Name	Type	Description
$entity
$content

forceJsonSerializers() : void

Force json serializers for request and response

getContentType() : string

Returns content type depends from seriaization format

Returns

Type	Description
string

getEntityResourceName( $entity) : void

static

Parameters

Name	Type	Description
$entity

getExportFileNameForPDF(\type $entity, \type $ext, $usetimestamp = true) : \type

Returns PDF filename based on entity type and id

Parameters

Name	Type	Description
$entity	\type
$ext	\type
$usetimestamp

Returns

Type	Description
\type

getFileExportDir() : string

Returns path to directory where SDK should save files

Returns

Type	Description
string

getGetRequestParameters(string $uri, string $type) : \RequestParameters

Returns pre-defined request with GET method

Parameters

Name	Type	Description
$uri	string
$type	string

Returns

Type	Description
\RequestParameters

getMinorVersion() : void

getPostJsonRequest(\type $uri) : \RequestParameters

Returns post request with pre-defined POST method and JSON serialization

Parameters

Name	Type	Description
$uri	\type

Returns

Type	Description
\RequestParameters

getPostRequest(\type $uri) : \RequestParameters

Returns pre-defined request with POST method and content type from settings

Parameters

Name	Type	Description
$uri	\type

Returns

Type	Description
\RequestParameters

getPostRequestParameters(string $uri, string $type) : \RequestParameters

Returns pre-defined request with POST method

Parameters

Name	Type	Description
$uri	string
$type	string

Returns

Type	Description
\RequestParameters

getPrefixFromSettings() : string

Returns prefix for contentWriter

Returns

Type	Description
string

getRequestParameters(string $uri, string $method, string $type, string $apiName = null) : \RequestParameters

Wraps and returns RequestParameters object

Parameters

Name	Type	Description
$uri	string
$method	string
$type	string
$apiName	string

Returns

Type	Description
\RequestParameters

getRequestSerializer() : \IEntitySerializer

Returns serializer for request objects

Returns

Type	Description
\IEntitySerializer

getResponseSerializer() : \IEntitySerializer

Returns serializer for responce objects

Returns

Type	Description
\IEntitySerializer

getRestHandler() : \SyncRestHandler

Returns new instance of rest handler

Returns

Type	Description
\SyncRestHandler

getSerializationFormat() : string

Returns current serialization format

Returns

Type	Description
string

getXmlFromObj(\POPOObject $phpObj) : string

Marshall a POPO object to XML, presumably for inclusion on an IPP v3 API call

This code is dead!

Parameters

Name	Type	Description
$phpObj	\POPOObject	inbound POPO object

Returns

Type	Description
string	XML output derived from POPO object

Details

Depricated

handleTaxService(\IPPIntuitEntity $entity, string $uri) : string

Handles unusual URL mapping for TaxService

Parameters

Name	Type	Description
$entity	\IPPIntuitEntity
$uri	string

Returns

Type	Description
string

initPostRequest(\type $entity, \type $uri) : \RequestParameters

Returns post request, depends on configuration and entity rule "jsonOnly"

Parameters

Name	Type	Description
$entity	\type
$uri	\type

Returns

Type	Description
\RequestParameters

isAllowed( $entity, $method) : void

Simple verification for entities which can be returned as PDF

Parameters

Name	Type	Description
$entity
$method

isFileExport() : boolean

Returns true if SDK is configured to export files to another location

Returns

Type	Description
boolean

isJsonOnly(\type $entity) : boolean

Return true if specified entity can work with JSON only serialization

Parameters

Name	Type	Description
$entity	\type

Returns

Type	Description
boolean

isReturnContentWriter() : boolean

Returns true or false if writer object is allowed as return result

Returns

Type	Description
boolean

isTaxServiceSafe(\IPPTaxService $entity) : \type

Verifies that entity has TaxService type If this class is not available on include_path or wab't loaded the method will return false

Parameters

Name	Type	Description
$entity	\IPPTaxService

Returns

Type	Description
\type

isTempFile() : boolean

Returns true if SDK is configured to save temporary files

Returns

Type	Description
boolean

isValidTimeStamp( $timestamp) : void

Checks if input string is a valid timestamp or not

Parameters

Name	Type	Description
$timestamp

logError( $message) : void

Parameters

Name	Type	Description
$message

logInfo( $message) : void

Parameters

Name	Type	Description
$message

processDownloadedContent(\ContentWriter $writer, integer $responseCode, string $fileName = null) : mixed

Saves exported (e.g. check DownloadPDF) entity into file according to strategy in settings

Parameters

Name	Type	Description
$writer	\ContentWriter
$responseCode	integer
$fileName	string

Returns

Type	Description
mixed	full path with filename or open handler

setupSerializers() : void

Setups serializers objects for responces and requests based on service context

useMinorVersion() : void

validateEntityId( $entity) : void

Parameters

Name	Type	Description
$entity

verifyChangedSince(mixed $value) : integer

Verifies input and returns unix timestamp

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
integer

verifyEmailAddress(\type $email) : \type

Verifies string as email agains RFC 822

Parameters

Name	Type	Description
$email	\type

Returns

Type	Description
\type

verifyOperationAccess( $entity, $func) : void

Parameters

Name	Type	Description
$entity
$func

DataService/DataService.php

\DataServicejump to top

Properties

Methods

\DataService
jump to top