PHP Класс Airship\Cabin\Bridge\Blueprint\Skyport

Manages data about the available/existing Airship extensions
Наследование: extends BlueprintGear, use trait Common
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$installHash string
$prefix string

Открытые методы

Метод Описание
countAvailable ( string $type = '' ) : integer Get the number of packages available
countInstalled ( ) : integer Get the number of packages installed
countOutdated ( ) : integer
forceRemoval ( string $type, string $supplier, string $package ) : string Force a package to be removed.
getAvailable ( string $type = '', string $query = '', integer $offset, integer $limit ) : array Get the available packages (based on data provided by Keyggdrasil)
getDetails ( string $type, string $supplier, string $name ) : array Get the relevant details for a particular package
getInstalled ( boolean $grouped = false, integer $offset, integer $limit = 20 ) : array Get a list of all installed packages
getLeftMenu ( ) : array Dynamic content for the left menu of the Skyport.
getLogMessages ( DateTime $cutoffDate = null ) : array Get the recent messages in the update log
getOutdatedPackages ( ) : array Gets all packages for which a new version is available.
getURL ( string $type, string $supplier, string $name ) : string
isLocked ( ) : boolean Is the skyport locked? This prevents packages from being installed or removed.
isPasswordLocked ( ) : boolean Is the skyport password-protected? This prevents packages from being installed or removed without a separate password?
manualRefresh ( string $type, string $supplier, string $pkg ) : boolean Manually refresh a package's metadata.
tryUnlockPassword ( HiddenString $password ) : boolean

Защищенные методы

Метод Описание
deleteMotifFromCabin ( string $cabin, string $key ) Deletes a motif from a cabin's configuration
getAvailableUpgrades ( array $ext = [] ) : array Get a list of all the available upgrade version identifiers
getMotifPath ( string $cabin, array $info ) : array Locate the path that hosts the motif
getNewVersions ( array $package ) : array Get all of the new versions available for a given package
getPackageMetadata ( string $type, string $supplier, string $pkg ) : array Get the updated metadata for a particular package.
removeCabin ( array $info ) : string Remove a cabin
removeGadget ( array $info ) : string Remove a gadget
removeMotif ( array $info ) : string Remove a motif

Описание методов

countAvailable() публичный Метод

Get the number of packages available
public countAvailable ( string $type = '' ) : integer
$type string The package type
Результат integer

countInstalled() публичный Метод

Get the number of packages installed
public countInstalled ( ) : integer
Результат integer

countOutdated() публичный Метод

public countOutdated ( ) : integer
Результат integer

deleteMotifFromCabin() защищенный Метод

Deletes a motif from a cabin's configuration
protected deleteMotifFromCabin ( string $cabin, string $key )
$cabin string
$key string

forceRemoval() публичный Метод

Force a package to be removed.
public forceRemoval ( string $type, string $supplier, string $package ) : string
$type string
$supplier string
$package string
Результат string

getAvailable() публичный Метод

Get the available packages (based on data provided by Keyggdrasil)
public getAvailable ( string $type = '', string $query = '', integer $offset, integer $limit ) : array
$type string
$query string Search query
$offset integer
$limit integer
Результат array

getAvailableUpgrades() защищенный Метод

Get a list of all the available upgrade version identifiers
protected getAvailableUpgrades ( array $ext = [] ) : array
$ext array
Результат array

getDetails() публичный Метод

Get the relevant details for a particular package
public getDetails ( string $type, string $supplier, string $name ) : array
$type string
$supplier string
$name string
Результат array

getInstalled() публичный Метод

Get a list of all installed packages
public getInstalled ( boolean $grouped = false, integer $offset, integer $limit = 20 ) : array
$grouped boolean Group by type? (Creates 2D array)
$offset integer
$limit integer
Результат array

getLeftMenu() публичный Метод

Dynamic content for the left menu of the Skyport.
public getLeftMenu ( ) : array
Результат array

getLogMessages() публичный Метод

Get the recent messages in the update log
public getLogMessages ( DateTime $cutoffDate = null ) : array
$cutoffDate DateTime
Результат array

getMotifPath() защищенный Метод

Locate the path that hosts the motif
protected getMotifPath ( string $cabin, array $info ) : array
$cabin string
$info array
Результат array

getNewVersions() защищенный Метод

Unlike getAvailableUpgrades(), this gets the full dataset
protected getNewVersions ( array $package ) : array
$package array
Результат array

getOutdatedPackages() публичный Метод

Gets all packages for which a new version is available.
public getOutdatedPackages ( ) : array
Результат array

getPackageMetadata() защищенный Метод

Get the updated metadata for a particular package.
protected getPackageMetadata ( string $type, string $supplier, string $pkg ) : array
$type string
$supplier string
$pkg string
Результат array

getURL() публичный Метод

public getURL ( string $type, string $supplier, string $name ) : string
$type string
$supplier string
$name string
Результат string

isLocked() публичный Метод

Is the skyport locked? This prevents packages from being installed or removed.
public isLocked ( ) : boolean
Результат boolean

isPasswordLocked() публичный Метод

Is the skyport password-protected? This prevents packages from being installed or removed without a separate password?
public isPasswordLocked ( ) : boolean
Результат boolean

manualRefresh() публичный Метод

Manually refresh a package's metadata.
public manualRefresh ( string $type, string $supplier, string $pkg ) : boolean
$type string
$supplier string
$pkg string
Результат boolean

removeCabin() защищенный Метод

Remove a cabin
protected removeCabin ( array $info ) : string
$info array
Результат string

removeGadget() защищенный Метод

Remove a gadget
protected removeGadget ( array $info ) : string
$info array
Результат string

removeMotif() защищенный Метод

Remove a motif
protected removeMotif ( array $info ) : string
$info array
Результат string

tryUnlockPassword() публичный Метод

public tryUnlockPassword ( HiddenString $password ) : boolean
$password HiddenString
Результат boolean

Описание свойств

$installHash защищенное свойство

protected string $installHash
Результат string

$prefix защищенное свойство

protected string $prefix
Результат string