AbstractResource
in package
implements
ResourceInterface
AbstractYes
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- all() : PaginatedResponse
- Fetch all items with optional parameters
- get() : array<string, mixed>
- Fetch a single item by ID
- getBaseUrl() : string
- Get the base URL
- getBySlug() : array<string, mixed>
- Fetch a single item by slug
- getHttpClient() : Client
- Get the HTTP client
- language() : QueryBuilder
- Filter by language (WPML support)
- orderBy() : QueryBuilder
- Set order by
- page() : QueryBuilder
- Set page number
- perPage() : QueryBuilder
- Set results per page
- query() : PaginatedResponse
- Custom query with parameters
- search() : QueryBuilder
- Search within the resource
- where() : QueryBuilder
- Start building a query
Properties
$baseUrl
protected
string
$baseUrl
$client
protected
Client
$client
$endpoint
protected
string
$endpoint
Methods
__construct()
public
__construct(Client $client, string $baseUrl, string $endpoint) : mixed
Parameters
- $client : Client
- $baseUrl : string
- $endpoint : string
all()
Fetch all items with optional parameters
public
all([array<string, mixed> $params = [] ]) : PaginatedResponse
Parameters
- $params : array<string, mixed> = []
Return values
PaginatedResponseget()
Fetch a single item by ID
public
get(int $id) : array<string, mixed>
Parameters
- $id : int
Tags
Return values
array<string, mixed>getBaseUrl()
Get the base URL
public
getBaseUrl() : string
Return values
stringgetBySlug()
Fetch a single item by slug
public
getBySlug(string $slug) : array<string, mixed>
Parameters
- $slug : string
Tags
Return values
array<string, mixed>getHttpClient()
Get the HTTP client
public
getHttpClient() : Client
Return values
Clientlanguage()
Filter by language (WPML support)
public
language(string $languageCode) : QueryBuilder
Parameters
- $languageCode : string
Return values
QueryBuilderorderBy()
Set order by
public
orderBy(string $field[, string $direction = 'asc' ]) : QueryBuilder
Parameters
- $field : string
- $direction : string = 'asc'
Return values
QueryBuilderpage()
Set page number
public
page(int $page) : QueryBuilder
Parameters
- $page : int
Return values
QueryBuilderperPage()
Set results per page
public
perPage(int $perPage) : QueryBuilder
Parameters
- $perPage : int
Return values
QueryBuilderquery()
Custom query with parameters
public
query(array<string, mixed> $params) : PaginatedResponse
Parameters
- $params : array<string, mixed>
Tags
Return values
PaginatedResponsesearch()
Search within the resource
public
search(string $term) : QueryBuilder
Parameters
- $term : string
Return values
QueryBuilderwhere()
Start building a query
public
where(string $key, mixed $value) : QueryBuilder
Parameters
- $key : string
- $value : mixed