AutoUpdaterUpdate
in package
Class AutoUpdaterUpdate
Table of Contents
- $description : array<string|int, mixed>
- $fileList : array<string|int, mixed>
- $icon : array<string|int, mixed>
- $image : array<string|int, mixed>
- $infoboxIdentifier : string
- $name : array<string|int, mixed>
- $receiptFile : string
- $required : bool
- $versionHistoryName : string
- $zip : string
- $zipHash : string
- __construct() : mixed
- AutoUpdaterUpdate constructor.
- createByGambioStoreData() : AutoUpdaterUpdate
- Creates and returns an auto updater update object.
- createByUpdateServerResponse() : AutoUpdaterUpdate
- Creates and returns an auto updater update object.
- description() : array<string|int, mixed>|string
- Returns the description of the update.
- fileList() : array<string|int, mixed>
- Returns a list of update files of the update.
- icon() : array<string|int, mixed>|string
- Returns the icon class of the update.
- id() : string
- Returns the ID of the update.
- image() : array<string|int, mixed>|string
- Returns the image url of the update.
- infoboxIdentifier() : string
- Returns the identifier of the admin infobox message,
- isRequired() : bool
- Returns the status of the required flag of the update.
- name() : array<string|int, mixed>|string
- Returns the name of the update.
- receiptFile() : string
- Returns the receipt filename of the update.
- versionHistoryName() : string
- Returns the version history name of the update,
- zip() : string
- Returns the zip file url of the update.
- zipHash() : string
- Returns the zip file md5 hash of the update.
Properties
$description
protected
array<string|int, mixed>
$description
$fileList
protected
array<string|int, mixed>
$fileList
$icon
protected
array<string|int, mixed>
$icon
$image
protected
array<string|int, mixed>
$image
$infoboxIdentifier
protected
string
$infoboxIdentifier
$name
protected
array<string|int, mixed>
$name
$receiptFile
protected
string
$receiptFile
$required
protected
bool
$required
$versionHistoryName
protected
string
$versionHistoryName
$zip
protected
string
$zip
$zipHash
protected
string
$zipHash
Methods
__construct()
AutoUpdaterUpdate constructor.
public
__construct(string $receiptFile, bool $required, array<string|int, mixed> $name, array<string|int, mixed> $description, array<string|int, mixed> $icon, array<string|int, mixed> $image, string $versionHistoryName, string $infoboxIdentifier, string $zip, string $zipHash, array<string|int, mixed> $fileList) : mixed
Parameters
- $receiptFile : string
- $required : bool
- $name : array<string|int, mixed>
- $description : array<string|int, mixed>
- $icon : array<string|int, mixed>
- $image : array<string|int, mixed>
- $versionHistoryName : string
- $infoboxIdentifier : string
- $zip : string
- $zipHash : string
- $fileList : array<string|int, mixed>
Return values
mixed —createByGambioStoreData()
Creates and returns an auto updater update object.
public
static createByGambioStoreData(array<string|int, mixed> $gambioStoreData) : AutoUpdaterUpdate
Parameters
- $gambioStoreData : array<string|int, mixed>
Return values
AutoUpdaterUpdate —createByUpdateServerResponse()
Creates and returns an auto updater update object.
public
static createByUpdateServerResponse(array<string|int, mixed> $update) : AutoUpdaterUpdate
Parameters
- $update : array<string|int, mixed>
Return values
AutoUpdaterUpdate —description()
Returns the description of the update.
public
description([null|string $type = null ][, null|string $language = null ]) : array<string|int, mixed>|string
Parameters
- $type : null|string = null
- $language : null|string = null
Return values
array<string|int, mixed>|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.
fileList()
Returns a list of update files of the update.
public
fileList() : array<string|int, mixed>
Return values
array<string|int, mixed> —icon()
Returns the icon class of the update.
public
icon([null|string $language = null ]) : array<string|int, mixed>|string
Parameters
- $language : null|string = null
Return values
array<string|int, mixed>|string —If a language is given, the icon for the given language will be returned.
id()
Returns the ID of the update.
public
id() : string
Return values
string —image()
Returns the image url of the update.
public
image([null|string $language = null ]) : array<string|int, mixed>|string
Parameters
- $language : null|string = null
Return values
array<string|int, mixed>|string —If a language is given, the image for the given language will be returned.
infoboxIdentifier()
Returns the identifier of the admin infobox message,
public
infoboxIdentifier() : string
Return values
string —isRequired()
Returns the status of the required flag of the update.
public
isRequired() : bool
Return values
bool —name()
Returns the name of the update.
public
name([null|string $language = null ]) : array<string|int, mixed>|string
Parameters
- $language : null|string = null
Return values
array<string|int, mixed>|string —If a language is given, the name for the given language will be returned.
receiptFile()
Returns the receipt filename of the update.
public
receiptFile() : string
Return values
string —versionHistoryName()
Returns the version history name of the update,
public
versionHistoryName() : string
Return values
string —zip()
Returns the zip file url of the update.
public
zip() : string
Return values
string —zipHash()
Returns the zip file md5 hash of the update.
public
zipHash() : string