API Documentation
\
AlQuranCloud
ApiClient

\AlQuranCloud\ApiClientClient

Class Client

Summary

Methods
Properties
Constants
__construct()
editions()
editionsByLanguage()
editionsByType()
editionsByFormat()
languages()
formats()
types()
quran()
ayah()
search()
searchSurah()
surah()
surahs()
juz()
No public properties found
FORMAT_JSON
FORMAT_ARRAY
BASE_URL_HTTP
No protected methods found
No protected properties found
N/A
connect()
$client
$baseUrl
N/A

Constants

FORMAT_JSON

FORMAT_JSON

FORMAT_ARRAY

FORMAT_ARRAY

BASE_URL_HTTP

BASE_URL_HTTP

Properties

$client

$client : \GuzzleHttp\Client

Type

\GuzzleHttp\Client

$baseUrl

$baseUrl : string

Type

string

Methods

__construct()

__construct()

Constructor

editions()

editions(  $language = null,   $type = null,   $format = null) : mixed|string

Parameters

$language
$type
$format

Returns

mixed|string

editionsByLanguage()

editionsByLanguage(  $language) : mixed

Parameters

$language

Returns

mixed

editionsByType()

editionsByType(  $type) : mixed

Parameters

$type

Returns

mixed

editionsByFormat()

editionsByFormat(  $format) : mixed

Parameters

$format

Returns

mixed

languages()

languages() : mixed

Returns

mixed

formats()

formats() : mixed

Returns

mixed

types()

types() : mixed

Returns

mixed

quran()

quran(boolean|false  $edition = false) : mixed|string

Parameters

boolean|false $edition

Returns

mixed|string

ayah()

ayah(  $reference, boolean|false  $edition = false) : mixed|string

Parameters

$reference
boolean|false $edition

Returns

mixed|string

search()

search(  $keyword, boolean|false  $surah = null, boolean|false  $edition = null) : mixed|string

Parameters

$keyword
boolean|false $surah
boolean|false $edition

Returns

mixed|string

searchSurah()

searchSurah(  $keyword,   $surah, boolean|false  $edition = null) : mixed|string

Parameters

$keyword
$surah
boolean|false $edition

Returns

mixed|string

surah()

surah(  $number, boolean|false  $edition = false) : mixed|string

Parameters

$number
boolean|false $edition

Returns

mixed|string

surahs()

surahs() : mixed|string

Returns list of surahs

Returns

mixed|string

juz()

juz(  $number,   $edition) : mixed|string

Parameters

$number
$edition

Returns

mixed|string

connect()

connect(  $endpoint,   $params = null, string  $format = self::FORMAT_ARRAY) : mixed|string

Parameters

$endpoint
$params
string $format

Returns

mixed|string