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

BrokenPackage

class BrokenPackage extends Package (View source)

Constants

E_PACKAGE_NOT_FOUND

E_PACKAGE_INSTALLED

E_PACKAGE_VERSION

E_PACKAGE_DOWNLOAD

E_PACKAGE_SAVE

E_PACKAGE_UNZIP

E_PACKAGE_INSTALL

E_PACKAGE_MIGRATE_BACKUP

E_PACKAGE_INVALID_APP_VERSION

E_PACKAGE_THEME_ACTIVE

Properties

protected $DIR_PACKAGES_CORE from  Package
protected $DIR_PACKAGES from  Package
protected $REL_DIR_PACKAGES_CORE from  Package
protected $REL_DIR_PACKAGES from  Package
protected Package $entity from  Package
protected Application $app from  Package
protected Liaison $config from  Package
protected Liaison $fileConfig from  Package
protected bool deprecated $pkgEnableLegacyNamespace from  Package
protected array $pkgAutoloaderRegistries

Array of location -> namespace autoloader entries for the package. Will automatically be added to the class loader. (e.g. array('src/PortlandLabs' => \PortlandLabs')).

 from  Package
protected $appVersionRequired from  Package
protected $pkgAllowsFullContentSwap from  Package
protected $pkgContentProvidesFileThumbnails from  Package
protected DatabaseStructureManager $databaseStructureManager from  Package

Methods

Package
getPackageEntity()

No description

from  Package
setPackageEntity(Package $entity)

No description

from  Package
getApplication()

No description

from  Package
__construct($pkgHandle, Application $application)

No description

getContentSwapper()

No description

from  Package
installContentFile($file)

No description

from  Package
bool
shouldEnableLegacyNamespace()

Should this pacakge enable legacy namespaces.

from  Package
Liaison
getConfig()

Get the standard database config liaison.

from  Package
Liaison
getDatabaseConfig()

Get the standard database config liaison.

from  Package
Liaison
getFileConfig()

Get the standard filesystem config liaison.

from  Package
array
getPackageAutoloaderRegistries()

Returns custom autoloader prefixes registered by the class loader.

from  Package
getPackageHandle()

No description

from  Package
string
getPackageName()

Returns the translated name of the package.

from  Package
string
getPackageDescription()

Returns the translated package description.

from  Package
string
getPackageVersion()

Returns the installed package version.

from  Package
string
getApplicationVersionRequired()

Returns the version of concrete5 required by the package.

from  Package
bool
showInstallOptionsScreen()

Returns true if the package has an install options screen.

from  Package
hasInstallNotes()

No description

from  Package
hasUninstallNotes()

No description

from  Package
bool
hasInstallPostScreen()

Returns true if the package has a post install screen.

from  Package
allowsFullContentSwap()

No description

from  Package
getPackagePath()

No description

from  Package
string
getRelativePath()

Returns the path to the package's folder, relative to the install path.

from  Package
string
getRelativePathFromInstallFolder()

Returns the path starting from c5 installation folder to the package folder.

from  Package
getTranslationFile($locale)

No description

from  Package
string
contentProvidesFileThumbnails()

Returns a path to where the packages files are located.

from  Package
Package
install()

Installs the package info row and installs the database. Packages installing additional content should override this method, call the parent method, and use the resulting package object for further installs.

uninstall()

No description

from  Package
string
getChangelogContents()

Gets the contents of the package's CHANGELOG file. If no changelog is available an empty string is returned.

from  Package
static 
getInstalledList() deprecated

No description

from  Package
static 
getInstalledHandles() deprecated

No description

from  Package
static 
getByHandle($pkgHandle) deprecated

No description

from  Package
static 
getLocalUpgradeablePackages() deprecated

No description

from  Package
static 
getRemotelyUpgradeablePackages() deprecated

No description

from  Package
static 
getAvailablePackages($filterInstalled = true) deprecated

No description

from  Package
static 
getByID($pkgID) deprecated

No description

from  Package
static 
getClass($pkgHandle) deprecated

No description

from  Package
array|bool
testForInstall(bool $testForAlreadyInstalled = true)

This is the pre-test routine that packages run through before they are installed. Any errors that come here are to be returned in the form of an array so we can show the user. If it's all good we return true.

from  Package
getErrorText($result)

No description

from  Package
bool|int[]
testForUninstall()

No description

from  Package
backup()

Moves the current package's directory to the trash directory renamed with the package handle and a date code.

from  Package
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)

Installs a package's database from an XML file.

from  Package
upgradeCoreData()

Updates a package's name, description, version and ID 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 $withLeadingBacksalsh = false)

Get the namespace of the package by the package handle.

from  Package
EntityManager
getPackageEntityManager()

Create a entity manager used for the package installation, update and unistall process.

from  Package
destroyProxyClasses(EntityManagerInterface $em)

Destroys all proxies related to a package.

from  Package
getEntityManager() deprecated

No description

from  Package
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
getInstallErrorMessage()

No description

Details

in Package at line 91
Package getPackageEntity()

No description

Return Value

Package

in Package at line 100
setPackageEntity(Package $entity)

No description

Parameters

Package $entity

in Package at line 105
getApplication()

No description

at line 8
__construct($pkgHandle, Application $application)

No description

Parameters

$pkgHandle
Application $application

in Package at line 115
getContentSwapper()

No description

in Package at line 120
installContentFile($file)

No description

Parameters

$file

in Package at line 136
bool shouldEnableLegacyNamespace()

Should this pacakge 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 158
Liaison getConfig()

Get the standard database config liaison.

Return Value

Liaison

in Package at line 168
Liaison getDatabaseConfig()

Get the standard database config liaison.

Return Value

Liaison

in Package at line 182
Liaison getFileConfig()

Get the standard filesystem config liaison.

Return Value

Liaison

in Package at line 196
array getPackageAutoloaderRegistries()

Returns custom autoloader prefixes registered by the class loader.

Return Value

array

Keys represent the namespace, not relative to the package's namespace. Values are the path, and are relative to the package directory

in Package at line 201
getPackageHandle()

No description

in Package at line 211
string getPackageName()

Returns the translated name of the package.

Return Value

string

in Package at line 221
string getPackageDescription()

Returns the translated package description.

Return Value

string

in Package at line 231
string getPackageVersion()

Returns the installed package version.

Return Value

string

in Package at line 241
string getApplicationVersionRequired()

Returns the version of concrete5 required by the package.

Return Value

string

in Package at line 251
bool showInstallOptionsScreen()

Returns true if the package has an install options screen.

Return Value

bool

in Package at line 256
hasInstallNotes()

No description

in Package at line 261
hasUninstallNotes()

No description

in Package at line 271
bool hasInstallPostScreen()

Returns true if the package has a post install screen.

Return Value

bool

in Package at line 277
allowsFullContentSwap()

No description

in Package at line 282
getPackagePath()

No description

in Package at line 296
string getRelativePath()

Returns the path to the package's folder, relative to the install path.

Return Value

string

in Package at line 309
string getRelativePathFromInstallFolder()

Returns the path starting from c5 installation folder to the package folder.

Return Value

string

in Package at line 314
getTranslationFile($locale)

No description

Parameters

$locale

in Package at line 327
string contentProvidesFileThumbnails()

Returns a path to where the packages files are located.

Return Value

string

$path

at line 17
Package install()

Installs the package info row and installs the database. Packages installing additional content should override this method, call the parent method, and use the resulting package object for further installs.

Return Value

Package

in Package at line 359
uninstall()

No description

in Package at line 389
string getChangelogContents()

Gets the contents of the package's CHANGELOG file. If no changelog is available an empty string is returned.

Return Value

string

in Package at line 403
static getInstalledList() deprecated

deprecated

No description

in Package at line 412
static getInstalledHandles() deprecated

deprecated

No description

in Package at line 421
static getByHandle($pkgHandle) deprecated

deprecated

No description

Parameters

$pkgHandle

in Package at line 430
static getLocalUpgradeablePackages() deprecated

deprecated

No description

in Package at line 439
static getRemotelyUpgradeablePackages() deprecated

deprecated

No description

in Package at line 448
static getAvailablePackages($filterInstalled = true) deprecated

deprecated

No description

Parameters

$filterInstalled

in Package at line 457
static getByID($pkgID) deprecated

deprecated

No description

Parameters

$pkgID

in Package at line 466
static getClass($pkgHandle) deprecated

deprecated

No description

Parameters

$pkgHandle

in Package at line 481
array|bool testForInstall(bool $testForAlreadyInstalled = true)

This is the pre-test routine that packages run through before they are installed. Any errors that come here are to be returned in the form of an array so we can show the user. If it's all good we return true.

Parameters

bool $testForAlreadyInstalled

Return Value

array|bool

Returns an array of errors or true if the package can be installed

in Package at line 521
protected getErrorText($result)

No description

Parameters

$result

in Package at line 558
bool|int[] testForUninstall()

No description

Return Value

bool|int[]

true on success, array of error codes on failure

in Package at line 594
backup()

Moves the current package's directory to the trash directory renamed with the package handle and a date code.

in Package at line 620
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.

in Package at line 643
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 657
installDatabase()

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

in Package at line 663
installEntitiesDatabase()

No description

in Package at line 685
static bool|stdClass installDB(string $xmlFile)

Installs a package's database from an XML file.

Parameters

string $xmlFile

Path to the database XML file

Return Value

bool|stdClass

Returns false if the XML file could not be found

Exceptions

ConnectionException

in Package at line 718
upgradeCoreData()

Updates a package's name, description, version and ID using the current class properties.

in Package at line 734
upgrade()

Upgrades a package's database and refreshes all blocks.

in Package at line 754
upgradeDatabase()

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

Exceptions

ConnectionException
Exception

in Package at line 771
string getNamespace(bool $withLeadingBacksalsh = false)

Get the namespace of the package by the package handle.

Parameters

bool $withLeadingBacksalsh

Return Value

string

in Package at line 787
EntityManager getPackageEntityManager()

Create a entity manager used for the package installation, update and unistall process.

Return Value

EntityManager

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

Destroys all proxies related to a package.

Parameters

EntityManagerInterface $em

in Package at line 849
getEntityManager() deprecated

deprecated

No description

in Package at line 858
getPackageID() deprecated

deprecated This should be handled by the Concrete\Core\Entity\Package object, not by this object

No description

in Package at line 886
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>

at line 22
getInstallErrorMessage()

No description