DraftClient
extends
ProvidesListing
in
Tags
Table of Contents
- claim() : array<string, bool>
- create() : Draft
- Creates a new Draft
- destroy() : bool
- list() : Paginator<string|int, T>
- pageInfo() : PageInfo
- replicate() : Draft
- requestIdmlPackage() : bool
- show() : Draft
- update() : Draft
Methods
claim()
public
claim(string|User $user, array<string|int, string|\Rissc\Printformer\Client\Draft\Draft> $drafts[, bool $dryRun = false ]) : array<string, bool>
Parameters
- $user : string|User
- $drafts : array<string|int, string|\Rissc\Printformer\Client\Draft\Draft>
- $dryRun : bool = false
Return values
array<string, bool> —create()
Creates a new Draft
public
create(array<string|int, mixed> $data) : Draft
Parameters
- $data : array<string|int, mixed>
Tags
Return values
Draft —destroy()
public
destroy(string|Draft $draft) : bool
Parameters
- $draft : string|Draft
Return values
bool —list()
public
list(int $page[, int $perPage = 25 ]) : Paginator<string|int, T>
Parameters
- $page : int
-
starts at 1
- $perPage : int = 25
Tags
Return values
Paginator<string|int, T> —pageInfo()
public
pageInfo(string|Draft $draft, string $usage[, int|null $row = null ][, string|null $unit = null ]) : PageInfo
Parameters
- $draft : string|Draft
- $usage : string
- $row : int|null = null
- $unit : string|null = null
Return values
PageInfo —replicate()
public
replicate(string|Draft $draft, array<string|int, mixed> $data) : Draft
Parameters
- $draft : string|Draft
- $data : array<string|int, mixed>
Return values
Draft —requestIdmlPackage()
public
requestIdmlPackage(string|Draft $draft, string $callbackURL) : bool
Parameters
- $draft : string|Draft
- $callbackURL : string
Return values
bool —show()
public
show(string|Draft $draft) : Draft
Parameters
- $draft : string|Draft
Return values
Draft —update()
public
update(string|Draft $draft, array<string|int, mixed> $data) : Draft
Parameters
- $draft : string|Draft
- $data : array<string|int, mixed>