Galette\Util\Release Class Reference

Public Member Functions
	__construct (bool $nocache=false)
	setupClient ()
	getDefaultOptions ()
	getLatestRelease ()
	findLatestRelease (bool $nocache=false)
	checkNewRelease ()
	getCurrentRelease ()
	getReleasesURL ()

Protected Member Functions
	getDataTocache ()
	cacheLoaded (mixed $content)
	getCacheFilename ()
	prepareForCache ()

Protected Attributes
string	$cache_filename = 'newrelease.cache'

Detailed Description

Check for new Galette release

Author

Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Constructor & Destructor Documentation

__construct()

Galette\Util\Release::__construct

(

bool

$nocache = false

)

Constructor

Parameters

bool

$nocache

Do not try to cache

Member Function Documentation

cacheLoaded()

Galette\Util\Release::cacheLoaded ( mixed  $content )

protected

Called once cache has been loaded.

Parameters

mixed

$content

Content from cache

Returns

bool

checkNewRelease()

Galette\Util\Release::checkNewRelease

(

)

Check if a new release is available

Returns

bool

findLatestRelease()

Galette\Util\Release::findLatestRelease

(

bool

$nocache = false

)

Get the latest release

Parameters

bool

$nocache

Do not try to cache

Returns

?string

getCacheFilename()

Galette\Util\Release::getCacheFilename ( )

protected

Complete path to cache file

Returns

string

getCurrentRelease()

Galette\Util\Release::getCurrentRelease

(

)

Get the current release

Returns

string

getDataTocache()

Galette\Util\Release::getDataTocache ( )

protected

Get data to cache

Returns

string

getDefaultOptions()

Galette\Util\Release::getDefaultOptions

(

)

Get default options

Returns

array<string, mixed>

getLatestRelease()

Galette\Util\Release::getLatestRelease

(

)

Get the latest release

Returns

?string

getReleasesURL()

Galette\Util\Release::getReleasesURL

(

)

Get the URL to download releases

Returns

string

prepareForCache()

Galette\Util\Release::prepareForCache ( )

protected

Ensure data to cache are present

Returns

void

setupClient()

Galette\Util\Release::setupClient

(

)

Set ups Guzzle client

Returns

Client

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Util/Release.php