Properties

$package

$package : \rex_package

Type

rex_package

$generatePackageOrder

$generatePackageOrder : bool

Type

bool

$message

$message : string

Type

string

Methods

factory()

factory(\rex_package  $package) : static

Creates the manager for the package.

Parameters

\rex_package $package

Package

Returns

static —

getMessage()

getMessage() : string

Returns the message.

Returns

string —

install()

install(bool  $installDump = true) : bool

Installs a package.

Parameters

bool $installDump

When TRUE, the sql dump will be importet

Throws

\rex_functional_exception

Returns

bool —

TRUE on success, FALSE on error

uninstall()

uninstall(bool  $installDump = true) : bool

Uninstalls a package.

Parameters

bool $installDump

When TRUE, the sql dump will be importet

Throws

\rex_functional_exception

Returns

bool —

TRUE on success, FALSE on error

activate()

activate() : bool

Activates a package.

Returns

bool —

TRUE on success, FALSE on error

deactivate()

deactivate() : bool

Deactivates a package.

Returns

bool —

TRUE on success, FALSE on error

delete()

delete() : bool

Deletes a package.

Returns

bool —

TRUE on success, FALSE on error

checkRequirements()

checkRequirements() : bool

Checks whether the requirements are met.

Returns

bool —

checkRedaxoRequirement()

checkRedaxoRequirement(string  $redaxoVersion) : bool

Checks whether the redaxo requirement is met.

Parameters

string $redaxoVersion

REDAXO version

Returns

bool —

checkPackageRequirement()

checkPackageRequirement(string  $packageId) : bool

Checks whether the package requirement is met.

Parameters

string $packageId

Package ID

Returns

bool —

checkConflicts()

checkConflicts() : bool

Checks whether the package is in conflict with other packages.

Returns

bool —

checkPackageConflict()

checkPackageConflict(string  $packageId) : bool

Checks whether the package is in conflict with another package.

Parameters

string $packageId

Package ID

Returns

bool —

checkDependencies()

checkDependencies() : bool

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

Returns

bool —

generatePackageOrder()

generatePackageOrder() : mixed

Generates the package order.

Returns

mixed —

synchronizeWithFileSystem()

synchronizeWithFileSystem() : mixed

Synchronizes the packages with the file system.

Returns

mixed —

setFactoryClass()

setFactoryClass(string  $subclass) : mixed

Sets the class for the factory.

Parameters

string $subclass

Classname

Throws

\InvalidArgumentException

Returns

mixed —

getFactoryClass()

getFactoryClass() : string

Returns the class for the factory.

Returns

string —

hasFactoryClass()

hasFactoryClass() : bool

Returns if the class has a custom factory class.

Returns

bool —

__construct()

__construct(\rex_plugin  $plugin) : mixed

Constructor.

Parameters

\rex_plugin $plugin

Plugin

Returns

mixed —

_delete()

_delete(bool  $ignoreState = false) : bool

Deletes a package.

Parameters

bool $ignoreState

Returns

bool —

TRUE on success, FALSE on error

wrongPackageId()

wrongPackageId(mixed  $addonName, mixed  $pluginName = null) : string

Parameters

mixed $addonName
mixed $pluginName

Returns

string —

i18n()

i18n(string  $key) : string

Translates the given key.

Parameters

string $key

Key

Returns

string —

Tranlates text

saveConfig()

saveConfig() : mixed

Saves the package config.

Returns

mixed —

callFactoryClass()

callFactoryClass(string  $method, array  $arguments) : mixed

Calls the factory class with the given method and arguments.

Parameters

string $method

Method name

array $arguments

Array of arguments

Returns

mixed —

Result of the callback