1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Package
  7. \
  8. PackageService

PackageService

class PackageService (View source)

Service class for the package entities and controllers.

Properties

protected Localization $localization

The Localization service instance.
protected Application $application

The Application container instance.
protected EntityManagerInterface $entityManager

The EntityManagerInterface instance.

Methods

__construct(Localization $localization, Application $application, EntityManagerInterface $entityManager)

Initialize the instance.

Package|null
getByHandle(string $pkgHandle)

Get a package entity given its handle.

Package|null
getByID(int $pkgID)

Get a package entity given its ID.

Package[]
getInstalledList()

Get the package entities of installed packages.

Package[]
getAvailablePackages(bool $onlyNotInstalled = true)

Get the package controllers of the available packages.

Package[]
getLocalUpgradeablePackages()

Get the controllers of packages that have newer versions in the local packages directory than those which are in the Packages table.

string[]
getInstalledHandles()

Get the handles of all the installed packages.

Package[]
getRemotelyUpgradeablePackages()

Get the controllers of the packages that have an upgraded version available in the marketplace.

bootPackageEntityManager(Package $p, bool $clearCache = false)

Initialize the entity manager for a package.

uninstall(Package $p)

Uninstall a package.

ErrorList|Package
install(Package $p, array $data)

Install a package.

Package
getClass(string $pkgHandle)

Get the controller of a package given its handle.

setupLocalization(LocalizablePackageInterface $package, string|null $locale = null, $translator = 'current') deprecated

No description

Details

at line 46
__construct(Localization $localization, Application $application, EntityManagerInterface $entityManager)

Initialize the instance.

Parameters

Localization $localization

the Localization service instance
Application $application

the Application container instance
EntityManagerInterface $entityManager

the EntityManagerInterface instance

at line 60
Package|null getByHandle(string $pkgHandle)

Get a package entity given its handle.

Parameters

string $pkgHandle

Return Value

Package|null

at line 74
Package|null getByID(int $pkgID)

Get a package entity given its ID.

Parameters

int $pkgID

Return Value

Package|null

at line 86
Package[] getInstalledList()

Get the package entities of installed packages.

Return Value

Package[]

at line 100
Package[] getAvailablePackages(bool $onlyNotInstalled = true)

Get the package controllers of the available packages.

Parameters

bool $onlyNotInstalled

true to get the controllers of not installed packages, false to get all the package controllers

Return Value

Package[]

at line 132
Package[] getLocalUpgradeablePackages()

Get the controllers of packages that have newer versions in the local packages directory than those which are in the Packages table.

This means they're ready to be upgraded.

Return Value

Package[]

at line 154
string[] getInstalledHandles()

Get the handles of all the installed packages.

Return Value

string[]

at line 172
Package[] getRemotelyUpgradeablePackages()

Get the controllers of the packages that have an upgraded version available in the marketplace.

Return Value

Package[]

at line 191
bootPackageEntityManager(Package $p, bool $clearCache = false)

Initialize the entity manager for a package.

Parameters

Package $p

The controller of package
bool $clearCache

Should the entity metadata cache be emptied?

at line 210
uninstall(Package $p)

Uninstall a package.

Parameters

Package $p

the controller of the package to be uninstalled

at line 228
ErrorList|Package install(Package $p, array $data)

Install a package.

Parameters

Package $p

the controller of the package to be installed
array $data

data to be passed to the Package::validate_install(), Package::install(), ContentSwapper::swapContent(), ContentSwapper::on_after_swap_content() methods

Return Value

ErrorList|Package

return an ErrorList instance in case of errors, the package controller otherwise

at line 265
Package getClass(string $pkgHandle)

Get the controller of a package given its handle.

Parameters

string $pkgHandle

Handle of package

Return Value

Package

at line 296
setupLocalization(LocalizablePackageInterface $package, string|null $locale = null, $translator = 'current') deprecated

deprecated

No description

Parameters

LocalizablePackageInterface $package
string|null $locale
$translator