ProjectResource
extends BaseResource
in package
Table of Contents
Constants
Properties
- $httpClient : HttpClient
- $listModel : string
- $listResourcePath : string
- $singleModel : string
- $singleResourcePath : string
Methods
- __construct() : mixed
- create() : DataTransferObject
- Create a resource from either an array or a DataModel object.
- delete() : void
- Delete a resource.
- get() : DataTransferObject
- Get a single resource with the corresponding id.
- list() : DataTransferObject
- Get a list of resources.
- update() : DataTransferObject
- Update a resource from either an array or a DataModel object.
- buildQueryString() : string
- createResponseError() : void
- Parse the json response for project endpoint errors and create a FreshBooksException from it.
- getUrl() : string
- The the url to the accounting resource.
- makeRequest() : array<string|int, mixed>
- Make a request against the project resource and return an array of the json response.
Constants
DELETE
protected
mixed
DELETE
= 'DELETE'
GET
protected
mixed
GET
= 'GET'
PATCH
protected
mixed
PATCH
= 'PATCH'
POST
protected
mixed
POST
= 'POST'
PUT
protected
mixed
PUT
= 'PUT'
Properties
$httpClient
private
HttpClient
$httpClient
$listModel
private
string
$listModel
$listResourcePath
private
string
$listResourcePath
$singleModel
private
string
$singleModel
$singleResourcePath
private
string
$singleResourcePath
Methods
__construct()
public
__construct(HttpClient $httpClient, string $singleResourcePath, string $listResourcePath, string $singleModel, string $listModel) : mixed
Parameters
- $httpClient : HttpClient
- $singleResourcePath : string
- $listResourcePath : string
- $singleModel : string
- $listModel : string
create()
Create a resource from either an array or a DataModel object.
public
create(int $businessId[, DataModel $model = null ][, array<string|int, mixed> $data = null ][, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
- $businessId : int
-
The business id
- $model : DataModel = null
-
(Optional) The model to create
- $data : array<string|int, mixed> = null
-
(Optional) The data to create the model with
- $includes : IncludesBuilder|null = null
Return values
DataTransferObject —Model of the new resource's response data.
delete()
Delete a resource.
public
delete(int $businessId, int $resourceId) : void
Note: Most FreshBooks resources are soft-deleted, See FreshBooks API - Active and Deleted Objects
Parameters
- $businessId : int
-
The business id
- $resourceId : int
-
Id of the resource to delete
get()
Get a single resource with the corresponding id.
public
get(int $businessId, int $resourceId[, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
- $businessId : int
-
The business id
- $resourceId : int
-
Id of the resource to return
- $includes : IncludesBuilder|null = null
Return values
DataTransferObject —The result model
list()
Get a list of resources.
public
list(int $businessId[, array<string|int, mixed> $builders = null ]) : DataTransferObject
Parameters
- $businessId : int
-
The business id
- $builders : array<string|int, mixed> = null
-
(Optional) List of builder objects for filters, pagination, etc.
Return values
DataTransferObject —The list result model
update()
Update a resource from either an array or a DataModel object.
public
update(int $businessId, int $resourceId[, DataModel $model = null ][, array<string|int, mixed> $data = null ][, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
- $businessId : int
-
The business id
- $resourceId : int
-
Id of the resource to update
- $model : DataModel = null
-
(Optional) The model to update
- $data : array<string|int, mixed> = null
-
(Optional) The data to update the model with
- $includes : IncludesBuilder|null = null
Return values
DataTransferObject —Model of the updated resource's response data.
buildQueryString()
protected
buildQueryString(array<string|int, mixed>|null $builders) : string
Parameters
- $builders : array<string|int, mixed>|null
Return values
stringcreateResponseError()
Parse the json response for project endpoint errors and create a FreshBooksException from it.
private
createResponseError(int $statusCode, array<string|int, mixed> $responseData, string $rawRespone) : void
Parameters
- $statusCode : int
-
HTTP status code
- $responseData : array<string|int, mixed>
-
The json-parsed response
- $rawRespone : string
-
The raw response body
getUrl()
The the url to the accounting resource.
private
getUrl(int $businessId[, int $resourceId = null ][, bool $isList = false ]) : string
Parameters
- $businessId : int
- $resourceId : int = null
- $isList : bool = false
Return values
stringmakeRequest()
Make a request against the project resource and return an array of the json response.
private
makeRequest(string $method, string $url[, array<string|int, mixed> $data = null ]) : array<string|int, mixed>
Throws a FreshBooksException if the response is not a 200 or if the response cannot be parsed.
Parameters
- $method : string
- $url : string
- $data : array<string|int, mixed> = null