API Documentation
Back to top  

AutoUpdaterUpdate

Class AutoUpdaterUpdate

package

Default

Methods

AutoUpdaterUpdate constructor.

__construct(string $receiptFile, boolean $required, array $name, array $description, array $icon, array $image, string $versionHistoryName, string $infoboxIdentifier, string $zip, string $zipHash, array $fileList)

Arguments

$receiptFile

string

$required

boolean

$name

array

$description

array

$icon

array

$image

array

$versionHistoryName

string

$infoboxIdentifier

string

$zip

string

$zipHash

string

$fileList

array

Creates and returns an auto updater update object.

createByUpdateServerResponse(array $update) : \AutoUpdaterUpdate
static

Arguments

$update

array

Response

\AutoUpdaterUpdate

Returns the description of the update.

description(null|string $type = null, null|string $language = null) : array|string

Arguments

$type

null|string

$language

null|string

Response

array|string

If a type is given, the descriptions for the given type will be returned. If also a language is given, the descriptions for the given type and language will be returned.

Returns a list of update files of the update.

fileList() : array

Response

array

Returns the icon class of the update.

icon(null|string $language = null) : array|string

Arguments

$language

null|string

Response

array|string

If a language is given, the icon for the given language will be returned.

Returns the ID of the update.

id() : string

Response

string

Returns the image url of the update.

image(null|string $language = null) : array|string

Arguments

$language

null|string

Response

array|string

If a language is given, the image for the given language will be returned.

Returns the identifier of the admin infobox message,

infoboxIdentifier() : string

Response

string

Returns the status of the required flag of the update.

isRequired() : boolean

Response

boolean

Returns the name of the update.

name(null|string $language = null) : array|string

Arguments

$language

null|string

Response

array|string

If a language is given, the name for the given language will be returned.

Returns the receipt filename of the update.

receiptFile() : string

Response

string

Returns the version history name of the update,

versionHistoryName() : string

Response

string

Returns the zip file url of the update.

zip() : string

Response

string

Returns the zip file md5 hash of the update.

zipHash() : string

Response

string

Properties

receiptFile

receiptFile : string
var

Type(s)

string

required

required : boolean
var

Type(s)

boolean

name

name : array
var

Type(s)

array

description

description : array
var

Type(s)

array

icon

icon : array
var

Type(s)

array

image

image : array
var

Type(s)

array

versionHistoryName

versionHistoryName : string
var

Type(s)

string

infoboxIdentifier

infoboxIdentifier : string
var

Type(s)

string

zip

zip : string
var

Type(s)

string

zipHash

zipHash : string
var

Type(s)

string

fileList

fileList : array
var

Type(s)

array