Documentation

rex_package_manager
in package
Uses rex_factory_trait

AbstractYes

Manager class for packages.

Tags
template-covariant

T as rex_package

Table of Contents

Properties

$generatePackageOrder  : bool
$message  : string
$package  : T

Methods

activate()  : bool
Activates a package.
checkConflicts()  : bool
Checks whether the package is in conflict with other packages.
checkDependencies()  : bool
Checks if another Package which is activated, depends on the given package.
checkPackageConflict()  : bool
Checks whether the package is in conflict with another package.
checkPackageRequirement()  : bool
Checks whether the package requirement is met.
checkRedaxoRequirement()  : bool
Checks whether the redaxo requirement is met.
checkRequirements()  : bool
Checks whether the requirements are met.
deactivate()  : bool
Deactivates a package.
delete()  : bool
Deletes a package.
factory()  : static
Creates the manager for the package.
generatePackageOrder()  : void
Generates the package order.
getMessage()  : string
Returns the message.
install()  : bool
Installs a package.
synchronizeWithFileSystem()  : void
Synchronizes the packages with the file system.
uninstall()  : bool
Uninstalls a package.
__construct()  : mixed
_delete()  : bool
Deletes a package.
i18n()  : string
Translates the given key.
saveConfig()  : void
Saves the package config.
wrongPackageId()  : string

Properties

$generatePackageOrder

protected bool $generatePackageOrder = \true

Methods

activate()

Activates a package.

public activate() : bool
Return values
bool

TRUE on success, FALSE on error

checkConflicts()

Checks whether the package is in conflict with other packages.

public checkConflicts() : bool
Return values
bool

checkDependencies()

Checks if another Package which is activated, depends on the given package.

public checkDependencies() : bool
Return values
bool

checkPackageConflict()

Checks whether the package is in conflict with another package.

public checkPackageConflict(string $packageId) : bool
Parameters
$packageId : string

Package ID

Return values
bool

checkPackageRequirement()

Checks whether the package requirement is met.

public checkPackageRequirement(string $packageId) : bool
Parameters
$packageId : string

Package ID

Return values
bool

checkRedaxoRequirement()

Checks whether the redaxo requirement is met.

public checkRedaxoRequirement(string $redaxoVersion) : bool
Parameters
$redaxoVersion : string

REDAXO version

Return values
bool

checkRequirements()

Checks whether the requirements are met.

public checkRequirements() : bool
Return values
bool

deactivate()

Deactivates a package.

public deactivate() : bool
Return values
bool

TRUE on success, FALSE on error

delete()

Deletes a package.

public delete() : bool
Return values
bool

TRUE on success, FALSE on error

factory()

Creates the manager for the package.

public static factory(rex_package $package) : static
Parameters
$package : rex_package

Package

Tags
template

TS as rex_package

psalm-param

TS $package

psalm-return

(TS is rex_plugin ? rex_plugin_manager : (TS is rex_addon ? rex_addon_manager : self))

Return values
static

generatePackageOrder()

Generates the package order.

public static generatePackageOrder() : void

getMessage()

Returns the message.

public getMessage() : string
Return values
string

install()

Installs a package.

public install([bool $installDump = true ]) : bool
Parameters
$installDump : bool = true

When TRUE, the sql dump will be importet

Tags
throws
rex_functional_exception
Return values
bool

TRUE on success, FALSE on error

synchronizeWithFileSystem()

Synchronizes the packages with the file system.

public static synchronizeWithFileSystem() : void

uninstall()

Uninstalls a package.

public uninstall([bool $installDump = true ]) : bool
Parameters
$installDump : bool = true

When TRUE, the sql dump will be importet

Tags
throws
rex_functional_exception
Return values
bool

TRUE on success, FALSE on error

__construct()

protected __construct(T $package, string $i18nPrefix) : mixed
Parameters
$package : T

Package

$i18nPrefix : string

Prefix for i18n

_delete()

Deletes a package.

protected _delete([bool $ignoreState = false ]) : bool
Parameters
$ignoreState : bool = false
Return values
bool

TRUE on success, FALSE on error

i18n()

Translates the given key.

protected i18n(string $key) : string
Parameters
$key : string

Key

Return values
string

Tranlates text

saveConfig()

Saves the package config.

protected static saveConfig() : void

wrongPackageId()

protected abstract wrongPackageId(string $addonName[, string $pluginName = null ]) : string
Parameters
$addonName : string
$pluginName : string = null
Return values
string

        
On this page

Search results