Module "country"
Description
Available methods
Details
int count
Count all the countries available in the system. Often used in
combination with the get_paged() method.
Returns
- int $count The number of countries
array get_all
Get all information associated with all countries. The array
that is returned contains the same information as the single
country call.
Returns
- array $countries Array containing all the information of all the countries
array get_by_id
Get all information associated with a country by supplying its
ID
Parameters
- int $id The ID of the country to fetch information for
Returns
- array $country Array containing all the information of the requested country
array get_paged
Retrieve all countries available. The retruned array contains
all the information returned by the single country calls.
Parameters
- string $sort The field to sort on, can be any field related to an country
- string $direction The sorting direction, can be either ASC or DESC
- int $page The page number you want to retrieve
- array $extra_conditions Extra conditions such as a search
Returns
- array $countries Array containing all information of all countries in the resultset