class GetPostsQuery extends AbstractQuery

Builds URL for GetPosts REST-API calls.

Also holds the response after being executed.

Methods

__construct(string $resourceType, string $grouping, string $groupingName, array $tags = array(), string $hash = null, string $search = null, string $format = 'xml', int $start, int $end = 20)

The query constructor builds the url and saves it into the url property.

$this
execute(Client $httpClient)

Execute a prepared query.

integer
getStatusCode()

No description

bool
isExecuted()

No description

array
getHeaders()

No description

string
getReasonPhrase()

No description

string
getBody()

No description

model()

No description

array
csl()

No description

string
bibliography(string $bibliographyStyleName, string $lang = 'en-US', string $bibliographyStyle = '')

No description

string
bibtex()

No description

string
endnote()

No description

Details

at line 61
__construct(string $resourceType, string $grouping, string $groupingName, array $tags = array(), string $hash = null, string $search = null, string $format = 'xml', int $start, int $end = 20)

The query constructor builds the url and saves it into the url property.

GET /users/[username]/posts ?tags=[t1+t2+...+tn] ?resourcetype=(bibtexǀbookmark)

Parameters

string $resourceType the requested resourcetype
string $grouping determines to which group $groupingName belongs
string $groupingName name of user or group who/which created the posts
array $tags a list of tags filtering the posts
string $hash interhash of resource
string $search full string search currently not implemented
string $format (xml|json|csl|bibtex|endnote)
int $start start index
int $end end index

at line 93
$this execute(Client $httpClient)

Execute a prepared query.

Parameters

Client $httpClient

Return Value

$this

in AbstractQuery at line 128
integer getStatusCode()

Return Value

integer

in AbstractQuery at line 135
bool isExecuted()

Return Value

bool

in AbstractQuery at line 142
array getHeaders()

Return Value

array

in AbstractQuery at line 149
string getReasonPhrase()

Return Value

string

in AbstractQuery at line 157
string getBody()

Return Value

string

Exceptions

UnsupportedOperationException

in AbstractQuery at line 175
ModelObject model()

Return Value

ModelObject

Exceptions

UnsupportedOperationException

in AbstractQuery at line 192
array csl()

Return Value

array

Exceptions

UnsupportedOperationException

in AbstractQuery at line 218
string bibliography(string $bibliographyStyleName, string $lang = 'en-US', string $bibliographyStyle = '')

Parameters

string $bibliographyStyleName supported styles: 'apa', 'din-1505-2', 'ieee', 'harvard1', 'harvard7de', 'vancouver'
string $lang
string $bibliographyStyle

Return Value

string

Exceptions

FileNotFoundException
UnsupportedOperationException

in AbstractQuery at line 246
string bibtex()

Return Value

string

Exceptions

UnsupportedOperationException

in AbstractQuery at line 267
string endnote()

Return Value

string

Exceptions

UnsupportedOperationException