1. class
  2. Concrete
  3. \
  4. StartingPointPackage
  5. \
  6. AtomikBlank
  7. \
  8. Controller

Controller

class Controller extends StartingPointPackage (View source)

Constants

E_PACKAGE_NOT_FOUND

Error code: Invalid Package.
E_PACKAGE_INSTALLED

Error code: You've already installed that package.
E_PACKAGE_VERSION

Error code: This package requires Concrete version %s or greater.
E_PACKAGE_DOWNLOAD

Error code: An error occurred while downloading the package.
E_PACKAGE_SAVE

Error code: Concrete was not able to save the package after download.
E_PACKAGE_UNZIP

Error code: An error occurred while trying to unzip the package.
E_PACKAGE_INSTALL

Error code: An error occurred while trying to install the package.
E_PACKAGE_MIGRATE_BACKUP

Error code: Unable to backup old package directory to %s.
E_PACKAGE_INVALID_APP_VERSION

Error code: This package isn't currently available for this version of Concrete.
E_PACKAGE_THEME_ACTIVE

Error code: This package contains the active site theme, please change the theme before uninstalling.
E_PACKAGE_PHP_VERSION

Error code: This package requires PHP version %1$s or greater (the current PHP version is %2$s).

Properties

protected $DIR_PACKAGES_CORE from  StartingPointPackage
protected $DIR_PACKAGES from  StartingPointPackage
protected $REL_DIR_PACKAGES_CORE from  StartingPointPackage
protected $REL_DIR_PACKAGES from  StartingPointPackage
protected Package|null $entity

Associated package entity.

 from  Package
protected Application $app

The Application instance.

 from  Package
protected Liaison|null $config

The database configuration liaison.

 from  Package
protected Liaison|null $fileConfig

The file configuration liaison.

 from  Package
protected bool deprecated $pkgEnableLegacyNamespace from  Package
protected array $pkgAutoloaderRegistries

The custom autoloader prefixes to be automatically added to the class loader.

 from  Package
protected string $appVersionRequired

The minimum Concrete version compatible with the package.

 from  Package
protected string $phpVersionRequired

The minimum PHP version compatible with the package.

 from  Package
protected bool $pkgAllowsFullContentSwap

Override this value and set it to true if your package clears all existing website content when it's being installed.

 from  Package
protected array $pkgContentSwapFiles

Override this value to add additional content swap templates.

 from  Package
protected bool $pkgContentProvidesFileThumbnails

Override this value and set it to true if your package provides the file thumbnails.

 from  Package
protected string|null $backedUpFname

The full path of the package directory moved to the trash folder.

 from  Package
protected array $packageDependencies

An array describing the package dependencies.

 from  Package
protected $routines from  StartingPointPackage
protected InstallerOptions|null $installerOptions from  StartingPointPackage
protected $pkgHandle

Methods

__construct(Application $app)

Initialize the instance.

from  StartingPointPackage
Package|null
getPackageEntity()

Get the associated package entity (if available).

from  Package
setPackageEntity(Package $entity)

Set the associated package entity.

from  Package
array
getContentSwapFiles()

No description

from  Package
Package
setContentSwapFiles(array $pkgContentSwapFiles)

No description

from  Package
Application
getApplication()

Get the Application instance.

from  Package
ContentSwapperInterface
getContentSwapper()

Get the content swapper.

from  Package
installContentFile(string $file)

Import a concrete5-cif XML file.

from  Package
bool
shouldEnableLegacyNamespace()

Should this package enable legacy namespaces?

from  Package
Liaison
getConfig()

Get the default configuration liaison.

from  Package
Liaison
getDatabaseConfig()

Get the database configuration liaison.

from  Package
Liaison
getFileConfig()

Get the filesystem configuration liaison.

from  Package
array
getPackageAutoloaderRegistries()

Get the custom autoloader prefixes to be automatically added to the class loader.

from  Package
string
getPackageHandle()

Get the package handle.

from  Package
string
getPackageName()

Get the translated name of the package.

string
getPackageDescription()

Get the translated package description.

string
getPackageVersion()

Get the installed package version.

from  Package
string
getApplicationVersionRequired()

Get the minimum Concrete version compatible with the package.

from  Package
string
getPHPVersionRequired()

Get the minimum PHP version compatible with the package.

from  Package
bool
showInstallOptionsScreen()

Should the install options page be shown? The install options page may be for install notes and/or full contents swap confirmation.

from  Package
bool
hasInstallNotes()

Does this package have install notes?

from  Package
bool
hasUninstallNotes()

Does this package have uninstall notes?

from  Package
bool
hasInstallPostScreen()

Does this package have a post-install page?

from  Package
bool
allowsFullContentSwap()

Does this package clear all existing website content when it's being installed?

from  Package
string
getPackagePath()

Get the absolute path to the package.

from  Package
string
getRelativePath()

Get the path to the package relative to the web root.

from  Package
string
getRelativePathFromInstallFolder()

Get the path to the package relative to the Concrete installation folder.

from  Package
getTranslationFile($locale)

No description

from  Package
bool
contentProvidesFileThumbnails()

Does this package provide the file thumbnails? If false, the file thumbnails are generated during the install process.

from  Package
Package
install()

Install the package info row and the database (doctrine entities and db.xml).

from  Package
uninstall()

Uninstall the package:

  • delete the installed items associated to the package
  • destroy the package proxy classes of entities
  • remove the package info row.

from  Package
string
getChangelogContents()

Get the contents of the package's CHANGELOG file.

from  Package
static Package[]
getInstalledList() deprecated

No description

from  Package
static string[]
getInstalledHandles() deprecated

No description

from  Package
static Package|null
getByHandle(string $pkgHandle) deprecated

No description

from  Package
static Package[]
getLocalUpgradeablePackages() deprecated

No description

from  Package
static Package[]
getRemotelyUpgradeablePackages() deprecated

No description

from  Package
static Package[]
getAvailablePackages(bool $filterInstalled = true) deprecated

No description

from  Package
static Package|null
getByID(int $pkgID) deprecated

No description

from  Package
static Package
getClass(string $pkgHandle)

No description

from  StartingPointPackage
ErrorList|true
testForInstall(bool $testForAlreadyInstalled = true)

Perform tests before this package is installed.

from  Package
ErrorList|true
testForUpgrade()

Perform tests before this package is upgraded.

from  Package
ErrorList|true
testForUninstall()

Perform tests before this package is uninstalled.

from  Package
ErrorList|Package
backup()

Move the current package directory to the trash directory, and rename it with the package handle and a date code.

from  Package
bool
restore()

If a package was just backed up by this instance of the package object and the packages/package handle directory doesn't exist, this will restore the package from the trash.

from  Package
getPackageEntityPaths() deprecated

No description

from  Package
installDatabase()

Installs the packages database through doctrine entities and db.xml database definitions.

from  Package
installEntitiesDatabase()

No description

from  Package
static bool|stdClass
installDB(string $xmlFile, string $importMode = ContentImporter::IMPORT_MODE_UPGRADE)

Installs a package database from an XML file.

from  Package
upgradeCoreData()

Updates the package entity name, description and version using the current class properties.

from  Package
upgrade()

Upgrades a package's database and refreshes all blocks.

from  Package
upgradeDatabase()

Updates a package's database using entities and a db.xml.

from  Package
string
getNamespace(bool $withLeadingBackslash = false)

Get the namespace of the package by the package handle.

from  Package
EntityManager|null
getPackageEntityManager()

Create an entity manager used for the package install, upgrade and unistall process.

from  Package
EntityManagerInterface
getEntityManager() deprecated

No description

from  Package
int|null
getPackageID() deprecated

No description

from  Package
getTranslatableStrings(Translations $translations)

Override this method in your package controller to add strings to the translator, so that you can translate dynamically generated strings.

from  Package
array
getPackageDependencies()

Return the package dependencies.

from  Package
string
getErrorText(array|int $errorCode)

Get the error text corresponsing to an error code.

from  Package
destroyProxyClasses(EntityManagerInterface $em)

Destroys all proxies related to a package.

from  Package
int|null
getPHPVersionIDRequired()

Get the minimum PHP version compatible with the package.

from  Package
setInstallerOptions(InstallerOptions $installerOptions = null)

No description

from  StartingPointPackage
static 
hasCustomList()

No description

from  StartingPointPackage
static 
getAvailableList()

No description

from  StartingPointPackage
StartingPointInstallRoutine[]
getInstallRoutines()

No description

from  StartingPointPackage
executeInstallRoutine(string $routineName)

No description

from  StartingPointPackage
add_home_page()

No description

from  StartingPointPackage
install_data_objects()

No description

from  StartingPointPackage
install_attributes()

No description

from  StartingPointPackage
install_dashboard()

No description

from  StartingPointPackage
install_boards()

No description

from  StartingPointPackage
install_page_types()

No description

from  StartingPointPackage
install_required_single_pages()

No description

from  StartingPointPackage
install_blocktypes() deprecated

No description

from  StartingPointPackage
install_blocktypes_basic()

No description

from  StartingPointPackage
install_blocktypes_navigation()

No description

from  StartingPointPackage
install_blocktypes_form()

No description

from  StartingPointPackage
install_blocktypes_express()

No description

from  StartingPointPackage
install_blocktypes_social()

No description

from  StartingPointPackage
install_blocktypes_calendar()

No description

from  StartingPointPackage
install_blocktypes_multimedia()

No description

from  StartingPointPackage
install_blocktypes_core_desktop()

No description

from  StartingPointPackage
install_blocktypes_other()

No description

from  StartingPointPackage
install_themes()

No description

from  StartingPointPackage
install_tasks()

No description

from  StartingPointPackage
install_config()

No description

from  StartingPointPackage
install_file_manager()

No description

from  StartingPointPackage
import_files()

No description

from  StartingPointPackage
install_content()

No description

from  StartingPointPackage
install_desktops()

No description

from  StartingPointPackage
install_api()

No description

from  StartingPointPackage
install_database()

No description

from  StartingPointPackage
indexAdditionalDatabaseFields()

No description

from  StartingPointPackage
add_users()

No description

from  StartingPointPackage
make_directories()

No description

from  StartingPointPackage
finish()

No description

from  StartingPointPackage
install_permissions()

No description

from  StartingPointPackage
install_site()

No description

from  StartingPointPackage
install_site_permissions()

No description

from  StartingPointPackage

Details

in StartingPointPackage at line 67
__construct(Application $app)

Initialize the instance.

Parameters

Application $app

the application instance

in Package at line 271
Package|null getPackageEntity()

Get the associated package entity (if available).

Return Value

Package|null

May return NULL if the package is invalid and/or if it's not installed

in Package at line 283
setPackageEntity(Package $entity)

Set the associated package entity.

Parameters

Package $entity

in Package at line 291
array getContentSwapFiles()

No description

Return Value

array

in Package at line 299
Package setContentSwapFiles(array $pkgContentSwapFiles)

No description

Parameters

array $pkgContentSwapFiles

Return Value

Package

in Package at line 310
Application getApplication()

Get the Application instance.

Return Value

Application

in Package at line 320
ContentSwapperInterface getContentSwapper()

Get the content swapper.

Return Value

ContentSwapperInterface

in Package at line 330
installContentFile(string $file)

Import a concrete5-cif XML file.

Parameters

string $file

the path to the file, relative to the package directory

in Package at line 357
bool shouldEnableLegacyNamespace()

Should this package enable legacy namespaces?

This returns true IF:

  1. $this->pkgAutoloaderMapCoreExtensions is false or unset
  2. The required package version > 7.9.9 meaning version 8 or newer
  3. $this->pkgEnableLegacyNamespace is true

Return Value

bool

in Package at line 379
Liaison getConfig()

Get the default configuration liaison.

Return Value

Liaison

in Package at line 389
Liaison getDatabaseConfig()

Get the database configuration liaison.

Return Value

Liaison

in Package at line 403
Liaison getFileConfig()

Get the filesystem configuration liaison.

Return Value

Liaison

in Package at line 421
array getPackageAutoloaderRegistries()

Get the custom autoloader prefixes to be automatically added to the class loader.

Array keys are the locations (relative to the package directory). Array values are the paths (not relative to the package namespace).

Return Value

array

Examples

['src/PortlandLabs' => \PortlandLabs']

in Package at line 431
string getPackageHandle()

Get the package handle.

Return Value

string

at line 11
string getPackageName()

Get the translated name of the package.

Return Value

string

at line 16
string getPackageDescription()

Get the translated package description.

Return Value

string

in Package at line 461
string getPackageVersion()

Get the installed package version.

Return Value

string

in Package at line 471
string getApplicationVersionRequired()

Get the minimum Concrete version compatible with the package.

Return Value

string

in Package at line 486
string getPHPVersionRequired()

Get the minimum PHP version compatible with the package.

Return Value

string

Examples

'' if the package is compatible with any PHP version that's already compatible with the core
 
'8' if the package requires PHP 8.0.0 and later
 
'8.1' if the package requires PHP 8.1.0 and later
 
'8.1.20' if the package requires PHP 8.1.20 and later

in Package at line 497
bool showInstallOptionsScreen()

Should the install options page be shown? The install options page may be for install notes and/or full contents swap confirmation.

Return Value

bool

in Package at line 507
bool hasInstallNotes()

Does this package have install notes?

Return Value

bool

in Package at line 517
bool hasUninstallNotes()

Does this package have uninstall notes?

Return Value

bool

in Package at line 527
bool hasInstallPostScreen()

Does this package have a post-install page?

Return Value

bool

in Package at line 537
bool allowsFullContentSwap()

Does this package clear all existing website content when it's being installed?

Return Value

bool

in Package at line 547
string getPackagePath()

Get the absolute path to the package.

Return Value

string

in Package at line 563
string getRelativePath()

Get the path to the package relative to the web root.

Return Value

string

in Package at line 580
string getRelativePathFromInstallFolder()

Get the path to the package relative to the Concrete installation folder.

Return Value

string

in Package at line 590
getTranslationFile($locale)

No description

Parameters

$locale

See also

LocalizablePackageInterface::getTranslationFile

in Package at line 601
bool contentProvidesFileThumbnails()

Does this package provide the file thumbnails? If false, the file thumbnails are generated during the install process.

Return Value

bool

in Package at line 612
Package install()

Install the package info row and the database (doctrine entities and db.xml).

Packages installing additional content should override this method, call the parent method (parent::install()).

Return Value

Package

in Package at line 642
uninstall()

Uninstall the package:

  • delete the installed items associated to the package
  • destroy the package proxy classes of entities
  • remove the package info row.

in Package at line 684
string getChangelogContents()

Get the contents of the package's CHANGELOG file.

Return Value

string

if no changelog is available an empty string is returned

in Package at line 704
static Package[] getInstalledList() deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getInstalledList()

No description

Return Value

Package[]

in Package at line 715
static string[] getInstalledHandles() deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getInstalledHandles()

No description

Return Value

string[]

in Package at line 728
static Package|null getByHandle(string $pkgHandle) deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getByHandle($pkgHandle)

No description

Parameters

string $pkgHandle

Return Value

Package|null

in Package at line 739
static Package[] getLocalUpgradeablePackages() deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getLocalUpgradeablePackages()

No description

Return Value

Package[]

in Package at line 750
static Package[] getRemotelyUpgradeablePackages() deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getRemotelyUpgradeablePackages()

No description

Return Value

Package[]

in Package at line 763
static Package[] getAvailablePackages(bool $filterInstalled = true) deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getAvailablePackages($filterInstalled)

No description

Parameters

bool $filterInstalled

Return Value

Package[]

in Package at line 776
static Package|null getByID(int $pkgID) deprecated

deprecated Use $app->make('Concrete\Core\Package\PackageService')->getByID($pkgID)

No description

Parameters

int $pkgID

Return Value

Package|null

in StartingPointPackage at line 158
static Package getClass(string $pkgHandle)

No description

Parameters

string $pkgHandle

Return Value

Package

in Package at line 801
ErrorList|true testForInstall(bool $testForAlreadyInstalled = true)

Perform tests before this package is installed.

Parameters

bool $testForAlreadyInstalled

Set to false to skip checking if this package is already installed

Return Value

ErrorList|true

return true if the package can be installed, an ErrorList instance otherwise

in Package at line 844
ErrorList|true testForUpgrade()

Perform tests before this package is upgraded.

Return Value

ErrorList|true

return null if the package can be upgraded, an ErrorList instance otherwise

in Package at line 856
ErrorList|true testForUninstall()

Perform tests before this package is uninstalled.

Return Value

ErrorList|true

return true if the package can be uninstalled, an ErrorList instance otherwise

in Package at line 887
ErrorList|Package backup()

Move the current package directory to the trash directory, and rename it with the package handle and a date code.

Return Value

ErrorList|Package

return the Package instance if the package has been moved, an ErrorList instance otherwise

in Package at line 920
bool restore()

If a package was just backed up by this instance of the package object and the packages/package handle directory doesn't exist, this will restore the package from the trash.

Return Value

bool

in Package at line 949
getPackageEntityPaths() deprecated

deprecated This method was limited. It let you specify a location but in V8 with the Doctrine Entity Manager driver chain we also need to specify namespaces. Instead of specifying entity paths this way, update your package controller to implement the Concrete\Core\Database\EntityManager\Provider\ProviderAggregateInterface, and create a method named getEntityManagerProvider that returns an instance of the Concrete\Core\Database\EntityManager\Provider\ProviderInterface. For example, if I want to specify that my package has entities found at src/PortlandLabs\FooBar\Entity, with the namespace PortlandLabs\FooBar\Entity, my method is simply public function getEntityManagerProvider() { return new StandardPackageProvider($this->app, $this, ['src/MSM/Entity' => 'PortlandLabs\MSM\Entity']); }

No description

in Package at line 962
installDatabase()

Installs the packages database through doctrine entities and db.xml database definitions.

in Package at line 972
installEntitiesDatabase()

No description

in Package at line 998
static bool|stdClass installDB(string $xmlFile, string $importMode = ContentImporter::IMPORT_MODE_UPGRADE)

Installs a package database from an XML file.

Parameters

string $xmlFile

Path to the database XML file
string $importMode
  • If set to ContentImporter::IMPORT_MODE_UPGRADE, the schema will be checked against the current schema, supporting upgrades at a performance penalty. If set to ContentImporter::IMPORT_MODE_INSTALL the schema will be compared against an empty schema, which is a much faster operation and should be used when you know the installation is taking place against an empty database. ContentImporter::IMPORT_MODE_UPGRADE preserves backward compatibility as this was the way things always used to be handled.

Return Value

bool|stdClass

Returns false if the XML file could not be found

Exceptions

ConnectionException

in Package at line 1046
upgradeCoreData()

Updates the package entity name, description and version using the current class properties.

in Package at line 1062
upgrade()

Upgrades a package's database and refreshes all blocks.

in Package at line 1088
upgradeDatabase()

Updates a package's database using entities and a db.xml.

Exceptions

ConnectionException
Exception

in Package at line 1105
string getNamespace(bool $withLeadingBackslash = false)

Get the namespace of the package by the package handle.

Parameters

bool $withLeadingBackslash

Return Value

string

in Package at line 1117
EntityManager|null getPackageEntityManager()

Create an entity manager used for the package install, upgrade and unistall process.

Return Value

EntityManager|null

in Package at line 1160
EntityManagerInterface getEntityManager() deprecated

deprecated Use $app->make('Doctrine\ORM\EntityManagerInterface')

No description

Return Value

EntityManagerInterface

in Package at line 1171
int|null getPackageID() deprecated

deprecated use the getPackageID method of the package entity

No description

Return Value

int|null

in Package at line 1198
getTranslatableStrings(Translations $translations)

Override this method in your package controller to add strings to the translator, so that you can translate dynamically generated strings.

Parameters

Translations $translations

Examples

If you add to this method these two strings:

<code>
$translations->insert('', 'String without context');
$translations->insert('MyContext', 'String with context');
</code>

Then you'll be able to translate these two strings in the Translator and write translated strings with:

<code>
echo t('String without context');
echo tc('MyContext', 'String with context');
</code>

in Package at line 1209
array getPackageDependencies()

Return the package dependencies.

Return Value

array

See also

Package::$packageDependencies

in Package at line 1221
protected string getErrorText(array|int $errorCode)

Get the error text corresponsing to an error code.

Parameters

array|int $errorCode

one of the Package::EPACKAGE constants, or an array with the first value is one of the Package::EPACKAGE constants and the other values are used to fill in fields

Return Value

string

in Package at line 1254
protected destroyProxyClasses(EntityManagerInterface $em)

Destroys all proxies related to a package.

Parameters

EntityManagerInterface $em

in Package at line 1283
protected int|null getPHPVersionIDRequired()

Get the minimum PHP version compatible with the package.

Return Value

int|null

Examples

null if the package is compatible with any PHP version that's already compatible with the core
 
80000 if the package requires PHP 8.0.0 and later
 
80100 if the package requires PHP 8.1.0 and later
 
80120 if the package requires PHP 8.1.20 and later

in StartingPointPackage at line 111
setInstallerOptions(InstallerOptions $installerOptions = null)

No description

Parameters

InstallerOptions $installerOptions

in StartingPointPackage at line 118
static hasCustomList()

No description

in StartingPointPackage at line 131
static getAvailableList()

No description

in StartingPointPackage at line 177
StartingPointInstallRoutine[] getInstallRoutines()

No description

Return Value

StartingPointInstallRoutine[]

in StartingPointPackage at line 188
executeInstallRoutine(string $routineName)

No description

Parameters

string $routineName

Exceptions

Exception
Throwable

in StartingPointPackage at line 212
protected add_home_page()

No description

in StartingPointPackage at line 217
protected install_data_objects()

No description

in StartingPointPackage at line 245
protected install_attributes()

No description

in StartingPointPackage at line 254
protected install_dashboard()

No description

in StartingPointPackage at line 260
protected install_boards()

No description

in StartingPointPackage at line 266
protected install_page_types()

No description

in StartingPointPackage at line 272
protected install_required_single_pages()

No description

in StartingPointPackage at line 282
protected install_blocktypes() deprecated

deprecated This method has been splitted in smaller chunks

No description

in StartingPointPackage at line 296
protected install_blocktypes_basic()

No description

in StartingPointPackage at line 302
protected install_blocktypes_navigation()

No description

in StartingPointPackage at line 308
protected install_blocktypes_form()

No description

in StartingPointPackage at line 314
protected install_blocktypes_express()

No description

in StartingPointPackage at line 320
protected install_blocktypes_social()

No description

in StartingPointPackage at line 326
protected install_blocktypes_calendar()

No description

in StartingPointPackage at line 332
protected install_blocktypes_multimedia()

No description

in StartingPointPackage at line 338
protected install_blocktypes_core_desktop()

No description

in StartingPointPackage at line 344
protected install_blocktypes_other()

No description

in StartingPointPackage at line 350
protected install_themes()

No description

in StartingPointPackage at line 361
protected install_tasks()

No description

in StartingPointPackage at line 367
protected install_config()

No description

in StartingPointPackage at line 373
protected install_file_manager()

No description

in StartingPointPackage at line 405
protected import_files()

No description

in StartingPointPackage at line 417
protected install_content()

No description

in StartingPointPackage at line 423
protected install_desktops()

No description

in StartingPointPackage at line 429
protected install_api()

No description

in StartingPointPackage at line 435
protected install_database()

No description

in StartingPointPackage at line 485
protected indexAdditionalDatabaseFields()

No description

in StartingPointPackage at line 493
protected add_users()

No description

in StartingPointPackage at line 577
protected make_directories()

No description

in StartingPointPackage at line 605
protected finish()

No description

in StartingPointPackage at line 689
protected install_permissions()

No description

in StartingPointPackage at line 695
protected install_site()

No description

in StartingPointPackage at line 712
protected install_site_permissions()

No description