Documentation

ProductGroupService
in package

WHMCS ProductGroup handler

Table of Contents

$likeableFields  : array<string|int, mixed>
$searchableFields  : array<string|int, mixed>
fetchOne()  : ProductGroup
Retrieves a WHMCS ProductGroup with the specified id
find()  : LengthAwarePaginator
Retrieves a filtered list of ProductGroup's. The searchable fields are stored in the `filterableFields` property
compileSelect()  : Builder
Prepare the select statement

Properties

$likeableFields

private array<string|int, mixed> $likeableFields = ['name']

fields queried with like operator

$searchableFields

private array<string|int, mixed> $searchableFields = ['name' => 'tblproductgroups.name']

searchable fields accepted in the request, translated to raw database field

Methods

fetchOne()

Retrieves a WHMCS ProductGroup with the specified id

public fetchOne(int $id) : ProductGroup
Parameters
$id : int

the id of the WHMCS resource

Return values
ProductGroup

the ProductGroup object instance

find()

Retrieves a filtered list of ProductGroup's. The searchable fields are stored in the `filterableFields` property

public find([array<string|int, mixed> $criteria = [] ]) : LengthAwarePaginator
Parameters
$criteria : array<string|int, mixed> = []

associative array of field and value

Return values
LengthAwarePaginator

a paginated result

compileSelect()

Prepare the select statement

private compileSelect() : Builder
Return values
Builder

the statement

Search results