diff --git a/.ddev/config.yaml b/.ddev/config.yaml
index b0478b76..94579c56 100644
--- a/.ddev/config.yaml
+++ b/.ddev/config.yaml
@@ -1,7 +1,7 @@
name: contao-utils-bundle
type: php
docroot: ""
-php_version: "7.4"
+php_version: "8.1"
webserver_type: nginx-fpm
router_http_port: "80"
router_https_port: "443"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 3a5c7cdb..a16d100b 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -9,13 +9,8 @@ jobs:
strategy:
fail-fast: false
matrix:
- php: [ 7.2, 7.3, 7.4, 8.0, 8.1 ]
- contao: [ 4.9.*, 4.13.* ]
- exclude:
- - php: 7.2
- contao: 4.13.*
- - php: 7.3
- contao: 4.13.*
+ php: [ 8.1, 8.2 ]
+ contao: [ 4.13.*, 5.2.* ]
steps:
- name: Setup PHP
@@ -31,7 +26,7 @@ jobs:
- name: Install the dependencies
id: composer-install
- run: composer require contao/core-bundle:${{ matrix.contao }} --no-interaction
+ run: composer require contao/core-bundle:${{ matrix.contao }} contao/test-case:${{ matrix.contao }} --no-interaction
- name: Run the unit tests
if: steps.composer-install.conclusion == 'success' && steps.composer-install.outcome == 'success'
@@ -43,7 +38,7 @@ jobs:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
- php-version: 7.4
+ php-version: 8.2
extensions: dom, fileinfo, filter, gd, hash, intl, json, mbstring, pcre, pdo, zlib
coverage: xdebug
tools: php-cs-fixer, phpunit
@@ -52,7 +47,7 @@ jobs:
uses: actions/checkout@v3
- name: Install the dependencies
- run: composer require contao/core-bundle:4.13.* --no-interaction
+ run: composer require contao/core-bundle:4.13.* contao/test-case:4.13.* --no-interaction
- name: Generate the coverage report
run: php vendor/bin/phpunit -c phpunit.xml.dist --coverage-clover build/logs/clover.xml
@@ -70,7 +65,7 @@ jobs:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
- php-version: 8.0
+ php-version: 8.2
- name: Checkout
uses: actions/checkout@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3b37d8df..ffb4a1d2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,2072 +2,8 @@
All notable changes to this project will be documented in this file.
-## [2.229.2] - 2023-09-07
-- Fixed: undefined method exception in RequestCleaner
-
-## [2.229.1] - 2023-09-06
-- Fixed: PHP8 warning fix for `getImageData()` in `Twig\ImageExtension.php`
-- Changed: method collection/reflection, cosmetic improvements in `Classes\ClassUtil.php`
-
-## [2.229.0] - 2023-08-28
-- Changed: removed request bundle dependency
-
-## [2.228.2] - 2023-08-17
-- Fixed: missing alt text in image twig tag
-
-## [2.228.1] - 2023-07-04
-- Fixed: compatibility issue with symfony 3
-
-## [2.228.0] - 2023-05-22
-- Added: absolute url option to RequestUtil::generateBackendRoute() ([#65])
-
-## [2.227.1] - 2023-04-27
-- Fixed: warnings
-- Deprecated: StringUtil::startWith and StringUtil::endsWith
-
-## [2.227.0] - 2023-04-05
-- Changed: reduced usage of request bundle ([#64])
-- Deprecated: UrlUtil::removeQueryStringParameterToUrl() (renamed to removeQueryStringParameterFromUrl())
-- Fixed: typo in UrlUtil::removeQueryStringParameterToUrl()
-- Fixed: various warnings
-- Fixed: various deprecations
-
-## [2.226.1] - 2023-03-20
-- Fixed: warning in ImageUtil
-
-## [2.226.0] - 2023-02-24
-- Added: Check Util folder with phpstan ([#63])
-- Added: Util/DcaUtil::getDcaFields() ([#62])
-- Deprecated: DcaUtil::getFields()
-
-## [2.225.0] - 2023-01-25
-- Added: UrlUtil to Utils service ([#61])
-
-## [2.224.2] - 2023-01-20
-- Fixed: overwritten picture property of ImageExtension
-
-## [2.224.1] - 2023-01-18
-- Fixed: array index issue
-
-## [2.224.0] - 2023-01-02
-- Added: HtmlUtil::generateDataAttributesString() ([#60])
-
-## [2.223.3] - 2022-12-23
-- Fixed: php8-related bug
-
-## [2.223.2] - 2022-12-21
-- Fixed: Exception if Choice is used as options callback
-
-## [2.223.1] - 2022-12-20
-- Fixed: Choices cache not taking locale into account
-- Fixed: used deprecated ServiceSubscriber if available in AbstractServiceSubscriber
-
-## [2.223.0] - 2022-11-09
-- Added: HtmlUtil ([#59])
-
-## [2.222.1] - 2022-11-07
-- Fixed: used wrong argument in entity finder for blocks
-
-## [2.222.0] - 2022-10-17
-- Changed: migrated AccordionUtil::structureAccordionSingle()
-- Fixed: used non namespaced twig error class
-
-## [2.221.2] - 2022-10-17
-- Changed: updated dependencies
-- Fixed: accordion util not respect element start and end date ([#58])
-- Fixed: ci pipeline used outdated actions
-
-
-## [2.221.1] - 2022-10-05
-- Fixed: [IcsUtil] set endDate to startDate if not set
-
-## [2.221.0] - 2022-09-27
-- Added: entity finder helper ([#53])
-- Added: news support to entity finder ([#53])
-
-## [2.220.1] - 2022-09-20
-- Fixed: 2.220.0 breaks contao 4.4 support
-
-## [2.220.0] - 2022-09-20
-- Changed: Migrate routing util to utils ([#56])
-- Fixed: array index issue
-
-## [2.219.0] - 2022-09-13
-- Added: RequestUtil::isIndexPage() ([#55])
-- Fixed: font name evaluation in FPDFIWriter
-
-## [2.218.1] - 2022-07-18
-- Fixed: PHP 8 warning
-
-## [2.218.0] - 2022-07-15
-- Added: Utils::user::findActiveUsersByGroup() (migrated from user util) ([#51])
-
-## [2.217.2] - 2022-06-07
-- Fixed: patchwork utf8 class used ([#50])
-
-## [2.217.1] - 2022-06-07
-- Fixed: typed properties in FileUtil
-
-## [2.217.0] - 2022-05-31
-- Added: Utils::file::getPathFromUuid()
-- Added: Utils::request::getCurrentRootPageModel()
-- Fixed: [DatabaseUtil] invalid field name added to dca
-- Fixed: Warnings in php 8
-- Deprecated: FileUtils::getPathFromUuid();
-
-## [2.216.0] - 2022-05-17
-- Added: ArrayUtil::insertAfterKey() ([#47])
-- Fixed: DcaUtil::doGenerateDcOperationsButtons() for 4.13 ([#46])
-
-## [2.215.2] - 2022-05-09
-- Fixed: display special chars in alt attribute
-
-## [2.215.1] - 2022-05-05
-- Fixed: incompatiblity with symfony 5
-
-## [2.215.0] - 2022-05-03
-- Changed: Update utils class structure ([#44])
-- Changed: Migrate ArrayUtil::removeValue ([#45])
-
-## [2.214.0] - 2022-04-28
-- Added: Utils/RequestUtil::getBaseUrl()
-- Changed: migrated RequestUtil::isNewVisitor() to Utils/RequestUtil
-- Deprecated: RequestUtil
-
-## [2.213.0] - 2022-04-08
-- Added: [Entity finder] allow search for inserttags from event (added `ExtendEntityFinderEvent::addInserttag()`)
-- Fixed: [Entity finder] only one parent found for each entity
-
-## [2.212.1] - 2022-03-28
-- Fixed: a potential error upon cache warmup and a missing system/tmp folder ([#43], [@qzminski])
-
-## [2.212.0] - 2022-03-22
-- Added: entity finder ([#42])
-- Fixed: some incompatibilities with different symfony versions ([#42])
-
-## [2.211.0] - 2022-03-07
-- Added: Utils/DcaUtils::getPaletteFields()
-- Changed: updated test setup
-
-## [2.210.1] - 2022-02-28
-- Fixed: exception in DcaUtil
-- Fixed: deprecation
-- Fixed: missing parameter in DcaUtil test
-
-## [2.210.0] - 2022-02-23
-- Added: DcaUtils::explodePalette() in Utils namespace
-
-## [2.209.6] - 2022-02-16
-
-- Fixed: array index issues in php 8+
-
-## [2.209.5] - 2022-02-16
-
-- Fixed: array index issues in php 8+
-
-## [2.209.4] - 2022-02-15
-
-- Fixed: array index issues in php 8+
-
-## [2.209.3] - 2022-02-14
-
-- Fixed: array index issues in php 8+
-
-## [2.209.2] - 2022-02-14
-
-- Fixed: array index issues in php 8+
-
-## [2.209.1] - 2022-02-10
-
-- Fixed: `DatabaseUtil::composeWhereForQueryBuilder()` for contao 4.13+
-
-## [2.209.0] - 2022-02-09
-- Fixed: `ContainerUtil::isMaintenanceModeActive()` for contao 4.13+
-
-## [2.208.1] - 2022-01-18
-- Fixed: invalid composer.json
-
-## [2.208.0] - 2022-01-18
-- Added: AccordionUtil in Utils namespace
-- Changed: rewrote AccordionUtil::structureAccordionStartStop() to support nested accordions ([#40])
-- Fixed: test configuration for Utils and AbstractServiceSubscriber classes
-
-## [2.207.0] - 2021-12-21
-- Added: ModelUtil to Utils service (most services are migrated, but not all now)
-- Added: UserUtil to Utils service (not all services migrated)
-- Added: ArrayUtil to Utils service (with one method)
-- Deprecated: most ModelUtil methods
-- Fixed: coverage report used contao 4.4
-- Fixed: some test setup issues
-
-## [2.206.1] - 2021-10-13
-- Fixed: contao 4.4 incompatible code in DcaUtil
-
-## [2.206.0] - 2021-10-13
-
-- Added: RequestUtil::getCurrentPageModel() ([#37])
-- Added: AbstractServiceSubscriber to make service subscriber compatible to symfony 3, 4 and 5 ([#39])
-- Changed: ContainerUtil::isPreviewMode() now uses TokenChecker::isPreviewMode() where available (Contao 4.5+) ([#37])
-- Changed: Refactored ContainerUtil and Utils class inheriting from AbstractServiceSubscriber
-- Fixed: failing tests ([#37])
-- Fixed: remove FrontendPageListener as it add linebreak to czech language pages with many side effects, that must be an optional feature. If you need such a functionality, please add a listener by yourself! ([#38])
-- Fixed: service subscriber not registered correctly ([#39])
-
-## [2.205.3] - 2021-10-08
-
-- Fixed: UserUtil::findActiveByGroups(#35)
-
-## [2.205.2] - 2021-09-27
-
-- Added: missing default value for author field
-
-## [2.205.1] - 2021-09-24
-
-- Changed: separator character from `_` to `-` (file sanitize)
-
-## [2.205.0] - 2021-09-22
-
-- Added: config parameter `skipReplaceInsertTags` in `FormUtil::prepareSpecialValueForOutput()`
-
-## [2.204.2] - 2021-09-17
-
-- Fixed: visibility of `FileUtil::getParentFoldersByUuid()`
-
-## [2.204.1] - 2021-09-15
-
-- Fixed: preview mode for contao 4.9
-
-## [2.204.0] - 2021-09-03
-
-- Added: new option `selectFields` for `DatabaseUtil::findResultByPk()`, `DatabaseUtil::findOneResultBy()`, `DatabaseUtil::findResultsBy()`
-- Changed: enhanced ContainerUtil documentation
-- Deprecated: deprecated the old StringUtil class as whole
-- Fixed: issues with CI
-
-## [2.203.3] - 2021-08-17
-
-- Fixed: `CreateImageSizeItemsCommand`
-
-## [2.203.2] - 2021-08-17
-
-- Changed: Refactored `CreateImageSizeItemsCommand` -> external method now available
-
-## [2.203.1] - 2021-08-11
-
-- Fixed: SalutationUtil methods for "other" gender
-
-## [2.203.0] - 2021-08-11
-
-- Added: translations for "other" gender
-
-## [2.202.4] - 2021-08-10
-
-- Fixed: `DcaUtil::addAuthorFieldAndCallback()` -> default value for author is not 0 again (BC)
-
-## [2.202.3] - 2021-07-26
-
-- fixed palette manipulator handling in `DcaUtil::flattenPaletteForSubEntities()`
-
-## [2.202.2] - 2021-07-26
-
-- fixed palette manipulator handling in `DcaUtil::flattenPaletteForSubEntities()`
-
-## [2.202.1] - 2021-07-26
-
-- fixed palette handling issues in `DcaUtil::flattenPaletteForSubEntities()` by using `PaletteManipulator`
-- fixed return object in `DatabaseUtil::update()` and `DatabaseUtil::delete()`
-
-## [2.202.0] - 2021-07-20
-
-- added twig filter `|bin2uuid` in order to convert a binary uuid to a textual one
-
-## [2.201.0] - 2021-07-20
-
-- added documentation for command `huh:utils:create-image-size-items`
-
-## [2.200.0] - 2021-07-15
-
-- enhanced `ModelInstanceChoice` to respect more title fields and contain the ID
-
-## [2.199.1] - 2021-07-15
-
-- fixed new author type for `DcaUtil::addAuthorFieldAndCallback()`: php session id (disabled to readonly)
-
-## [2.199.0] - 2021-07-15
-
-- added new author type for `DcaUtil::addAuthorFieldAndCallback()`: php session id (not changeable in backend; only
- visible in backend if it had been set before in frontend -> then readonly)
-
-## [2.198.0] - 2021-07-14
-
-- added `DcaUtil::isSubPaletteField()`
-- added `DcaUtil::getSubPaletteFieldSelector()`
-
-## [2.197.0] - 2021-07-13
-
-- added possibility to add a custom database object to `DatabaseUtil::insert()`, `DatabaseUtil::update()`
- and `DatabaseUtil::delete()`
-
-## [2.196.3] - 2021-07-09
-
-- fixed bug in DcaUtil::aliasExist()
-
-## [2.196.2] - 2021-07-07
-
-- fixed bug in deprecated StringUtil::camelCaseToDashed()
-
-## [2.196.1] - 2021-07-05
-
-- fixed install issue with symfony 5
-
-## [2.196.0] - 2021-07-01
-
-- Add utils service and migrate services to Util namespace ([#24])
-- refactored ClassUtil and ModelUtil to use dependency injection
-- updates some test and skipped some tests to make github action working
-
-## [2.195.1] - 2021-06-29
-
-- fixed twig filter `|file_content`
-
-## [2.195.0] - 2021-06-29
-
-- added Polish translations
-
-## [2.194.1] - 2021-06-24
-
-- enhanced `DcaUtil::generateAlias()` (now supports customizable alias field name)
-
-## [2.194.0] - 2021-06-18
-
-- added `DcaUtil::getCurrentPaletteName()`
-
-## [2.193.1] - 2021-06-09
-
-- fixed twig filter `|file_content`
-
-## [2.193.0] - 2021-06-01
-
-- added `jsonPost()` in javascript ajax util
-- fixed issues in js ajax util
-
-## [2.192.2] - 2021-05-28
-
-- fixed js method `DomUtil::getTextWithoutChildren()`
-
-## [2.192.1] - 2021-05-17
-
-- fixed hours tranformation for ISO8601 (#31)
-
-## [2.192.0] - 2021-04-16
-
-- added `fields` option for `DcaUtil::setFieldsToReadOnly()`
-
-## [2.191.0] - 2021-03-23
-
-- added params for operators IN and NOT IN in DatabaseUtil::composeWhereForQueryBuilder (#29)
-
-## [2.190.0] - 2021-03-11
-
-- added ImageUtil::prepareImage()
-
-## [2.189.0] - 2021-03-10
-
-- experimental allowed php 8
-- deprecated PDFCreator in favor of PDFCreator library
-- moved from samidoc to phpDocumentator
-- fixed deprecation in Configuration class
-
-## [2.188.10] - 2021-02-22
-
-- fixed missing symfony/config component
-
-## [2.188.9] - 2021-02-15
-
-- avoid replaceInsertTags getting invalid path
-
-## [2.188.8] - 2021-02-15
-
-- fixed choice cache (not run in the constructor anymore)
-
-## [2.188.7] - 2021-02-09
-
-- fixed autowiring for UserUtil and MemberUtil
-
-## [2.188.6] - 2021-02-01
-
-- fixed twig picture template if width or height are null
-
-## [2.188.5] - 2021-01-18
-
-- added PersonTrait to UserUtil and MemberUtil, added tests for PersonTrait (#26)
-
-## [2.188.4] - 2021-01-18
-
-- **BC BREAK**: fixed error in `DatabaseUtil::composeWhereForQueryBuilder()` -> `IN` and `NOT IN` statement with empty
- values leads to an unfullfillable condition, not to skipping the filter anymore (since it was a bug, the bc break was
- necessary)
-
-## [2.188.3] - 2021-01-15
-
-- fixed sorting in `ModelInstanceChoice` to be a natural sorting (switched asort to natcasesort)
-
-## [2.188.2] - 2021-01-11
-
-- fixed missing public service attributes for twig extensions (contao 4.9+)
-
-## [2.188.1] - 2020-12-22
-
-- fixed random fields added in loadDataContainer hooks not added to the database (#25)
-
-## [2.188.0] - 2020-12-18
-
-- added support for page specific date/time formats in DateUtil
-
-## [2.187.0] - 2020-12-15
-
-- started preparation for next major version with a new bundle and extension class (old ones are still available, but
- should not be referenced anymore, see [Upgrade guide](UPGRADE.md)) (#23)
-- [BEHAVIOR CHANGE] added configuration option for databaseTreeCache warmer, cache warmer for databasetree cache is not
- executed by default anymore, but can be activated by configuration, see [Readme](README.md) (#23)
-- added option to disabled the inclusion of utils bundle assets (#23)
-- updated encore bundle integration, minimum supported encore bundle version is now 1.5
-
-## [2.186.0] - 2020-12-15
-
-- fixed DownloadExtension (see https://github.com/heimrichhannot/contao-utils-bundle/issues/22)
-
-## [2.185.0] - 2020-11-30
-
-- added DatabaseUtil::createWhereForSerializedBlob() option parameter and inline_values option
-
-## [2.184.1] - 2020-11-25
-
-- fixed loading attribute has no default value in picture.html.twig
-- enhance an annotation in ModelUtil
-
-## [2.184.0] - 2020-11-24
-
-- added `DateUtil::convertSecondsToHumanReadableFormat()`
-
-## [2.183.0] - 2020-11-23
-
-- added support for `loading` attribute if set from outside (lazy loading)
-
-## [2.182.1] - 2020-11-10
-
-- added a parameter to `DcaUtil::setDefaultsFromDca()` for BC reasons
-
-## [2.182.0] - 2020-11-10
-
-- fixed `DcaUtil::setDefaultsFromDca()` to also respect sql default values
-
-## [2.181.4] - 2020-11-05
-
-- added check for empty request in `ContainerUtil` (e.g. in command situations)
-
-## [2.181.3] - 2020-10-28
-
-- fixed `UrlUtil::getBaseUrl` to enable non-app_dev.php base url for versions later than 4.8
-
-## [2.181.2] - 2020-10-13
-
-- fixed twig image filter not allowed image size to be an id or name
-
-## [2.181.1] - 2020-10-06
-
-- modified autowiring for InsertTagsListener
-
-## [2.181.0] - 2020-10-06
-
-- refactored InsertTagsListener
-- added Tests for InsertTagsListener
-
-## [2.180.2] - 2020-10-05
-
-- changed template rendering in InsertTagsListener::replaceTwigTag() to TemplateUtil::renderTwigTemplate
-
-## [2.180.1] - 2020-09-30
-
-- fix remove dump from image_gallery template
-
-## [2.180.0] - 2020-09-28
-
-- added `IcsUtil`
-
-## [2.179.0] - 2020-09-22
-
-- added `ContentUtil`
-
-## [2.178.2] - 2020-09-18
-
-- do not throw error when calling protected or private methods in ClassUtil::jsonSerialize() when ignoreMethodVisibility
- is set to true
-
-## [2.178.1] - 2020-09-15
-
-- added state as possibility for `LocationUtil::computeCoordinatesByString()`
-
-## [2.178.0] - 2020-09-09
-
-- js: added `GeneralUtil.runRecursiveFunction()`
-
-## [2.177.6] - 2020-08-31
-
-- fixed class inheritance for CfgTagModel to respect the one existing
-
-## [2.177.5] - 2020-08-26
-
-- added missing default check for includeCopyright in `image.html.twig`
-
-## [2.177.4] - 2020-08-25
-
-- fixed uncatched errors in DcaUtil::getConfigByArrayOrCallbackOrFunction() when used in frontend and contao 4.9
-
-## [2.177.3] - 2020-08-20
-
-- fixed caption and copyrights issue in `image.html.twig` -> the flag `includeCopyright` has to be added
- to `image.html.twig` in order to print the copyright without a caption set
-
-## [2.177.2] - 2020-08-20
-
-- removed database tree cache for `tl_page` from utils-bundle since only needed for contao-blocks
-- fixed missing prefixes in database tree cache
-
-## [2.177.1] - 2020-08-19
-
-- fixed caption and copyrights issue
-
-## [2.177.0] - 2020-08-19
-
-- added callbacks to PdfCreator
-
-## [2.176.1] - 2020-08-19
-
-- fixed MpdfCreator font directory support
-
-## [2.176.0] - 2020-08-18
-
-- added PdfCreator as replacement for PdfWriterpull
-
-## [2.175.2] - 2020-08-13
-
-- show twig template start and stop comments in dev mode
-
-## [2.175.1] - 2020-08-12
-
-- fixed comparison issue in `DatabaseUtil::doBulkInsert()`
-
-## [2.175.0] - 2020-08-11
-
-- added support for divers gender-based salutations
-
-## [2.174.0] - 2020-08-07
-
-- added possibility to add a custom backend route in `DcaUtil::getPopupWizardLink()`
-
-## [2.173.1] - 2020-07-22
-
-- added alias for curlRequestUtil
-
-## [2.173.0] - 2020-07-22
-
-- DcaUtil::generateAlias() now accepts null as table parameter to skip unique check
-
-## [2.172.1] - 2020-07-21
-
-- fixed a error with php version prior to 7.4
-
-## [2.172.0] - 2020-07-21
-
-- added DcaUtil::aliasExist()
-
-## [2.171.5] - 2020-07-20
-
-- fixed UrlUtil::getCurrentUrl() options parameter not optional
-
-## [2.171.4] - 2020-07-16
-
-- fixed `StringExtension::autolink()` (German dates like 15.7. have been translated to links)
-
-## [2.171.3] - 2020-07-16
-
-- fixed unicode characters for `StringUtil::replaceUnicodeEmojisByHtml()` to also contain skin tones
-
-## [2.171.2] - 2020-07-15
-
-- added latest unicode characters for `StringUtil::replaceUnicodeEmojisByHtml()`
-
-## [2.171.1] - 2020-07-06
-
-- fixed type hinting
-
-## [2.171.0] - 2020-06-30
-
-- added ignoreLogin to `MemberUtil::findActiveByGroups()`
-
-## [2.170.0] - 2020-06-30
-
-- fixed attributes issue in `image.html.twig` -> now link gets its correct `attributes`; "wrong" `linkAttributes` is
- still in place for compatibility reasons
-- fixed lightbox issues in `ImageUtil::addToTemplate()`
-
-## [2.169.2] - 2020-06-23
-
-- fixed `DatabaseUtil::findResultsBy()` to accept also null as columns and values
-
-## [2.169.1] - 2020-06-23
-
-- fixed `DcaUtil::generateAlias()`
-
-## [2.169.0] - 2020-06-23
-
-- added `ContainerUtil::isPreviewMode()`
-
-## [2.168.2] - 2020-06-23
-
-- fixed `DcaUtil::generateAlias()`
-
-## [2.168.1] - 2020-06-23
-
-- fixed `DcaUtil::generateAlias()`
-
-## [2.168.0] - 2020-06-23
-
-- fixed `DcaUtil::generateAlias()`
-
-## [2.167.0] - 2020-06-22
-
-- added `FileUtil::getExtensionFromFileContent()`
-- added `FileUtil::getExtensionByMimeType()`
-- fixed `FileUtil::retrieveFileContent()`
-
-## [2.166.0] - 2020-06-19
-
-- added `FileUtil::retrieveFileContent()`
-
-## [2.165.0] - 2020-06-15
-
-- added option to pass multiple tables into `DcaUtil::generateAlias()` as a comma separated list
-
-## [2.164.2] - 2020-06-10
-
-- fixed warning if no result in `DcaUtil::generateAlias()`
-
-## [2.164.1] - 2020-05-29
-
-- fixed size issue in twig image filter
-
-## [2.164.0] - 2020-05-25
-
-- added new twig filter `|file_content` (takes uuid as binary or string)
-
-## [2.163.0] - 2020-05-13
-
-- added new tests to `TestExtension`
-- fixed copyright issue in `image.html.twig`
-
-## [2.162.0] - 2020-04-28
-
-- revoked 2.161.0 and 2.161.1 due to problems in contao 4.9 -> pages can't be saved anymore
-
-## [2.161.0] - 2020-04-24
-
-- added TemplateLocator class
-- enhanced UtilsCacheWarmer
-- some code enhancements
-
-## [2.160.0] - 2020-04-22
-
-- added `TestExtension` for checking types in twig (e.g. `if [] is string` or `if '1' is numeric`)
-
-## [2.159.1] - 2020-04-22
-
-- fixed type hinting for `DateUtil::generateAlias()`
-
-## [2.159.0] - 2020-04-21
-
-- added `choices.yml` containing the service definitions for the choices
-
-## [2.158.0] - 2020-04-21
-
-- added `DatabaseUtil::beginTransaction()` and `DatabaseUtil::commitTransaction()`
-
-## [2.157.3] - 2020-04-21
-
-- fixed types in `DatabaseUtil`
-
-## [2.157.2] - 2020-04-20
-
-- fixed types in replaceInsertTags() from StringUtil
-
-## [2.157.1] - 2020-04-16
-
-- removed `select()` from `DatabaseUtil` as it's already covered by the various `findBy` methods
-
-## [2.157.0] - 2020-04-16
-
-- added `DcaUtil::getNewSortingPosition()`
-
-## [2.156.1] - 2020-04-14
-
-- fixed session bug for contao 4.9 in `LocationUtil`
-
-## [2.156.0] - 2020-04-14
-
-- added `DatabaseUtil::select()`
-
-## [2.155.2] - 2020-04-09
-
-- fixed PageUtil service definition for symfony 4
-
-## [2.155.1] - 2020-04-08
-
-- added empty check for `imageSize` in `ImageUtil`
-
-## [2.155.0] - 2020-04-08
-
-- added `PageUtil`
-
-## [2.154.0] - 2020-04-06
-
-- added attributes and linkText option to DcaUtil::getPopupWizardLink()
-
-## [2.153.0] - 2020-04-06
-
-- partly rewrote DcaUtil::getPopupWizardLink()
-- deprecated DcaUtil::getPopupWizardLink() string as first parameter
-- updated documentation
-- updated tests
-
-## [2.152.1] - 2020-04-06
-
-- fixed `StringUtil::replaceInsertTags()`
-
-## [2.152.0] - 2020-04-03
-
-- added `StringUtil::replaceInsertTags()`
-
-## [2.151.1] - 2020-03-26
-
-- fixed `UrlUtil::getBaseUrl()`
-
-## [2.151.0] - 2020-03-26
-
-- added `ContainerUtil::isMaintenanceModeActive()`
-
-## [2.150.0] - 2020-03-19
-
-- added `UserUtil::isAdmin()`
-
-## [2.149.0] - 2020-03-17
-
-- added `FileUtil::getParentFoldersByUuid()`
-
-## [2.148.1] - 2020-03-12
-
-- updated documentation
-
-## [2.148.0] - 2020-03-12
-
-- added FileStorageUtil as replacement for FileCache
-- deprecated FileCache
-- replaced FileCache with FileStorageUtil in PdfPreview
-- fixed PdfPreview not working when destination folder does not exist2.148.
-
-## [2.147.0] - 2020-03-10
-
-- fixed nested record style
-
-## [2.146.0] - 2020-03-10
-
-- added `DcaExtension`
-- added `DcaExtension::fieldLabel`
-
-## [2.145.0] - 2020-03-09
-
-- added `DatabaseUtil::insert()`
-- added `DatabaseUtil::update()`
-- added `DatabaseUtil::delete()`
-
-## [2.144.0] - 2020-03-06
-
-- added `DcaUtil::prepareRowEntryForList()`
-- added `DcaUtil::getFieldLabel()`
-
-## [2.143.0] - 2020-03-05
-
-- added `DcaUtil::getRenderedDiff()`
-- added `ArrayUtil::implodeRecursive()`
-
-## [2.142.0] - 2020-03-05
-
-- added `DcaUtil::setFieldsToReadOnly()`
-- added `DcaUtil::getTranslatedModuleNameByTable()`
-
-## [2.141.1] - 2020-03-03
-
-- added option `restrictFields` to `FormUtil::getModelDataAsNotificationTokens()`
-
-## [2.141.0] - 2020-03-03
-
-- added DateUtil::getDaysBetween()
-- fixed UrlUtil::getBaseUrl()
-
-## [2.140.0] - 2020-03-02
-
-- fixed service definitions for contao 4.9
-
-## [2.139.0] - 2020-02-27
-
-- added UrlUtil::getBaseUrl()
-
-## [2.138.0] - 2020-02-27
-
-- added FormUtil::getModelDataAsNotificationTokens()
-
-## [2.137.0] - 2020-02-26
-
-- added DcaUtil::activateNotificationType()
-
-## [2.136.1] - 2020-02-26
-
-- fixed adding formData to uri
-- updated dependencies
-
-## [2.136.0] - 2020-02-26
-
-- added DcaUtil::getAuthorNameLinkByUserId and DcaUtil::getAuthorNameByUserId
-
-## [2.135.2] - 2020-02-26
-
-- fixed DcaUtil::loadLanguageFile()
-
-## [2.135.1] - 2020-02-19
-
-- fixed PdfWriter::generate() to generate correct path
-
-## [2.135.0] - 2020-02-18
-
-- added UrlUtil::getRelativePath()
-
-## [2.134.0] - 2020-02-17
-
-- added absoluteUrl option to UrlUtil::removeQueryString()
-- added absoluteUrl option to UrlUtil::prepareUrl()
-- added RequestUtil::isNewVisitor()
-- deprecated UrlUtil::isNewVisitor()
-
-## [2.133.0] - 2020-02-06
-
-- added label formatting for `ModelInstanceChoice`
-
-## [2.132.0] - 2020-02-05
-
-- added `replace_inserttag` twig filter
-
-## [2.131.0] - 2020-02-03
-
-- added `AnonymizerUtil` with email anonymizer
-- added `anonymize_email` twig filter
-
-## [2.130.0] - 2020-01-30
-
-- added `FileUtil::getFolderContent()`
-- added `DatabaseUtil::findResultsBy()`
-
-## [2.129.0] - 2020-01-27
-
-- added `FileUtil::getFileIdFromPath()`
-
-## [2.128.1] - 2020-01-27
-
-- added reference for php operators
-
-## [2.128.0] - 2020-01-23
-
-- added comparison util
-
-## [2.127.0] - 2020-01-16
-
-- added support for dc_multilingual 4
-
-## [2.126.0] - 2020-01-09
-
-- added `DatabaseUtil::findResultByPk()`
-- added `DatabaseUtil::findOneResultBy()`
-
-## [2.125.0] - 2020-01-07
-
-- added `ContainerUtil::isDev()`
-
-## [2.124.0] - 2019-12-13
-
-- updated `DcaUtil::getDataContainers()` to list all database data containers
-- added `DcaUtil::getDataContainers()` option to only list database data containers
-- updated dca util tests
-
-## [2.123.1] - 2019-12-11
-
-- added `ContainerUtil::isFrontendCron()`
-- fixed `StringUtil::replaceUnicodeEmojisByHtml()`
-
-## [2.123.0] - 2019-11-27
-
-- replace inserttags in `FormUtil::prepareSpecialValueForOutput`
-
-## [2.122.0] - 2019-11-26
-
-- `CreateImageSizeCommand`
-
-## [2.121.0] - 2019-11-21
-
-- added video twig template
-
-## [2.120.1] - 2019-11-14
-
-- updated some service definitions for better symfony 4 compatibility
-
-## [2.120.0] - 2019-11-12
-
-- added `RsceUtil`
-
-## [2.119.4] - 2019-11-05
-
-- fixed module isSubModuleOf in ModuleUtil
-
-## [2.119.3] - 2019-11-05
-
-- fixed accordion ptable
-
-## [2.119.2] - 2019-11-05
-
-- fixed CfgTagModel
-
-## [2.119.1] - 2019-10-30
-
-### Fixed
-
-- margins in FPDIWriter
-- text length calculation in StringUtil::truncateHtml
-
-## [2.119.0] - 2019-10-28
-
-### Added
-
-- support for exists() in filedata twig filter
-
-## [2.118.0] - 2019-10-28
-
-### Added
-
-- copyright support for image
-
-## [2.117.2] - 2019-10-23
-
-### Fixed
-
-- location util
-
-## [2.117.1] - 2019-10-22
-
-### Fixed
-
-- download extension
-
-## [2.117.0] - 2019-10-21
-
-### Added
-
-- polyfills to package.json: `element-closest`, `nodelist-foreach-polyfill`
-
-## [2.116.0] - 2019-10-10
-
-### Added
-
-- ModuleUtil::getModuleClass
-
-### Fixed
-
-- ModuleUtil::isSubModuleOf
-
-## [2.115.0] - 2019-10-01
-
-### Added
-
-- js: event-util::createEventObject
-
-## [2.114.0] - 2019-09-30
-
-### Added
-
-- graceful degredation for picture (svg)
-
-## [2.113.0] - 2019-09-20
-
-### Removed
-
-- choice caching from AbstractChoice for backend
-
-## [2.112.0] - 2019-09-17
-
-### Added
-
-- ArrayExtension
-
-## [2.111.0] - 2019-09-17
-
-### Added
-
-- StringUtil::replaceUnicodeEmojisByHtml()
-
-## [2.110.0] - 2019-09-03
-
-### Added
-
-- subClass for dc operations template
-
-### Changed
-
-- DcaUtil::generateDcOperationsButtons() -> support for options
-
-## [2.109.0] - 2019-09-03
-
-### Added
-
-- styling for backend sub records
-
-## [2.108.0] - 2019-08-29
-
-### Changed
-
-- DateUtil::getFormattedDateTime() now supports translating months
-
-### Fixed
-
-- issues in DateUtil::getFormattedDateTime()
-
-## [2.107.0] - 2019-08-27
-
-### Added
-
-- StringExtension (twig)
-
-## [2.106.0] - 2019-08-16
-
-### Changed
-
-- enhanced DcaUtil::doGenerateDcOperationsButtons()
-
-### Added
-
-- DcaUtil::getPopupWizardLink()
-
-## [2.105.0] - 2019-08-14
-
-### Added
-
-- ContainerUtil::isInstall()
-
-## [2.104.4] - 2019-08-13
-
-### Changed
-
-- DcaUtil::addAuthorFieldAndCallback() has an additional parameter for prefixing the fields now
-
-## [2.104.3] - 2019-08-08
-
-### Fixed
-
-- removed trailing comma in FPDIWriter (#11)
-
-## [2.104.2] - 2019-08-07
-
-### Fixed
-
-- autowiring issue with FolderUtil and Symfony 4 (#9)
-
-## [2.104.1] - 2019-08-07
-
-### Changed
-
-- updated tests
-
-## [2.104.0] - 2019-08-06
-
-### Added
-
-- FPDIWriter
-
-### Changed
-
-- refactored PdfWriter
-
-## [2.103.1] - 2019-08-05
-
-### Fixed
-
-- parameter name (tmp_folder instead of tmpFoldergit st)
-
-## [2.103.0] - 2019-08-05
-
-### Added
-
-- FileArchiveUtil (huh.utils.file_archive)
-- FolderUtil (huh.utils.folder)
-- Configuration
-
-## [2.102.0] - 2019-07-31
-
-### Added
-
-- FileUtil::getFileContentFromUuid()
-- LocationUtil::getCoordinatesFromGpx()
-- LocationUtil::getCoordinatesFromKml()
-- StringUtil::convertXmlToArray()
-
-## [2.101.1] - 2019-07-29
-
-### Fixed
-
-- ajax FormData issue
-
-## [2.101.0] - 2019-07-10
-
-### Added
-
-- node module ajax-util set responseType
-
-## [2.100.2] - 2019-07-09
-
-### Fixed
-
-- debug code in files util
-
-## [2.100.1] - 2019-06-28
-
-### Fixed
-
-- js ajaxUtil for supporting objects
-
-## [2.100.0] - 2019-06-24
-
-### Added
-
-- `ImageExtension::getImageGallery()`
-
-## [2.99.1] - 2019-06-17
-
-### Changed
-
-- submitted data in request
-
-## [2.99.0] - 2019-06-17
-
-### Added
-
-- `image_gallery` as Twig extension to show gallery items as image objects as list
-
-## [2.98.3] - 2019-06-14
-
-### Added
-
-- `readableFilesize` as Twig attribute to `FileExtension.php` in TwigUtil
-
-## [2.98.2] - 2019-06-14
-
-### Added
-
-- description for usage of js ajaxUtil in readme
-
-## [2.98.1] - 2019-06-14
-
-### Changed
-
-- moved afterSubmit callback in ajax util to correct position
-
-## [2.98.0] - 2019-06-13
-
-### Changed
-
-- moved js from component directly into bundle
-
-## [2.97.2] - 2019-06-11
-
-### Fixed
-
-- service injection
-
-## [2.97.1] - 2019-06-06
-
-### Fixed
-
-- `huh.utils.dca` method `addAliasToDca` now properly supports replacement of fields by considering fieldset and field
- separator (comma and semikolon)
-
-## [2.97.0] - 2019-05-29
-
-### Changed
-
-- removed `srcset` parameter related to `source` inside `picture.html.twig` to fix mobile issues
-
-## [2.96.0] - 2019-05-07
-
-### Added
-
-- `aspectRatio` parameter (boolean) support added to `lazyload` attribute inside `picture.html.twig`
-
-## [2.95.0] - 2019-05-07
-
-### Added
-
-- FormUtil::getBackendFormField()
-
-## [2.94.0] - 2019-04-29
-
-### Changed
-
-- replaced `html2text/html2text` with `soundasleep/html2text` due to GPL licence (`html2text/html2text`) incompatibility
-
-## [2.93.0] - 2019-04-26
-
-### Changed
-
-- replaced `roderik/pwgen-php` with `hackzilla/password-generator` due to GPL licence (`roderik/pwgen-php`)
- incompatibility
-
-### Added
-
-- GNU LESSER GENERAL PUBLIC LICENSE
-
-## [2.91.2] - 2019-04-26
-
-### Fixed
-
-- database error in AccordionUtil::structureAccordionSingle()
-
-## [2.91.1] - 2019-04-25
-
-### Fixed
-
-- w3c validator error in `picture.html.twig` occured by lazyload technique
-
-## [2.91.0] - 2019-04-25
-
-### Added
-
-- invoke `huh.utils.listener.frontend_page` that ensure line breaks for several languages (in cs for instance one
- syllable words like a should stay together, e.g. `a stavět` -> `a stavět`)
-
-## [2.90.3] - 2019-04-18
-
-### Added
-
-- add possibility to invoke custom lazy loading config into `picture.html.twig`
-
-## [2.90.2] - 2019-04-18
-
-### Changed
-
-- inject service container in DateUtil
-- updated tests
-- updated documentation
-
-### Fixed
-
-- loadDataContainer Hook error when empty database
-
-## [2.90.1] - 2019-04-18
-
-### Fixed
-
-- non-public services in ContainerUtil
-
-## [2.90.0] - 2019-04-16
-
-### Changed
-
-- made $fileExtension parameter optional in FileCache::exist() and FileCache::get()
-- FileCache now uses kernel.project_dir instead of contao.web_dir for root path
-- refactoring due changes in internal coding standards
-- refactored service loading into Plugin class
-- updated a lot of tests
-
-### Fixed
-
-- FileCache::getNamespace() error when namespace not initialized
-
-### Fixed
-
-- possible warnings in AccordionUtil
-
-## [2.89.2] - 2019-04-09
-
-### Changed
-
-- `huh.utils.form` method `prepareSpecialValueForOutput` for `multiColumnEditor` formatted with linebreaks and tabs
-
-## [2.89.1] - 2019-04-09
-
-### Changed
-
-- `huh.utils.form` method `prepareSpecialValueForOutput` now supports `multiColumnEditor` bundle only
-
-## [2.89.0] - 2019-04-08
-
-### Changed
-
-- `DcaUtil::getFields()`: order in label swapped for usability reasons
-
-## [2.88.0] - 2019-04-08
-
-### Changed
-
-- default modal width to 1024 in `DcaUtil::getModalEditLink()` and `DcaUtil::getArchiveModalEditLink`
-
-### Fixed
-
-- `DcaUtil::getEditLink()` now respects symfony environment
-- `DcaUtil::getModalEditLink` now respects symfony environment
-- `DcaUtil::getArchiveModalEditLink` now respects symfony environment
-
-## [2.87.4] - 2019-04-08
-
-### Added
-
-- `UrlUtil::getJumpToPageUrl()`
-- `UrlUtil::addAutoItemToPage()`
-
-## [2.87.3] - 2019-04-08
-
-### Fixed
-
-- `ModuleUtil::getModulesByType()`
-
-## [2.87.2] - 2019-04-08
-
-### Fixed
-
-- `ModuleUtil::isSubModuleOf()`
-
-## [2.87.1] - 2019-04-08
-
-### Added
-
-- error handling for coordinate retrieval
-- `LocationUtil::computeCoordinatesInSaveCallback()`
-
-## [2.87.0] - 2019-04-08
-
-### Added
-
-- tl_settings::utilsGoogleApiKey as a central point for specifying a google api key
-- localizations
-
-## [2.86.2] - 2019-03-29
-
-### Fixed
-
-- TemplateUtil::isTemplatePartEmpty treated null as not empty
-
-## [2.86.1] - 2019-03-27
-
-### Fixed
-
-- drop `hash` and `handle` from Twig Extension (`FileExtension`), big performance impact due to additional db/file
- system access
-
-## [2.86.0] - 2019-03-25
-
-### Added
-
-- `huh.utils.string` ensureLineBreaks() that fixes line breaks for one-syllable words in czech language (should not
- stand alone at the end), this is done by `huh.utils.listener.frontend_page` listener automatically
-
-## [2.85.0] - 2019-03-25
-
-### Added
-
-- ModuleUtil
-- DateUtil::getFormattedDateTime(), DateUtil::getFormattedDateTimeByEvent()
-- DcaUtil::loadLanguageFile()
-- MemberUtil::findOrCreate()
-
-### Fixed
-
-- MemberUtil
-- DcaUtil
-
-## [2.84.1] - 2019-03-21
-
-### Fixed
-
-- twig templates did not render error messages, because they were catched before in ClassUtil and Twig Extensions
-
-## [2.84.0] - 2019-03-20
-
-### Added
-
-- polyfills for js
-
-### Changed
-
-- js generation to use webpack 0.24+
-
-## [2.83.1] - 2019-03-15
-
-### Fixed
-
-- added `ignoreMethods` to prevent file access in twig `FileExtension`
-
-## [2.83.0] - 2019-03-14
-
-### Added
-
-- added options support for `skippedMethods` and `ignoreMethods` in `huh.utils.class` method `jsonSerialize`
-- catch Exceptions in `huh.utils.class` method `jsonSerialize` method calls in order to skip invalid method calls and
- continue serialization
-- twig `FileExtension` ('file_data`) now skips all file content related method calls and magic getter properties (handle
- out of memory exceptions)
-
-## [2.82.1] - 2019-03-14
-
-### Changed
-
-- added some polish translations
-
-## [2.82.0] - 2019-03-14
-
-### Changed
-
-- updated dependency `tijsverkoyen/css-to-inline-styles` to ^2.2
-
-## [2.81.2] - 2019-03-12
-
-### Fixed
-
-- `queryBuilder->setParameter` can't handle `.` in wildcard parameter. Replaced `.` in wildcard with `_`
-
-## [2.81.1] - 2019-03-08
-
-### Fixed
-
-- added missing closing `
` tag in `image.html.twig` (did not tag 2.80.1)
-
-## [2.81.0] - 2019-03-08
-
-### Added
-
-- FileExtension
-
-## [2.80.1] - 2019-03-08
-
-### Fixed
-
-- added missing closing `
` tag in `image.html.twig`
-
-## [2.80.0] - 2019-03-08
-
-### Changed
-
-- `image.html.twig` syntax is now compatible with `heimrichhannot/contao-speed-bundle` lazyload component from
- version `1.8`
-
-## [2.75.1] - 2019-03-06
-
-### Fixed
-
-- `eventUtil::addDynamicEventListener()` now check that `matches` function exist in object
-
-## [2.75.0] - 2019-03-05
-
-### Fixed
-
-- `eventUtil::addDynamicEventListener()` argument `scope` added (default: `document`) and moved `disableBubbling` to 5th
- argument
-- `eventUtil::addDynamicEventListener()` now works with window eventListeners like `load` or `resize`
-
-## [2.74.0] - 2019-02-26
-
-### Changed
-
-- `ImageExtension:getImage()` $template parameter no longer yields namespace, now uses `huh.utils.template`
- method `getTemplate`
-
-### Added
-
-- `RenderTwigTemplateEvent` (huh.utils.template.render) to manipulate template name and context data before rendering
- twig templates
-- ratio, width and height parameter to picture attribute in `huh.utils.image` addToTemplateData
-
-## [2.73.0] - 2019-02-20
-
-### Added
-
-- `getParentRecords` added in `huh.utils.cache.database_tree`
-
-## [2.72.0] - 2019-02-20
-
-### Added
-
-- `getPreviewFromPdf` method in `huh.utils.file`
-
-## [2.71.0] - 2019-02-20
-
-### Added
-
-- twig filter `image_data` in `ImageExtension` to get image data as array
-
-## [2.70.2] - 2019-02-19
-
-### Fixed
-
-- compile error due calling `System:getContainer` in `TemplateUtil` constructor
-
-## [2.70.1] - 2019-02-19
-
-### Fixed
-
-- `TemplateUtil::getTemplateGroup` now returns file extension in file name if not html.twig
-
-## [2.70.0] - 2019-02-18
-
-### Changed
-
-- `TemplateUtil` now supports all twig formats
-- `TemplateUtil::getTemplate` now throws an error if template not exist
-
-## [2.69.1] - 2019-02-15
-
-### Added
-
-- `label_callback` argument `$context` in `huh.utils.choice.model_instance`
-
-## [2.69.0] - 2019-02-14
-
-### Added
-
-- `label_callback` added to `$context` in order to adjust label in `huh.utils.choice.model_instance`
-
-## [2.68.2] - 2019-02-13
-
-### Fixed
-
-- AccordionUtil
-
-## [2.68.1] - 2019-02-12
-
-### Fixed
-
-- `huh.utils.cache.database_tree` now properly clear cache on `oncut_callback`, `ondelete_callback`, `onsubmit_callback`
-- `huh.utils.template` returned wrong path for `/templates` twig templates
-- Unit test errors
-
-## [2.68.0] - 2019-02-11
-
-### Added
-
-- `huh.utils.cache.database_tree` to replace `Database->getChildRecords()` and provide proper caching
-
-## [2.67.2] - 2019-02-08
-
-### Fixed
-
-- JavaScript webpack generation issue
-
-### Removed
-
-- package.json -> browserslist (now using the default option)
-
-## [2.67.1] - 2019-02-08
-
-### Fixed
-
-- JavaScript: `domUtil.getAllParentNodes()`
-
-## [2.67.0] - 2019-02-05
-
-### Added
-
-- `tns-lazy-img` class to `picture.html.twig` in order to
- fix `https://github.com/heimrichhannot/contao-tiny-slider-list-bundle` lazy load handling on ios safari
-
-## [2.66.1] - 2019-02-04
-
-### Added
-
-- `huh.utils.template` method `getTemplate` returns template name plus format if no template was found
-
-## [2.66.0] - 2019-02-04
-
-### Added
-
-- `huh.cache.warm_internal` service that provides an twig template cache in production mode (for performance reasons)
-- `huh.utils.template` method `getAllTemplates` that provides better cache handling, invoked on every contao request
- as `initializeSystem` Hook
-
-### Fixed
-
-- `huh.utils.template` template caching, improves performance on method `getTemplate` by factor 4
-
-## [2.65.2] - 2019-01-29
-
-### Fixed
-
-- ModelUtil columns array issue
-
-## [2.65.1] - 2019-01-28
-
-### Fixed
-
-- ModelInstanceChoice::collect()
-
-## [2.65.0] - 2019-01-25
-
-### Removed
-
-- `DcaUtil::addDcMultilingualSupport`
-- `DcaUtil::addDcMultilingualTranslatableAliasEval`
-
--> please
-use [heimrichhannot/contao-dc-multilingual-utils-bundle](https://github.com/heimrichhannot/contao-dc-multilingual-utils-bundle)
-instead
-
-## [2.64.1] - 2019-01-24
-
-### Fixed
-
-- lazyload in `picture.html.twig` only set `height` (do not set `width`, otherwise lazyload will break)
-
-## [2.64.0] - 2019-01-24
-
-### Added
-
-- `StringUtil::camelCaseToSnake`
-
-## [2.63.0] - 2019-01-24
-
-### Added
-
-- DcaUtil::addDcMultilingualTranslatableAliasEval
-- support for table prefixed fields in DatabaseUtil::composeWhereForQueryBuilder()
-
-### Fixed
-
-- ModelUtil::findParentsRecursively() order issue
-
-## [2.62.0] - 2019-01-24
-
-### Changed
-
-- lazyload in `picture.html.twig` now uses `width` and `height` styles instead of `padding-bottom`
-- removed `attributes` from anchor inside `image.html.twig` and added `linkAttributes`
-
-## [2.61.0] - 2019-01-23
-
-### Changed
-
-- js workflow optimized
-- yarn dependency `contao-utils-bunlde` to `@hundh/contao-utils-bundle`
-
-## [2.60.8] - 2019-01-22
-
-### Fixed
-
-- js
-
-## [2.60.7] - 2019-01-18
-
-### Fixed
-
-- correct calculation of padding for portrait format images in picture template
-
-## [2.60.6] - 2019-01-08
-
-### Changed
-
-- names of util params in singular
-
-## [2.60.5] - 2019-01-07
-
-### Fixed
-
-- adept fixes from 2.60.4 for `TemplateUtil::getBundleTemplate` and `TemplateUtil::getTemplate`
-
-## [2.60.4] - 2019-01-07
-
-### Fixed
-
-- `TemplateUtil::getTemplateGroup` now finds all twig templates in views, not just `html.twig`
-
-## [2.60.3] - 2018-12-21
-
-### Fixed
-
-- set class from img on `image-wrapper` in `picture.html.twig` to handle padding-bottom dimensions (border)
-
-## [2.60.2] - 2018-12-21
-
-### Fixed
-
-- added styles to `picture.html.twig` that adjusts padding-bottom for media query image sizes
-
-## [2.60.1] - 2018-12-19
-
-### Fixed
-
-- js utils
-
-## [2.60.0] - 2018-12-19
-
-### Fixed
-
-- refactoring for js utils
-
-## [2.59.2] - 2018-12-17
-
-### Fixed
-
-- Make `AccordionUtil` work with multiple articles per page
-
-## [2.59.1] - 2018-12-17
-
-### Fixed
-
-- Make `AccordionUtil` work with multiple articles per page
-
-## [2.59.0] - 2018-12-17
-
-### Added
-
-- DcaUtil::addDcMultilingualSupport()
-
-### Fixed
-
-- ModelUtil::fixTablePrefixForDcMultilingual() to support "order" in Model's $options
-
-## [2.58.0] - 2018-12-14
-
-### Added
-
-- `attributes` parameter to `download.html.twig`
-
-## [2.57.0] - 2018-12-13
-
-### Changed
-
-- size parameter in ImageExtension now also supports serialized strings
-
-## [2.56.1] - 2018-12-12
-
-### Fixed
-
-- ModelUtil::addPublishedCheckToModelArrays()
-
-## [2.56.0] - 2018-12-12
-
-### Added
-
-- `figureAttributes` attribute to `image.html.twig`
-
-## [2.55.0] - 2018-12-12
-
-### Added
-
-- ModelUtil::callModelMethod(), ModelUtil::addPublishedCheckToModelArrays()
-
-## [2.54.0] - 2018-12-12
-
-### Added
-
-- DcaUtil::getDCTable()
-
-### Fixed
-
-- localization issue in FormUtil::prepareSpecialValueForOutput()
-
-## [2.53.0] - 2018-12-11
-
-### Added
-
-- css classes from img-class `contao picture sizes` added to `figure` element with prefix `figure-`
-
-## [2.52.0] - 2018-12-07
-
-### Added
-
-- ClassUtil::callInaccessibleMethod()
-
-## [2.51.1] - 2018-12-06
-
-### Fixed
-
-- strict comparison issues
-
-## [2.51.0] - 2018-12-06
-
-### Added
-
-- DcaUtil::generateSitemap()
-
-## [2.50.0] - 2018-12-04
-
-### Added
-
-- `image_width` and `image_caption` twig filters
-
-## [2.49.3] - 2018-11-30
-
-### Fixed
-
-- Added missing twig template for `DownloadExtension`
-
-## [2.49.2] - 2018-11-30
-
-### Fixed
-
-- DateUtil
-
-## [2.49.1] - 2018-11-30
-
-### Fixed
-
-- replace inserttags in Twig `DownloadExtension`
-
-## [2.49.0] - 2018-11-30
-
-### Fixed
-
-- urldecode file path in Twig `DownloadExtension` to support
-
-### Added
-
-- Twig Plugin `DownloadExtension` function `download_title`
-
-## [2.48.0] - 2018-11-30
-
-### Added
-
-- Twig Plugin `DownloadExtension` with `download`, `download_link`, `download_path`, `download_data`
-
-## [2.47.1] - 2018-11-29
-
-### Fixed
-
-- `huh.util.image` addToTemplateData() now returns if image from uuid was not found
-
-## [2.47.0] - 2018-11-29
-
-### Added
-
-- DateExtension
-
-## [2.46.2] - 2018-11-28
-
-### Fixed
-
-- restore img css class in `picture.html.twig` while lazyload is active
-
-## [2.46.1] - 2018-11-26
-
-### Fixed
-
-- DateUtil::getShortMonthTranslationMap(), DateUtil::getMonthTranslationMap()
-
-## [2.46.0] - 2018-11-26
-
-### Changed
-
-- made support for properties in ClassUtil::jsonSerialize() optional
-
-## [2.45.0] - 2018-11-26
-
-### Added
-
-- support for properties in ClassUtil::jsonSerialize()
-
-## [2.44.2] - 2018-11-19
-
-### Fixed
-
-- contao 4.6.8 uses contao.csrf.token_manager service to validate token
-
-## [2.44.1] - 2018-11-19
-
-### Fixed
-
-- symfony 4.x and contao 4.6+ support
-
-## [2.44.0] - 2018-11-15
-
-### Added
-
-- TemplateUtil::getTemplateGroup now also search within bundle views folders
-
-## [2.43.0] - 2018-11-14
-
-### Added
-
-- ModelUtil -> Controller::replaceInsertTags for values
-
-## [2.42.2] - 2018-11-14
-
-### Fixed
-
-- ClassUtil json serialization
-
-## [2.42.0] - 2018-11-14
-
-### Added
-
-- new methods to DateUtil: isMonthInDateFormat(), isDayInDateFormat(), isYearInDateFormat(), getMonthTranslationMap(),
- getShortMonthTranslationMap(), translateMonthsToEnglish(), translateMonths()
-
-## [2.41.0] - 2018-11-14
-
-### Added
-
-- static `ArrayUtil::insertBeforeKey` to modify execution order in hooks and callbacks
-
-## [2.40.1] - 2018-11-13
-
-### Fixed
-
-- `huh.utils.template` do not cache non existing templates within `getTemplate()`
-
-## [2.40.0] - 2018-11-12
-
-### Added
-
-- italian translation, thanks to `MicioMax`
-
-## [2.39.0] - 2018-11-08
-
-### Added
-
-- DcaUtil::generateDcOperationsButtons()
-
-## [2.38.0] - 2018-11-08
-
-### Added
-
-- `image` twig extension
-
-### Fixed
-
-- small bugs in `huh.utils.image` addToTemplateData() function
-
-## [2.37.0] - 2018-11-08
-
-### Added
-
-- `target="_blank"` to `image.html.twig` template if `target` variable is true
-
-## [2.36.0] - 2018-11-08
-
-### Added
-
-- DcaUtil::isDcMultilingual & DcaUtil::loadDc
-
-### Fixed
-
-- dc_multilingual support in ModelUtil
-
-## [2.35.0] - 2018-11-08
-
-### Added
-
-- `huh.utils.image` addToTemplateData() now supports also `uuid` instead of `file path` value
-
-## [2.34.3] - 2018-11-07
-
-### Fixed
-
-- AccordionUtil
-
-## [2.34.2] - 2018-11-07
-
-### Fixed
-
-- dc_multilingual support in ModelUtil
-
-## [2.34.1] - 2018-11-07
-
-### Fixed
-
-- linkTitle issue in `image.html.twig`
-
-## [2.34.0] - 2018-11-06
-
-### Added
-
-- `huh.utils.url` method `isNewVisitor()` to detect if user referer and current host with scheme match
-
-## [2.33.0] - 2018-11-05
-
-### Added
-
-- AccordionUtil
-
-## [2.32.0] - 2018-11-05
-
-### Added
-
-- TemplateUtil::renderTwigTemplate()
-
-## [2.31.0] - 2018-11-02
-
-### Added
-
-- TemplateUtil::getPageAliasAsCssClass()
-
-## [2.30.4] - 2018-11-01
-
-### Fixed
-
-- TemplateUtil::getBundleTemplate -> did not respect the bundle order
-
-## [2.30.2] - 2018-10-22
-
-### Fixed
-
-- `huh.utils.listener.insert_tags` was not public
-
-## [2.30.1] - 2018-10-12
-
-### Fixed
-
-- surround `$file->imageSize` in `ImageUtil::addToTemplateData` with catch block, to prevent error messages for non
- existing images to stop working site
-
-## [2.30.0] - 2018-09-25
-
-### Added
-
-- Inserttag `twig` (Example:`{{twig::logo.html.twig::a:1:{s:3:"foo";s:3:"bar";}}}`) to render twig templates from
- inserttags with custom serialized data
-
-
-[@qzminski]: https://github.com/qzminski
-[#65]: https://github.com/heimrichhannot/contao-utils-bundle/pull/65
-[#64]: https://github.com/heimrichhannot/contao-utils-bundle/pull/64
-[#63]: https://github.com/heimrichhannot/contao-utils-bundle/pull/63
-[#62]: https://github.com/heimrichhannot/contao-utils-bundle/pull/62
-[#61]: https://github.com/heimrichhannot/contao-utils-bundle/pull/61
-[#60]: https://github.com/heimrichhannot/contao-utils-bundle/pull/60
-[#59]: https://github.com/heimrichhannot/contao-utils-bundle/pull/59
-[#56]: https://github.com/heimrichhannot/contao-utils-bundle/pull/56
-[#55]: https://github.com/heimrichhannot/contao-utils-bundle/pull/55
-[#53]: https://github.com/heimrichhannot/contao-utils-bundle/pull/53
-[#51]: https://github.com/heimrichhannot/contao-utils-bundle/pull/51
-[#50]: https://github.com/heimrichhannot/contao-utils-bundle/pull/50
-[#47]: https://github.com/heimrichhannot/contao-utils-bundle/pull/47
-[#46]: https://github.com/heimrichhannot/contao-utils-bundle/pull/46
-[#45]: https://github.com/heimrichhannot/contao-utils-bundle/pull/45
-[#44]: https://github.com/heimrichhannot/contao-utils-bundle/pull/44
-[#43]: https://github.com/heimrichhannot/contao-utils-bundle/pull/43
-[#42]: https://github.com/heimrichhannot/contao-utils-bundle/pull/42
-[#40]: https://github.com/heimrichhannot/contao-utils-bundle/pull/40
-[#38]: https://github.com/heimrichhannot/contao-utils-bundle/pull/38
-[#37]: https://github.com/heimrichhannot/contao-utils-bundle/pull/37
-[#24]: https://github.com/heimrichhannot/contao-utils-bundle/pull/24
+## [3.0.0] - 2023-08-07
+- Changed: DcaUtil::getDcaFields() array options now throw error if not of type array
+- Removed: ContainerUtil::isBundleActive()
+- Removed: UrlUtil::removeQueryStringParameterToUrl()
+- Changed: RoutingUtil::generateBackendRoute() route argument moved to options array
diff --git a/README.md b/README.md
index 01020802..0d883555 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,21 @@
[](https://packagist.org/packages/heimrichhannot/contao-utils-bundle)
[](https://packagist.org/packages/heimrichhannot/contao-utils-bundle)
-[](https://travis-ci.org/heimrichhannot/contao-utils-bundle)
-[](https://coveralls.io/github/heimrichhannot/contao-utils-bundle?branch=master)
+
+[](https://coveralls.io/github/heimrichhannot/contao-utils-bundle?branch=master)
-This bundle offers various utility functionality for the Contao CMS.
+Utils Bundle is a collection of many small helper to solve repeating task.
+At the center there is a utils service allow access to all util function.
+In addition, there are DcaField helpers, the Entity finder command and some nice twig filters.
+## Features
+* Utils-Service - A service allow access all bundles utils functions.
+* DcaField registration - An nice api to add typical dca fields to your dca fields without repeating yourself or annoying order restrictions.
+ * AuthorField - Add an author field with automatic filling of the default value and optional frontend member support
+* Entity Finder - A command to search for any contao entities in your database.
+* Twig Filters
-## Install
+## Install
1. Install via composer:
```
@@ -16,242 +24,100 @@ This bundle offers various utility functionality for the Contao CMS.
```
1. Update database
-### Additional Requirements:
-
-Add following dependencies to your project composer file, if you want to use one of the following utils:
-
-Util | Dependency
-----------------------|-----------
-[~~PdfCreator - mPDF~~](docs/utils/pdf/pdfcreator.md) | `"mpdf/mpdf": "^7.0\|^8.0"`
-huh.utils.pdf.preview | `"spatie/pdf-to-image": "^1.8"` or/and `"alchemy/ghostscript": "^4.1"`
## Usage
-> We're currently in a process moving all services into the Utils namespace and make them all accessible from a new Utils service.
-
-This Bundle is a collection of utils to solve recurring tasks. See the [API Documentation](https://heimrichhannot.github.io/contao-utils-bundle/) to see all util-classes and -methods.
-
-The default way to access the util methods is the `Utils`-service (currently not all services are available there yet). The utils service is best used with dependency injection, but is also available from the service container as public service for usage in legacy code.
-
- ```php
- use HeimrichHannot\UtilsBundle\Util\Utils;
+### Utils service
+
+The Utils service is the core functionality of this bundle. It provides access to a lot of util functions help solving recurring tasks.
+It's build as one service from which you can access all utils services.
+The utils service is best used with dependency injection, but is also available from the service container as public service for usage in legacy code.
+You can check the [API Documentation](https://heimrichhannot.github.io/contao-utils-bundle/namespaces/heimrichhannot-utilsbundle-util.html) to see all available functions.
+
+```php
+use HeimrichHannot\UtilsBundle\Util\Utils;
+
+/**
+ * A class containing examples usage of utils services. Please don't expect it to be useful :)
+ */
+class MyClass{
+ /** @var Utils */
+ protected $utils;
+
+ public function __construct(Utils $utils) {
+ $this->utils = $utils;
+ }
- class MyClass{
- /** @var Utils */
- protected $utils;
+ public function someActions(): bool {
+ $dcaFields = $this->utils->dca()->getDcaFields('tl_content');
+ $this->utils->array()->removeValue('headline', $dcaFields);
+ foreach ($dcaFields as $dcaField) {
+ echo $this->utils->string()->camelCaseToDashed($dcaField);
+ }
- public function __construct(Utils $utils) {
- $this->utils = $utils;
- }
-
- public function someActions(): bool {
- return $this->utils->string()->startsWith('Lorem ipsum dolor sit amet', 'Lorem');
- }
- }
- ```
-
-To access services that are not available through the `Utils`-service, inject or call them directly.
-
-> Keep in mind that all services are about to be moved to the Utils namespace and will be deprecated (and removed in version 3.0) in the future.
-
-
-Available [Service](src/Resources/config/services.yml) (as of version 2.131):
-
-```
-huh.utils.accordion
-huh.utils.anonymizer
-huh.utils.array
-huh.utils.cache.database
-huh.utils.cache.database_tree
-huh.utils.cache.file
-huh.utils.cache.remote_image_cache
-huh.utils.choice.data_container
-huh.utils.choice.field
-huh.utils.choice.message
-huh.utils.choice.model_instance
-huh.utils.choice.twig_template
-huh.utils.class
-huh.utils.code
-huh.utils.comparison
-huh.utils.container
-huh.utils.database
-huh.utils.date
-huh.utils.dca
-huh.utils.encryption
-huh.utils.file
-huh.utils.file_archive
-huh.utils.folder
-huh.utils.form
-huh.utils.image
-huh.utils.location
-huh.utils.member
-huh.utils.model
-huh.utils.module
-huh.utils.pdf.preview
-huh.utils.request.curl
-huh.utils.routing
-huh.utils.salutation
-huh.utils.string
-huh.utils.template
-huh.utils.url
-huh.utils.user
-```
-
-## Documentation
-
-[API Documentation](https://heimrichhannot.github.io/contao-utils-bundle/)
-
-### Utils
-
-[~~PdfCreator~~](docs/utils/pdf/pdfcreator.md) - ~~High-level API to create pdf files with PHP~~ (PDFCreator was moved into it's [own library](https://github.com/heimrichhannot/pdf-creator))
-
-### Using with Webpack/Encore
-
-The bundle assets (js) are prepared to be used with webpack/encore. If you don't use [Foxy](https://github.com/fxpio/foxy), you need to add `"@hundh/contao-utils-bundle": "^1.5.0"` to your project package.json.
-
-See [package Repository](https://github.com/heimrichhannot-contao-components/contao-utils-bundle) for documentation.
-
-### JavaScript Utils
-
-#### Ajax Util
-This util offers a shorthand for POST- and GET-ajax-requests.
-
-```
-static post(url, data, config) {...}
-# or
-static get(url, data, config) {...}
-```
-Both take the following parameters
-
-name | description
-| --- | --- |
-| url | The url the request will be send to. |
-| data | The data that is used for the request. It has to be passed as JSON. |
-| config | An object that can hold the onSuccess-, onError-, beforeSubmit-, afterSubmit-callback and the request headers |
-
-
-Parameters of config
-
-name | description
-| --- | --- |
-| onSuccess | Is called when the request was successfull. The request is passed as parameter. |
-| onError | Is called when the request had an error. The request is passed as parameter. |
-| beforeSubmit | Is called before the request is submitted. The url, data and config are passed as parameters. |
-| afterSubmit | Is called before the request is submitted. The url, data and config are passed as parameters. |
-| headers | The headers will be set when the request is initialized. |
-
-The contents of the config parameter are all optional. If you pass an empty config to the ajaxUtil a silent request will be processed.
-The data will be transformed in the fitting format accordion wether you use a POST- or a GET-request.
-
-To use the shorthands import the utilsBundle into your script. After that just call the method an pass the needed parameters.
-
+ $rootPageModel = $this->utils->request()->getCurrentRootPageModel();
+ echo $this->utils->anonymize()->anonymizeEmail($rootPageModel->adminEmail);
+
+ $groupUsers = $this->utils->user()->findActiveUsersByGroup([1,2]);
+ $this->utils->url()->addQueryStringParameterToUrl('user='.$groupUsers[0]->username, 'https://example.org');
+
+ if ($this->utils->container()->isBackend()) {
+ $where = $this->utils->database()->createWhereForSerializedBlob('dumbData', ['foo', 'bar']);
+ $model = $this->utils->model()->findOneModelInstanceBy('tl_content', [$where->createAndWhere()], [$where->values]);
+ echo '
';
+ }
+}
```
-import "@hundh/contao-utils-bundle";
-...
-utilsBundle.ajax.get(url, data, config);
-# or
-utilsBundle.ajax.post(url, data, config);
-```
+### Dca Fields
-### Configuration
+The bundle provides some common dca fields that can be used in your dca files.
-Following configuration parameter can be overridden:
+#### Author field
-```yaml
-# Default configuration for extension with alias: "huh_utils"
-huh_utils:
- tmp_folder: files/tmp/huh_utils_bundle
+Add an author field to your dca. It will be initialized with the current backend user. On copy, it will be set to the current user.
- # Default folder where to store pdf preview images.
- pdfPreviewFolder: null
- cache:
+```php
+# contao/dca/tl_example.php
+use HeimrichHannot\UtilsBundle\Dca\AuthorField;
- # Enable database tree cache is generated on cache warmup.
- enable_generate_database_tree_cache: false
-
- # Load utils bundle assets. Default value will be changed to false in next major version.
- enable_load_assets: true
+AuthorField::register('tl_example');
```
-## Twig Extensions
-
-These bundle add server twig filters:
+You can pass additional options to adjust the field:
-Filter | Parameter | Description
------------------ | --------- | -----------
-autolink | array options | Create a link if string is an url.
-anonymize_email | - | Returns an anonymized email address. max.muster@example.org will be max.****@example.org
-deserialize | bool force_array = false | Deserialize an serialized array (using `\Contao\StringUtil`)
-download | download = true, data = [], template = "@HeimrichHannotContaoUtils\/download.html.twig" |
-download_data | data = [] |
-download_link | data = [] |
-download_path | data = [] |
-download_title | data = [] |
-file_data | data = [], jsonSerializeOptions = []
-file_path | |
-image | size = null, data = [], template = "image.html.twig" |
-image_caption | |
-image_data | size = null, data = [] |
-image_gallery | template = "image_gallery.html.twig"
-image_size | |
-image_width | |
-localized_date | format = null |
-replace_inserttag | bool cache = true | Replace contao inserttag in twig string.
-
-
-### Image Extension
-
-Use the image extension to resize contao images inside your twig template.
+```php
+# contao/dca/tl_example.php
+use HeimrichHannot\UtilsBundle\Dca\AuthorField;
+AuthorField::register('tl_example')
+ ->setType(AuthorField::TYPE_MEMBER) // can be one of TYPE_USER (default) or TYPE_MEMBER. Use TYPE_MEMBER to set a frontend member instead of a backend user
+ ->setFieldNamePrefix('example') // custom prefix for the field name
+ ->setUseDefaultLabel(false) // set to false to disable the default label and set a custom label in your dca translations
+ ->setExclude(false) // set the dca field exclude option
+ ->setSearch(false) // set the dca field search option
+ ->setFilter(false) // set the dca field filter option
+;
```
-{% for box in boxes %}
- {{ box.image|image([0,0,6],{'href' : box.url, 'linkTitle' : 'vmd.content.more.default'|trans})|raw }}
-{% endfor %}
-```
-
-#### Arguments
-- size: array containing width, height or image size config id (`Theme image size id`)
-- data: additional image data like css class, linkTitle or href
-### Download Extension
-Use the download extension to render download elements, get download links, download path or download data.
+### Entity Finder
-```
-{% set downloadData = singleSRC|download_data %} {#get download data #}
-{{ singleSRC|download(true,{'link': 'customLinkTitleHtml'}, '@HeimrichHannotContaoUtils/download.html.twig') {#render as download link and send file to browser link #}
-{{ singleSRC|download(false,{'link': 'customLinkTitleHtml'}, '@HeimrichHannotContaoUtils/download.html.twig') {#render as download link and open download in news window #}
-{{ singleSRC|download_link) {#get send file to browser download link #}
-{{ singleSRC|download_path) {#get download file path #}
-{{ singleSRC|download_title) {#get download title for link title attribute e.g. #}
-```
+The entity finder is a command to search for any contao entities in your database.
-## Insert tags
+**[Entity finder](docs/commands/entity_finder.md)**
-| Insert tag | Description |
-|---|---|
-| {{twig::*}} | This tag will be replaced with the rendered output of a given twig template, that can be sourced in `bundle/src/Resources/views` or contao root `/templates` directory (replace 1st * with template name e.g. `svg_logo_company` and 2nd * with serialized parameters that should be passed to the template) |
-## Commands
+### Twig Filters
-**[Entity finder](docs/commands/entity_finder.md)** - A command to search for any contao entities in your database.
+This bundle contains currently one twig filter:
-**Image size creator** - Creates image size items for a given image size entity.
+### anonymize_email
-```
-Description:
- Creates image size items for a given image size entity. Image size entities with existing image size items will be skipped.
+Returns an anonymized email address. max.muster@example.org will be max.****@example.org
-Usage:
- huh:utils:create-image-size-items [ []]
-
-Arguments:
- image-size-ids The comma separated ids of the image size. Skip the parameter in order to create image size items for all image size entities.
- breakpoints The comma separated breakpoints as pixel amounts (defaults to "576,768,992,1200,1400"). [default: "576,768,992,1200,1400"]
-
-Example:
- huh:utils:create-image-size-items 1,2
+```twig
+{{ user.email|anonymize_email }}
```
\ No newline at end of file
diff --git a/composer.json b/composer.json
index 8bfa4ce6..a48f122d 100644
--- a/composer.json
+++ b/composer.json
@@ -6,37 +6,28 @@
"require": {
"ext-dom": "*",
"ext-simplexml": "*",
- "php": "^7.2|^8.0",
- "ausi/slug-generator": "^1.1",
- "contao/core-bundle": "^4.4",
+ "php": "^8.1",
+ "contao/core-bundle": "^4.13 || ^5.0",
"doctrine/dbal": "^2.13 || ^3.0",
- "hackzilla/password-generator": "^1.4",
"psr/log": "^1.0 || ^2.0 || ^3.0",
- "soundasleep/html2text": "^1.1",
- "symfony/cache": "^3.4|^4.4|^5.0",
- "symfony/config": "^3.4|^4.4|^5.0",
- "symfony/filesystem": "^3.4|^4.4|^5.0",
- "symfony/http-foundation": "^3.4|^4.4|^5.0",
- "symfony/http-kernel": "^3.4|^4.4|^5.0",
- "symfony/monolog-bridge": "^3.4|^4.4|^5.0",
- "symfony/string": "^5.2",
- "tijsverkoyen/css-to-inline-styles": "^2.2",
- "twig/twig": "^1.26 || ^2.7 || ^3.0"
+ "symfony/config": "^5.4 || ^6.0",
+ "symfony/event-dispatcher-contracts": "^1.0 || ^2.0 || ^3.0",
+ "symfony/filesystem": "^5.4 || ^6.0",
+ "symfony/http-foundation": "^5.4 || ^6.0",
+ "symfony/http-kernel": "^5.4 || ^6.0",
+ "symfony/string": "^5.2 || ^6.0",
+ "twig/twig": "^3.0"
},
"require-dev": {
- "contao/core-bundle": "4.9.*",
- "contao/test-case": "^4.0",
+ "contao/test-case": "^4.0 || ^5.0",
"contao/manager-plugin": "^2.0",
"heimrichhannot/contao-test-utilities-bundle": "^0.1",
"phpunit/phpunit": "^8.0 || ^9.0",
"php-coveralls/php-coveralls": "^2.0",
- "symfony/phpunit-bridge": "^3.2 || ^4.0 || ^5.0",
+ "symfony/phpunit-bridge": "^5.4 || ^6.0",
"phpstan/phpstan": "^1.10",
"phpstan/phpstan-symfony": "^1.2"
},
- "conflict": {
- "heimrichhannot/contao-encore-bundle": "<1.5"
- },
"autoload": {
"psr-4": {
"HeimrichHannot\\UtilsBundle\\": "src/"
@@ -51,18 +42,11 @@
"preferred-install": "dist",
"allow-plugins": {
"contao-components/installer": true,
- "contao/manager-plugin": true
+ "contao/manager-plugin": true,
+ "php-http/discovery": false
}
},
"extra": {
- "contao-manager-plugin": "HeimrichHannot\\UtilsBundle\\ContaoManager\\Plugin",
- "foxy": true
- },
- "suggest": {
- "mpdf/mpdf": "Required by huh.utils.pdf.writer service in version ^7.0",
- "setasign/fpdi-tcpdf": "Required by huh.utils.pdf.fpdi-writer service in version ^2.2",
- "spatie/pdf-to-image": "Optional requirement for huh.utils.pdf.preview in version ^1.8. Please read the docs.",
- "alchemy/ghostscript": "Optional requirement for huh.utils.pdf.preview in version ^4.1. Please read the docs.",
- "eluceo/ical": "Optional requirement for IcsUtil in version ^0.16. Please read the docs."
+ "contao-manager-plugin": "HeimrichHannot\\UtilsBundle\\ContaoManager\\Plugin"
}
}
diff --git a/config/services.yml b/config/services.yml
new file mode 100644
index 00000000..8191054d
--- /dev/null
+++ b/config/services.yml
@@ -0,0 +1,25 @@
+services:
+ _instanceof:
+ Symfony\Component\DependencyInjection\ContainerAwareInterface:
+ calls:
+ - ["setContainer", ["@service_container"]]
+
+ HeimrichHannot\UtilsBundle\Util\Utils:
+ public: true
+ autowire: true
+ autoconfigure: true
+
+ HeimrichHannot\UtilsBundle\:
+ resource: '../src/{Command,EntityFinder,EventListener,Twig,Util}/*'
+ exclude: '../src/Util/Utils.php'
+ autowire: true
+ autoconfigure: true
+ bind:
+ $projectDir: '%kernel.project_dir%'
+ $csrfTokenName: '%contao.csrf_token_name%'
+
+ HeimrichHannot\UtilsBundle\Util\ContainerUtil:
+ autowire: true
+ autoconfigure: true
+ tags:
+ - { name: 'container.service_subscriber', key: 'monolog.logger.contao', id: 'monolog.logger.contao' }
\ No newline at end of file
diff --git a/docs/config/SamiDocConfig.php b/docs/config/SamiDocConfig.php
index 8ee023d7..e254d984 100644
--- a/docs/config/SamiDocConfig.php
+++ b/docs/config/SamiDocConfig.php
@@ -14,7 +14,7 @@
->name('*.php')
->exclude('Resources')
->exclude('ContaoManager')
- ->exclude('HeimrichHannotContaoUtilsBundle')
+ ->exclude('HeimrichHannotUtilsBundle')
->in('./src');
return new Sami($iterator, [
diff --git a/docs/utils/pdf/pdf_writer.md b/docs/utils/pdf/pdf_writer.md
deleted file mode 100644
index fe95fa4e..00000000
--- a/docs/utils/pdf/pdf_writer.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# PDF Writer `huh.utils.pdf.writer`
-
-> PDF writer is deprecated and will be removed in a future version. Please use PDFCreator instead
-
-Example to create a custom pdf.
-```
-$pdf = System::getContainer()->get('huh.utils.pdf.writer')
- ->mergeConfig(['margin_left' => 15, 'margin_right' => 15, 'margin_top' => 15, 'margin_bottom' => 15])
- ->setHtml('
PDF-Example
')
- ->addFontDirectories(StringUtil::trimsplit(',', 'files/pdf-fonts/fonts,web/build/fonts'))
- ->setFileName('test.pdf');
-
- if (null !== ($masterTemplatePath = System::getContainer()->get('huh.utils.file')->getPathFromUuid($this->readerConfigElement->syndicationPdfMasterTemplate))) {
- $pdf->setTemplate($masterTemplatePath);
- }
-
- $pdf->generate($this->download);
-```
-
-## Use custom fonts
-
-You can provide multiple paths to a directory containing additional fonts.
-The directory **must contain** a `mpdf-config.php` file, that must return an array with the additional mpdf font-configuration.
-
-**Example:**
-
-You declare for instance the direcory `files/pdf-fonts/` that contains the `.ttf` or `.otf` or `.ttc` font files and the `mpdf-config.php`, than the following configuration should be made.
-
-```
-getDefaults();
-$fontData = $defaultFontConfig['fontdata'];
-
-return [
- 'fontdata' => $fontData +[
- 'roboto' => [
- 'R' => 'Roboto-Regular.ttf'
- ],
- 'fontawesome' => [
- 'R' => 'fontawesome-webfont.ttf'
- ]
- ],
- 'default_font' => 'roboto'
-];
-```
-*Example: mpdf-config.php*
-
-More Information: https://mpdf.github.io/fonts-languages/fonts-in-mpdf-7-x.html
\ No newline at end of file
diff --git a/docs/utils/pdf/pdfcreator.md b/docs/utils/pdf/pdfcreator.md
deleted file mode 100644
index 1607cd2e..00000000
--- a/docs/utils/pdf/pdfcreator.md
+++ /dev/null
@@ -1,67 +0,0 @@
-# PdfCreator
-
-> PDFCreator was moved into it's [own library](https://github.com/heimrichhannot/pdf-creator). Please use that one instead of the version in utils bundle as it's marked deprecated now.
-
-PdfCreator is a high level API for PDF writing with PHP.
-
-## Example
-
-```php
-use HeimrichHannot\UtilsBundle\PdfCreator\PdfCreatorFactory;
-use HeimrichHannot\UtilsBundle\PdfCreator\Concrete\MpdfCreator;
-
-$pdf = PdfCreatorFactory::createInstance(MpdfCreator::getType());
-$pdf->setHtmlContent($this->compile())
- ->setFilename($this->getFileName())
- ->setFormat('A4')
- ->setOrientation($pdf::ORIENTATION_PORTRAIT)
- ->addFont(
- "/path_to_project/assets/fonts/my_great_font.tff",
- "myGreatFont",
- $pdf::FONT_STYLE_REGUALAR,
- "normal"
- )
- ->setMargins(15, 10, 15,10)
- ->setTemplateFilePath("/path_to_project/assets/pdf/mastertemplate.pdf")
- ->setOutputMode($pdf::OUTPUT_MODE_DOWNLOAD)
- ->render()
-;
-```
-
-## Usage
-
-### Use callback for custom adjustments
-
-Due the high level approach not all specific library functionality could be supported. To add specific configuration, you use the callback mechanism comes with this api.
-
-Callback | Description
--------- | -----------
-BeforeCreateLibraryInstanceCallback | Is evaluated before the library instance is created and allows to modifiy the constructor parameters.
-BeforeOutputPdfCallback | Is evaluated before the library method to output the pdf is called and provide the library instance and the output method parameters.
-
-```php
-use HeimrichHannot\UtilsBundle\PdfCreator\BeforeCreateLibraryInstanceCallback;
-use HeimrichHannot\UtilsBundle\PdfCreator\BeforeOutputPdfCallback;use HeimrichHannot\UtilsBundle\PdfCreator\PdfCreatorFactory;
-use HeimrichHannot\UtilsBundle\PdfCreator\Concrete\MpdfCreator;
-
-$pdf = PdfCreatorFactory::createInstance(MpdfCreator::getType());
-
-$pdf->setBeforeCreateInstanceCallback(function (BeforeCreateLibraryInstanceCallback $callbackData) {
- $parameter = $callbackData->getConstructorParameters();
- $parameter['config']['fonttrans'] = [
- 'rotis-sans-serif-w01-bold' => 'rotis-sans-serif',
- 'rotissansserifw01-bold' => 'rotis-sans-serif',
- ];
- $callbackData->setConstructorParameters($parameter);
- return $callbackData;
-});
-
-$pdf->setBeforeOutputPdfCallback(function (BeforeOutputPdfCallback $callbackData) use ($pdf) {
- $mpdf = $callbackData->getLibraryInstance();
- $mpdf->AddPage();
- $parameters = $callbackData->getOutputParameters();
- $parameters['name'] = 'custom_'.$pdf->getFilename();
- $callbackData->setOutputParameters($parameters);
-});
-
-```
\ No newline at end of file
diff --git a/phpstan.neon b/phpstan.neon
index e717ba4d..2c7feef9 100644
--- a/phpstan.neon
+++ b/phpstan.neon
@@ -3,11 +3,11 @@ parameters:
paths:
- src/Util
- tests/Util
-# universalObjectCratesClasses:
+ universalObjectCratesClasses:
# - Contao\LayoutModel
# - Contao\Model
# - Contao\Template
-# - PHPUnit\Framework\MockObject\MockObject
+ - PHPUnit\Framework\MockObject\MockObject
# ignoreErrors:
# - message: '#^Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject\:\:setName\(\)\.$#'
# path: tests/EventListener/Contao/ParseTemplateListenerTest.php
diff --git a/src/Accordion/AccordionUtil.php b/src/Accordion/AccordionUtil.php
deleted file mode 100644
index 73c4aacf..00000000
--- a/src/Accordion/AccordionUtil.php
+++ /dev/null
@@ -1,226 +0,0 @@
-framework = $container->get('contao.framework');
- $this->container = $container;
- }
-
- /**
- * Adds the following flags to the template data:
- * - first
- * - last
- * - parentId.
- *
- * This is needed if your want to group multiple single accordion elements into an accordion wrapper like in bootstrap 4.
- *
- * @param array $data Data describing the accordion. Usually this is taken from \Contao\Template::getData().
- * @param string $prefix The prefix for the flags
- */
- public function structureAccordionSingle(array &$data, string $prefix = 'accordion_'): void
- {
- if (!isset($data['id']) || !isset($data['pid']) || !isset($data['ptable'])) {
- return;
- }
-
- $cacheKey = $data['ptable'].'_'.$data['pid'];
-
- if (!isset($this->accordionSingleCache[$cacheKey])) {
- if (null !== ($elements = $this->container->get('huh.utils.model')->findModelInstancesBy(
- 'tl_content',
- [
- 'tl_content.ptable=?',
- 'tl_content.pid=?',
- 'tl_content.invisible!=1',
- ],
- [
- $data['ptable'],
- $data['pid'],
- ],
- [
- 'order' => 'sorting ASC',
- ]
- ))) {
- $lastOneIsAccordionSingle = false;
- $elementGroup = [];
- $this->accordionSingleCache[$cacheKey] = [];
-
- foreach ($elements as $i => $element) {
- if ('accordionSingle' === $element->type) {
- $elementGroup[] = $element->row();
- } else {
- if ($lastOneIsAccordionSingle) {
- $this->accordionSingleCache[$cacheKey][] = $elementGroup;
- $elementGroup = [];
- }
-
- $lastOneIsAccordionSingle = false;
-
- continue;
- }
-
- $lastOneIsAccordionSingle = true;
-
- if ($i === \count($elements) - 1) {
- $this->accordionSingleCache[$cacheKey][] = $elementGroup;
- $elementGroup = [];
- }
- }
- }
- }
-
- if (isset($this->accordionSingleCache[$cacheKey]) && \is_array($this->accordionSingleCache[$cacheKey])) {
- foreach ($this->accordionSingleCache[$cacheKey] as $elementGroup) {
- foreach ($elementGroup as $i => $element) {
- if ($data['id'] == $element['id']) {
- if (0 === $i) {
- $data[$prefix.'first'] = true;
- }
-
- if ($i === \count($elementGroup) - 1) {
- $data[$prefix.'last'] = true;
- }
-
- $data[$prefix.'parentId'] = $elementGroup[0]['id'];
-
- break 2;
- }
- }
- }
- }
- }
-
- /**
- * Adds the following flags to the template data:
- * - first
- * - last
- * - parentId.
- *
- * @param array $data Data describing the accordion. Usually this is taken from \Contao\Template::getData().
- * @param string $prefix The prefix for the flags
- *
- * @deprecated Use Utils service instead
- * @codeCoverageIgnore
- */
- public function structureAccordionStartStop(array &$data, string $prefix = 'accordion_')
- {
- if (!isset($data['id']) || !isset($data['pid'])) {
- return;
- }
-
- $cacheKey = $data['ptable'].'_'.$data['pid'];
-
- if (!isset($this->accordionStartStopCache[$cacheKey])) {
- if (null !== ($elements = $this->container->get('huh.utils.model')->findModelInstancesBy(
- 'tl_content',
- [
- 'tl_content.ptable=?',
- 'tl_content.pid=?',
- 'tl_content.invisible!=1',
- ],
- [
- $data['ptable'],
- $data['pid'],
- ],
- [
- 'order' => 'sorting ASC',
- ]
- ))) {
- $lastOneIsAccordionStop = false;
- $this->accordionStartStopCache[$cacheKey] = [];
-
- foreach ($elements as $i => $element) {
- if ('accordionStart' === $element->type) {
- if (\count($this->accordionStartStopCache[$cacheKey]) < 1) {
- $this->accordionStartStopCache[$cacheKey][] = [];
- }
-
- $this->accordionStartStopCache[$cacheKey][\count($this->accordionStartStopCache[$cacheKey]) - 1][] = $element->row();
-
- $lastOneIsAccordionStop = false;
- } elseif ('accordionStop' === $element->type) {
- $this->accordionStartStopCache[$cacheKey][\count($this->accordionStartStopCache[$cacheKey]) - 1][] = $element->row();
-
- $lastOneIsAccordionStop = true;
-
- continue;
- } elseif ($lastOneIsAccordionStop) {
- $this->accordionStartStopCache[$cacheKey][] = [];
- $lastOneIsAccordionStop = false;
- }
- }
-
- // remove trailing empty arrays
- $cleaned = [];
-
- foreach ($this->accordionStartStopCache[$cacheKey] as $elementGroup) {
- if (!empty($elementGroup)) {
- $cleaned[] = $elementGroup;
- }
- }
-
- $this->accordionStartStopCache[$cacheKey] = $cleaned;
- }
- }
-
- if (isset($this->accordionStartStopCache[$cacheKey]) && \is_array($this->accordionStartStopCache[$cacheKey])) {
- foreach ($this->accordionStartStopCache[$cacheKey] as $elementGroup) {
- foreach ($elementGroup as $i => $element) {
- if ($data['id'] == $element['id']) {
- if (0 === $i) {
- $data[$prefix.'first'] = true;
- }
-
- if ($i === \count($elementGroup) - 1) {
- $data[$prefix.'last'] = true;
- }
-
- $data[$prefix.'parentId'] = $elementGroup[0]['id'];
-
- break 2;
- }
- }
- }
- }
- }
-}
diff --git a/src/Arrays/ArrayUtil.php b/src/Arrays/ArrayUtil.php
deleted file mode 100644
index 11e63a49..00000000
--- a/src/Arrays/ArrayUtil.php
+++ /dev/null
@@ -1,256 +0,0 @@
-framework = $container->get('contao.framework');
- $this->container = $container;
- }
-
- /**
- * Filter an Array by given prefixes.
- *
- * @param array $prefixes
- *
- * @return array the filtered array or $arrData if $prefix is empty
- */
- public function filterByPrefixes(array $data = [], $prefixes = [])
- {
- $extract = [];
-
- if (!\is_array($prefixes) || empty($prefixes)) {
- return $data;
- }
-
- foreach ($data as $key => $value) {
- foreach ($prefixes as $prefix) {
- if ($this->container->get('huh.utils.string')->startsWith($key, $prefix)) {
- $extract[$key] = $value;
- }
- }
- }
-
- return $extract;
- }
-
- /**
- * sort an array alphabetically by some key in the second layer (x => array(key1, key2, key3)).
- */
- public function aasort(array &$array, $key)
- {
- $sorter = [];
- $ret = [];
- reset($array);
-
- foreach ($array as $ii => $va) {
- $sorter[$ii] = $va[$key];
- }
-
- asort($sorter);
-
- foreach ($sorter as $ii => $va) {
- $ret[$ii] = $array[$ii];
- }
-
- $array = $ret;
- }
-
- /**
- * Removes a value in an array.
- *
- * @param $value
- *
- * @return bool Returns true if the value has been found and removed, false in other cases
- *
- * @deprecated Use Utils service instead
- * @codeCoverageIgnore
- */
- public function removeValue($value, array &$array): bool
- {
- if (false !== ($intPosition = array_search($value, $array))) {
- unset($array[$intPosition]);
-
- return true;
- }
-
- return false;
- }
-
- public function removePrefix(string $prefix, array $array): array
- {
- $result = [];
-
- foreach ($array as $key => $value) {
- $result[$this->container->get('huh.utils.string')->removeLeadingString($prefix, $key)] = $value;
- }
-
- return $result;
- }
-
- /**
- * Insert a value into an existing array by key name.
- *
- * @param array $current The target array
- * @param string $key the existing target key in the array
- * @param mixed $value the new value to be inserted
- * @param int $offset offset for inserting the new value
- * @param bool $strict use strict behavior for array search
- *
- * @deprecated Use utils service instead
- * @codeCoverageIgnore
- */
- public function insertInArrayByName(array &$current, string $key, $value, int $offset = 0, bool $strict = false)
- {
- if (false !== ($intIndex = array_search($key, array_keys($current), $strict))) {
- array_insert($current, $intIndex + $offset, $value);
- }
- }
-
- /**
- * Creates a stdClass from array.
- *
- * @param $array
- */
- public function arrayToObject(array $array): \stdClass
- {
- $objResult = new \stdClass();
-
- foreach ($array as $varKey => $varValue) {
- $objResult->{$varKey} = $varValue;
- }
-
- return $objResult;
- }
-
- /**
- * Returns a row of an multidimensional array by field value. Returns false, if no row found.
- *
- * @param string|int $key The array key (fieldname)
- * @param mixed $value
- * @param array $haystack a multidimensional array
- * @param bool $strictType Specifiy if type comparison should be strict (type-safe)
- *
- * @return mixed
- */
- public function getArrayRowByFieldValue($key, $value, array $haystack, bool $strictType = false)
- {
- foreach ($haystack as $row) {
- if (!\is_array($row)) {
- continue;
- }
-
- if (!isset($row[$key])) {
- continue;
- }
-
- if (true === $strictType) {
- if ($value === $row[$key]) {
- return $row;
- }
- } else {
- if ($row[$key] == $value) {
- return $row;
- }
- }
- }
-
- return false;
- }
-
- /**
- * Flattens an multidimensional array to one dimension. Keys are not preserved.
- *
- * @return array
- */
- public function flattenArray(array $array)
- {
- $return = [];
- array_walk_recursive(
- $array,
- function ($a) use (&$return) {
- $return[] = $a;
- }
- );
-
- return $return;
- }
-
- /**
- * Insert a new entry before an specific key in array.
- * If key not exist, the new entry is added to the end of the array.
- * Array is passed as reference.
- *
- * Usage example: contao config.php to make your hook entry run before another.
- *
- * @param array $array Array the new entry should inserted to
- * @param string $key The key where the new entry should be added before
- * @param string $newKey The key of the entry that should be added
- * @param mixed $newValue The value of the entry that should be added
- *
- * @deprecated Use Utils::insertBeforeKey() instead
- */
- public static function insertBeforeKey(array &$array, string $key, string $newKey, $newValue)
- {
- if (\array_key_exists($key, $array)) {
- $new = [];
-
- foreach ($array as $k => $value) {
- if ($k === $key) {
- $new[$newKey] = $newValue;
- }
- $new[$k] = $value;
- }
- $array = $new;
- } else {
- $array[$newKey] = $newValue;
- }
- }
-
- public function implodeRecursive($var, $binary = false)
- {
- if (!\is_array($var)) {
- return $binary ? StringUtil::binToUuid($var) : $var;
- }
-
- if (!\is_array(current($var))) {
- if ($binary) {
- $var = array_map(function ($v) {
- return $v ? (Validator::isBinaryUuid($v) ? StringUtil::binToUuid($v) : $v) : '';
- }, $var);
- }
-
- return implode(', ', $var);
- }
-
- $buffer = '';
-
- foreach ($var as $k => $v) {
- $buffer .= $k.': '.$this->implodeRecursive($v)."\n";
- }
-
- return trim($buffer);
- }
-}
diff --git a/src/Cache/DatabaseCacheUtil.php b/src/Cache/DatabaseCacheUtil.php
deleted file mode 100644
index 61c55bad..00000000
--- a/src/Cache/DatabaseCacheUtil.php
+++ /dev/null
@@ -1,107 +0,0 @@
- 'd', 'value' => 1];
-
- /**
- * @var ContaoFrameworkInterface
- */
- protected $framework;
-
- /**
- * @var Database
- */
- protected $database;
- /**
- * @var ContainerInterface
- */
- protected $container;
-
- public function __construct(ContainerInterface $container)
- {
- $this->framework = $container->get('contao.framework');
- $this->database = $this->framework->createInstance(Database::class);
- $this->container = $container;
- }
-
- /**
- * Check for a given cache key.
- */
- public function keyExists(string $key): bool
- {
- $result = $this->database->prepare('SELECT * FROM tl_db_cache WHERE cacheKey = ?')->execute($key);
-
- return $result->numRows > 0;
- }
-
- /**
- * Retrieve a value from cache.
- *
- * @return mixed
- */
- public function getValue(string $key)
- {
- if (!Config::get('activateDbCache')) {
- return false;
- }
-
- // clean expired values at first (self-purification)
- $this->database->prepare('DELETE FROM tl_db_cache WHERE expiration < ?')->execute(time());
-
- $result = $this->database->prepare('SELECT * FROM tl_db_cache WHERE cacheKey = ?')->execute($key);
-
- if ($result->numRows > 0) {
- return $result->cacheValue;
- }
-
- return false;
- }
-
- /**
- * Store a given value to cache.
- *
- * @param $value
- *
- * @throws \Exception
- *
- * @return bool
- */
- public function cacheValue(string $key, $value)
- {
- if (!Config::get('activateDbCache')) {
- return false;
- }
-
- if ($this->getValue($key)) {
- throw new \Exception('Duplicate entry in tl_db_cache for key '.$key);
- }
-
- $now = time();
-
- $this->database->prepare('INSERT INTO tl_db_cache (tstamp, expiration, cacheKey, cacheValue) VALUES (?, ?, ?, ?)')->execute(
- $now,
- $now + $this->container->get('huh.utils.date')->getTimePeriodInSeconds(
- StringUtil::deserialize(Config::get('dbCacheMaxTime'), true)
- ),
- $key,
- $value
- );
-
- return true;
- }
-}
diff --git a/src/Cache/DatabaseTreeCache.php b/src/Cache/DatabaseTreeCache.php
deleted file mode 100644
index cb237e0c..00000000
--- a/src/Cache/DatabaseTreeCache.php
+++ /dev/null
@@ -1,327 +0,0 @@
-framework = $framework;
- $this->filesystem = $filesystem;
- $this->modelUtil = $modelUtil;
- $this->database = $this->framework->createInstance(Database::class);
- $this->cacheDir = \Contao\System::getContainer()->getParameter('kernel.cache_dir').'/tree_cache';
- $this->containerUtil = $containerUtil;
- $this->requestStack = $requestStack;
- }
-
- /**
- * Generate tree cache.
- */
- public function loadDataContainer($table)
- {
- if (!$this->database->tableExists($table)) {
- return;
- }
-
- if (!isset($GLOBALS['TL_DCA'][$table]) || !isset($GLOBALS['TL_DCA'][$table]['config']['treeCache']) || !\is_array($GLOBALS['TL_DCA'][$table]['config']['treeCache'])) {
- return;
- }
-
- if ($this->containerUtil->isInstall() || !$this->requestStack->getCurrentRequest()) {
- return;
- }
-
- if (!$this->isCompleteInstallation($table)) {
- return;
- }
-
- $configurations = $GLOBALS['TL_DCA'][$table]['config']['treeCache'];
-
- foreach ($configurations as $key => $config) {
- $this->addConfigToTreeCache($table, $key, $config);
- }
- }
-
- public function addConfigToTreeCache(string $table, string $key, array $config = [])
- {
- $filename = $table.'_'.$key.'.php';
-
- if (file_exists($this->cacheDir.'/'.$filename)) {
- return;
- }
-
- if (null === ($roots = $this->modelUtil->findModelInstancesBy($table, $config['columns'] ?? [], $config['values'] ?? [], $config['options']))) {
- return;
- }
-
- $tree = $this->generateCacheTree($table, $roots->fetchEach($key), $key, $config);
-
- $this->filesystem->dumpFile(
- $this->cacheDir.'/'.$filename,
- sprintf("getTreeCache($table, $key))) {
- return $this->database->getChildRecords($ids, $table);
- }
-
- foreach ($ids as $i => $id) {
- if (!isset($tree[$id]) || !\is_array($tree[$id])) {
- continue;
- }
-
- $children = array_merge($children, $tree[$id]);
-
- if (1 === $maxLevels) {
- continue;
- }
-
- if ($maxLevels > 0 && $level > $maxLevels) {
- return [];
- }
-
- if (!empty($nested = self::getChildRecords($table, $tree[$id], $maxLevels, $key, $children, ++$level))) {
- $children = $nested;
- } else {
- $depth = 0;
- }
- }
-
- return $children;
- }
-
- /**
- * Get all parent records for given child entity.
- *
- * @param string $table The database table
- * @param int $id The current entity id
- * @param int $maxLevels The max stop level
- * @param string Custom index key (default: primary key from model)
- * @param array $parents Internal children return array
- * @param int $level Internal depth attribute
- *
- * @return array An array containing all children for given parent entities
- */
- public function getParentRecords(string $table, int $id, $maxLevels = null, string $key = 'id', array $parents = [], int $level = 0): array
- {
- if (null === ($tree = $this->getTreeCache($table, $key))) {
- return $this->database->getParentRecords($id, $table);
- }
-
- if (isset($tree[$id]) && 0 === $level) {
- $parents[] = $id;
- }
-
- foreach ($tree as $pid => $ids) {
- if (!\in_array($id, $ids)) {
- continue;
- }
-
- $parents[] = $pid;
-
- if (1 === $maxLevels) {
- continue;
- }
-
- if ($maxLevels > 0 && $level > $maxLevels) {
- return [];
- }
-
- if (!empty($nested = self::getParentRecords($table, $pid, $maxLevels, $key, $parents, ++$level))) {
- $parents = $nested;
- } else {
- $level = 0;
- }
- }
-
- return $parents;
- }
-
- /**
- * Get the tree cache for a given table and key.
- *
- * @param string $table The database table
- * @param string Custom index key (default: primary key from model)
- */
- public function getTreeCache($table, $key): ?array
- {
- $filename = $table.'_'.$key.'.php';
-
- if (file_exists($this->cacheDir.'/'.$filename)) {
- self::$cache[$table.'_'.$key] = (include $this->cacheDir.'/'.$filename);
- }
-
- return self::$cache[$table.'_'.$key] ?? null;
- }
-
- /**
- * Generate the flat cache tree.
- *
- * @param string $table The database table
- * @param string $key Custom index key (default: primary key from model)
- * @param array $ids Root identifiers (parent ids)
- * @param array $config Tree config
- * @param array $return Internal return array
- *
- * @return array The flat cache tree
- */
- public function generateCacheTree(string $table, array $ids = [], string $key = 'id', array $config = [], $return = []): array
- {
- foreach ($ids as $id) {
- if (null === ($children = $this->modelUtil->findModelInstancesBy($table, [$table.'.pid = ?'], $id, $config['options']))) {
- $return[$id] = [];
-
- continue;
- }
-
- while ($children->next()) {
- $return[$children->pid][$children->{$key}] = $children->{$key};
- $return = $this->generateCacheTree($table, [$children->{$key}], $key, $config, $return);
- }
- }
-
- return $return;
- }
-
- /**
- * Generate all cache trees.
- *
- * @param $cacheDir
- */
- public function generateAllCacheTree($cacheDir)
- {
- $this->cacheDir = $cacheDir;
-
- $tables = $this->database->listTables();
-
- foreach ($tables as $table) {
- // trigger loadDataContainer TL_HOOK
- System::getContainer()->get('huh.utils.dca')->loadDc($table);
- }
- }
-
- /**
- * Register a dca to the tree cache.
- *
- * @param string $table (The dca table)
- * @param array $columns Parent sql filter columns (e.g. `tl_page.type`)
- * @param array $values Parent sql filter values (e.g. `root` for `tl_page.type`)
- * @param array $options SQL Options for sorting
- * @param string Custom index key (default: primary key from model)
- *
- * @return bool Acknowledge state if register succeeded
- */
- public function registerDcaToCacheTree(string $table, array $columns = [], array $values = [], array $options = [], string $key = 'id')
- {
- System::getContainer()->get('huh.utils.dca')->loadDc($table);
-
- if (!isset($GLOBALS['TL_DCA'][$table])) {
- return false;
- }
-
- $GLOBALS['TL_DCA'][$table]['config']['treeCache'][$key] = [
- 'columns' => $columns,
- 'values' => $values,
- 'options' => $options,
- 'key' => $key,
- ];
-
- $GLOBALS['TL_DCA'][$table]['config']['ondelete_callback']['huh.utils.cache.database_tree'] = ['huh.utils.cache.database_tree', 'purgeCacheTree'];
- $GLOBALS['TL_DCA'][$table]['config']['oncut_callback']['huh.utils.cache.database_tree'] = ['huh.utils.cache.database_tree', 'purgeCacheTree'];
- $GLOBALS['TL_DCA'][$table]['config']['onsubmit_callback']['huh.utils.cache.database_tree'] = ['huh.utils.cache.database_tree', 'purgeCacheTree'];
- $GLOBALS['TL_DCA'][$table]['config']['onrestore_callback']['huh.utils.cache.database_tree'] = ['huh.utils.cache.database_tree', 'purgeCacheTree'];
-
- return true;
- }
-
- /**
- * Purge the tree cache completely in order to take table relations into consideration.
- */
- public function purgeCacheTree()
- {
- $this->filesystem->remove($this->cacheDir);
- }
-
- private function isCompleteInstallation($table)
- {
- try {
- $this->modelUtil->findOneModelInstanceBy($table, [], []);
- } catch (\Exception $e) {
- return false;
- }
-
- return true;
- }
-}
diff --git a/src/Cache/FileCache.php b/src/Cache/FileCache.php
deleted file mode 100644
index 99cc8532..00000000
--- a/src/Cache/FileCache.php
+++ /dev/null
@@ -1,276 +0,0 @@
-cacheFolder = $container->getParameter('huh.utils.filecache.folder');
- $this->fileUtil = $container->get('huh.utils.file');
- $this->projectDir = $container->getParameter('kernel.project_dir');
- $this->generatePath();
- $this->container = $container;
- }
-
- /**
- * Checks if a cached file already exist in cache. Namespace is taken into account.
- *
- * @param string $identifier The identifier
- * @param string $fileExtension If not set, a file with no file extension is searched
- *
- * @throws \Exception
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- *
- * @return bool
- */
- public function exist(string $identifier, string $fileExtension = '')
- {
- $fileName = $this->getCacheFileName($identifier);
- $cachePath = $this->cacheFolderWithNamespace.'/'.$fileName;
-
- if (!empty($fileExtension)) {
- $cachePath .= '.'.$fileExtension;
- }
- $file = new File($cachePath);
-
- if ($file->exists()) {
- return true;
- }
-
- return false;
- }
-
- /**
- * Get the file path for the given identifier. Namespace is taken into account.
- *
- * @param callable $saveCallback A callback handles the file save functionality. Get filepath, filename and the identifier as parameter. Expects a boolean return value.
- *
- * @throws \Exception
- *
- * @return bool|string returns the path of the cached file or false, if cached file could not be found
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function get(string $identifier, string $fileExtension = '', callable $saveCallback = null)
- {
- $fileName = $this->getCacheFileName($identifier);
- $cachePath = $this->cacheFolderWithNamespace.'/'.$fileName;
-
- if (!empty($fileExtension)) {
- $fileName .= '.'.$fileExtension;
- $cachePath .= '.'.$fileExtension;
- }
- $file = new File($cachePath);
-
- if (!$file->exists()) {
- if (null !== $saveCallback) {
- if ($saveCallback($identifier, $this->cacheFolderWithNamespace, $fileName)) {
- return $this->cacheFolderWithNamespace.'/'.$fileName;
- }
- }
-
- return false;
- }
-
- return $file->path;
- }
-
- /**
- * Generate a file name for cache.
- *
- * If a identifier is given, you get the resulting file name.
- * If no identifier is given, if will return a unique file name without extension.
- *
- * @param string $identifier An identifier for the cache. For example be the source file name or path. If empty, a unique filename will be generated.
- * @param string $prefix Adds a prefix to the generated name. Only if $identifier is empty.
- * @param bool $more_entropy A longer name for the unique filename. Only if $identifier is empty. Default
- * @param string $fileExtension optional: If set, the file extension will be appended to the generated file name
- *
- * @return string a unique filename for caching
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function generateCacheName(string $identifier = '', string $prefix = '', bool $more_entropy = true, string $fileExtension = '')
- {
- if (empty($identifier)) {
- $fileName = uniqid($prefix, $more_entropy);
- } else {
- $fileName = $this->getCacheFileName($identifier);
- }
-
- if (!empty($fileExtension)) {
- $fileName .= '.'.$fileExtension;
- }
-
- return $fileName;
- }
-
- /**
- * Get the cache file name by the given identifier.
- *
- * @param $identifier
- *
- * @return string
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getCacheFileName($identifier)
- {
- return StringUtil::generateAlias($identifier);
- }
-
- /**
- * Same as generateCacheName, but returns complete path to cache.
- *
- * If no filename is given, you need to add the file extension by yourself!
- *
- * @param string $filename The filename of the file that should be cached. If empty, a unique filename will be generated.
- * @param string $prefix Adds a prefix to the generated name. Only if $filename is empty.
- * @param bool $more_entropy A longer name for the unique filename. Only if filename is empty. Default
- *
- * @return string the path including the filename to save the file to the cache
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getCacheFilePath(string $filename = '', string $prefix = '', bool $more_entropy = true)
- {
- return $this->cacheFolderWithNamespace.'/'.$this->generateCacheName($filename, $prefix, $more_entropy);
- }
-
- /**
- * Returns the absolute path to the cache folder.
- *
- * @return string
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getAbsoluteCachePath()
- {
- return $this->projectDir.'/'.$this->cacheFolderWithNamespace;
- }
-
- /**
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getNamespace(): string
- {
- return $this->namespace;
- }
-
- /**
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function setNamespace(string $namespace)
- {
- $this->namespace = trim($namespace, ' /');
- $this->generatePath();
- }
-
- /**
- * The cache folder (without namespace).
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getCacheFolder(): string
- {
- return $this->cacheFolder;
- }
-
- /**
- * Set cache folder (without namespace).
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function setCacheFolder(string $cacheFolder)
- {
- $this->cacheFolder = $cacheFolder;
- $this->generatePath();
- }
-
- /**
- * Get the cache folder (including namespace).
- *
- * @deprecated Will be removed in 3.0. Use FileStorageUtil instead
- */
- public function getCacheFolderWithNamespace(): string
- {
- return $this->cacheFolderWithNamespace;
- }
-
- /**
- * Recreates the path to the current cache folder.
- */
- protected function generatePath()
- {
- $filesystem = new Filesystem();
- $path = $this->cacheFolder;
- $path = trim($path, '/');
-
- if (!empty($this->namespace)) {
- $path .= '/'.$this->namespace;
- }
-
- if (!$filesystem->exists($this->projectDir.'/'.$path)) {
- $filesystem->mkdir($this->projectDir.'/'.$path);
- }
- $this->cacheFolderWithNamespace = $path;
- }
-}
diff --git a/src/Cache/RemoteImageCache.php b/src/Cache/RemoteImageCache.php
deleted file mode 100644
index 4652b3e7..00000000
--- a/src/Cache/RemoteImageCache.php
+++ /dev/null
@@ -1,78 +0,0 @@
-framework = $container->get('contao.framework');
- $this->container = $container;
- }
-
- /**
- * Get a remote file from cache and cache file, if not already in cache.
- *
- * Returns false, if remote file could not be fetched or given uuid is not valid.
- * Else returns the url or, if $returnUuid is set true, the uuid of the image.
- *
- * @param string $identifier Used as filename of the cached image. Should be unique within the folder scope
- * @param string $folder Folder path or uuid of the file
- * @param string $remoteUrl The url of the cached (or to cache) file
- * @param bool $returnUuid Return uuid instead of the path
- *
- * @throws \Exception
- *
- * @return bool|string
- */
- public function get(string $identifier, $folder, $remoteUrl, $returnUuid = false)
- {
- $strFilename = $identifier.'.jpg';
-
- if (Validator::isUuid($folder)) {
- $objFolder = $this->container->get('huh.utils.file')->getFolderFromUuid($folder);
-
- if (false === $objFolder) {
- return false;
- }
- $folder = $objFolder->value;
- }
-
- $objFile = new File(rtrim($folder, '/').'/'.$strFilename);
-
- if ($objFile->exists() && $objFile->size > 0) {
- return $returnUuid ? $objFile->getModel()->uuid : $objFile->path;
- }
-
- $strContent = $this->container->get('huh.utils.request.curl')->request($remoteUrl);
-
- if (!$strContent || !\is_string($strContent)) {
- return false;
- }
-
- $objFile->write($strContent);
- $objFile->close();
-
- return $returnUuid ? $objFile->getModel()->uuid : $objFile->path;
- }
-}
diff --git a/src/Cache/UtilCacheWarmer.php b/src/Cache/UtilCacheWarmer.php
deleted file mode 100644
index 3e5b5345..00000000
--- a/src/Cache/UtilCacheWarmer.php
+++ /dev/null
@@ -1,116 +0,0 @@
-filesystem = $filesystem;
- $this->connection = $connection;
- $this->templateUtil = $templateUtil;
- $this->framework = $framework;
- }
-
- /**
- * {@inheritdoc}
- */
- public function warmUp($cacheDir)
- {
- if (!$this->isCompleteInstallation()) {
- return;
- }
-
- $this->framework->initialize();
-
- $this->generateTemplateMapper($cacheDir);
- $this->generateDatabaseTreeCache($cacheDir);
- }
-
- /**
- * {@inheritdoc}
- */
- public function isOptional()
- {
- return true;
- }
-
- /**
- * Checks if the installation is complete.
- *
- * @return bool
- */
- private function isCompleteInstallation()
- {
- try {
- $this->connection->query('SELECT COUNT(*) FROM tl_page');
- } catch (\Exception $e) {
- return false;
- }
-
- return true;
- }
-
- /**
- * Generates the template mapper array.
- *
- * @param string $cacheDir The cache directory
- */
- private function generateTemplateMapper($cacheDir)
- {
- $files = $this->templateUtil->getAllTemplates();
-
- if (empty($files)) {
- return;
- }
-
- $this->filesystem->dumpFile(
- $cacheDir.'/contao/config/twig-templates.php',
- sprintf("get('huh.utils.cache.database_tree')->generateAllCacheTree($cacheDir);
- }
-}
diff --git a/src/Choice/AbstractChoice.php b/src/Choice/AbstractChoice.php
deleted file mode 100644
index 87c925c8..00000000
--- a/src/Choice/AbstractChoice.php
+++ /dev/null
@@ -1,137 +0,0 @@
-framework = $framework;
- }
-
- /**
- * @return mixed
- */
- public function getContext()
- {
- return $this->context;
- }
-
- /**
- * @param mixed $context
- */
- public function setContext($context)
- {
- $this->context = $context;
-
- return $this;
- }
-
- public function getChoices($context = [])
- {
- if (!$context) {
- $context = [];
- }
-
- $this->setContext($context);
-
- $choices = $this->collect();
-
- return $choices;
- }
-
- public function getCachedChoices($context = [])
- {
- if (null === $context) {
- $context = [];
- }
-
- if (\is_array($context) && !isset($context['locale']) && ($request = System::getContainer()->get('request_stack')->getCurrentRequest())) {
- $context['locale'] = $request->getLocale();
- }
-
- $this->setContext($context);
-
- // disable cache while in debug mode or backend
- if (true === System::getContainer()->getParameter('kernel.debug') || System::getContainer()->get('huh.utils.container')->isBackend()) {
- return $this->getChoices($this->getContext());
- }
-
- $this->cacheKey = 'choice.'.preg_replace('#Choice$#', '', (new \ReflectionClass($this))->getShortName());
-
- // add unique identifier based on context
- if (null !== $this->getContext() && false !== ($json = json_encode($this->getContext(), \JSON_FORCE_OBJECT))) {
- $this->cacheKey .= '.'.sha1($json);
- }
-
- if (!$this->cache) {
- $this->cache = new FilesystemAdapter('', 0, System::getContainer()->get('kernel')->getCacheDir());
- }
-
- $cache = $this->cache->getItem($this->cacheKey);
-
- if (!$cache->isHit() || empty($cache->get())) {
- $choices = $this->getChoices($this->getContext());
-
- if (!\is_array($choices)) {
- $choices = [];
- }
-
- // TODO: clear cache on delegated field save_callback
- $cache->expiresAfter(\DateInterval::createFromDateString('4 hour'));
- $cache->set($choices);
-
- $this->cache->save($cache);
- }
-
- return $cache->get();
- }
-
- /**
- * @return array
- */
- abstract protected function collect();
-}
diff --git a/src/Choice/DataContainerChoice.php b/src/Choice/DataContainerChoice.php
deleted file mode 100644
index e638a8e9..00000000
--- a/src/Choice/DataContainerChoice.php
+++ /dev/null
@@ -1,40 +0,0 @@
-get('contao.resource_finder')->findIn('dca')->name('tl_*.php') as $file) {
- /** @var \SplFileInfo $file */
- $name = $file->getBasename('.php');
-
- if (\in_array($name, $choices)) {
- continue;
- }
-
- $choices[] = $name;
- }
- } catch (\InvalidArgumentException $e) {
- }
-
- sort($choices);
-
- return $choices;
- }
-}
diff --git a/src/Choice/FieldChoice.php b/src/Choice/FieldChoice.php
deleted file mode 100644
index b4e224e5..00000000
--- a/src/Choice/FieldChoice.php
+++ /dev/null
@@ -1,24 +0,0 @@
-getContext();
-
- return System::getContainer()->get('huh.utils.dca')->getFields($context['dataContainer'], $context);
- }
-}
diff --git a/src/Choice/MessageChoice.php b/src/Choice/MessageChoice.php
deleted file mode 100644
index 0333067b..00000000
--- a/src/Choice/MessageChoice.php
+++ /dev/null
@@ -1,46 +0,0 @@
-getContext();
-
- if (!\is_array($prefixes)) {
- $prefixes = [$prefixes];
- }
-
- $translator = System::getContainer()->get('translator');
-
- $catalog = $translator->getCatalogue();
- $all = $catalog->all();
- $messages = $all['messages'];
-
- if (!\is_array($messages)) {
- return $choices;
- }
-
- $choices = System::getContainer()->get('huh.utils.array')->filterByPrefixes($messages, $prefixes);
-
- foreach ($choices as $key => $value) {
- $choices[$key] = $value.'['.$key.']';
- }
-
- return $choices;
- }
-}
diff --git a/src/Choice/ModelInstanceChoice.php b/src/Choice/ModelInstanceChoice.php
deleted file mode 100644
index d752a3dd..00000000
--- a/src/Choice/ModelInstanceChoice.php
+++ /dev/null
@@ -1,103 +0,0 @@
-getContext();
- $choices = [];
-
- $instances = System::getContainer()->get('huh.utils.model')->findModelInstancesBy($context['dataContainer'], $context['columns'] ?? [], $context['values'] ?? null, isset($context['options']) ? (\is_array($context['options']) ? $context['options'] : []) : []);
-
- if (null === $instances) {
- return $choices;
- }
-
- while ($instances->next()) {
- $labelPattern = $context['labelPattern'] ?? null;
-
- if (!$labelPattern) {
- $labelPattern = 'ID %id%';
-
- switch ($context['dataContainer']) {
- case 'tl_member':
- $labelPattern = '%firstname% %lastname% (ID %id%)';
-
- break;
-
- default:
- foreach (static::TITLE_FIELDS as $titleField) {
- if (isset($GLOBALS['TL_DCA'][$context['dataContainer']]['fields'][$titleField])) {
- $labelPattern = '%'.$titleField.'% (ID %id%)';
-
- break;
- }
- }
-
- break;
- }
- }
-
- $skipFormatting = $context['skipFormatting'] ?? false;
-
- if (!$skipFormatting) {
- $dca = &$GLOBALS['TL_DCA']['tl_submission'];
- $dc = new DC_Table_Utils($context['dataContainer']);
- $dc->id = $instances->id;
- $dc->activeRecord = $instances->current();
-
- $label = preg_replace_callback(
- '@%([^%]+)%@i',
- function ($matches) use ($instances, $dca, $context, $dc) {
- return System::getContainer()->get('huh.utils.form')->prepareSpecialValueForOutput(
- $matches[1],
- $instances->{$matches[1]},
- $dc
- );
- },
- $labelPattern
- );
- } else {
- $label = preg_replace_callback(
- '@%([^%]+)%@i',
- function ($matches) use ($instances) {
- return $instances->{$matches[1]};
- },
- $labelPattern
- );
- }
-
- if (null !== ($callbackLabel = System::getContainer()->get('huh.utils.dca')->getConfigByArrayOrCallbackOrFunction($context, 'label', [$label, $instances->row(), $context]))) {
- $label = $callbackLabel;
- }
-
- $choices[$instances->id] = $label;
- }
-
- if (!isset($context['skipSorting']) || !$context['skipSorting']) {
- natcasesort($choices);
- }
-
- return $choices;
- }
-}
diff --git a/src/Choice/TwigTemplateChoice.php b/src/Choice/TwigTemplateChoice.php
deleted file mode 100644
index 879ea475..00000000
--- a/src/Choice/TwigTemplateChoice.php
+++ /dev/null
@@ -1,62 +0,0 @@
-getContext();
-
- if (!\is_array($prefixes)) {
- $prefixes = [$prefixes];
- }
-
- $prefixes = array_filter($prefixes);
-
- $kernel = System::getContainer()->get('kernel');
-
- $bundles = $kernel->getBundles();
- $pattern = !empty($prefixes) ? ('/(^'.implode('|^', $prefixes).').*twig/') : '*.twig';
-
- if (\is_array($bundles)) {
- foreach ($bundles as $key => $value) {
- $path = $kernel->locateResource("@$key");
- $finder = new Finder();
- $finder->in($path);
- $finder->files()->name($pattern);
- $twigKey = preg_replace('/Bundle$/', '', $key);
-
- foreach ($finder as $val) {
- $explodurl = explode('Resources'.\DIRECTORY_SEPARATOR.'views'.\DIRECTORY_SEPARATOR, $val->getRelativePathname());
- $string = end($explodurl);
- $choices[$val->getBasename('.html.twig')] = "@$twigKey/$string";
- }
- }
- }
-
- if (!System::getContainer()->has('huh.utils.container')) {
- return $choices;
- }
-
- foreach ($prefixes as $prefix) {
- $choices = array_merge($choices, System::getContainer()->get('huh.utils.template')->getTemplateGroup($prefix, 'html.twig'));
- }
-
- return $choices;
- }
-}
diff --git a/src/Classes/ClassUtil.php b/src/Classes/ClassUtil.php
deleted file mode 100644
index c06370cb..00000000
--- a/src/Classes/ClassUtil.php
+++ /dev/null
@@ -1,275 +0,0 @@
-arrayUtil = $arrayUtil;
- $this->stringUtil = $stringUtil;
- }
-
- /**
- * @return array
- */
- public function getParentClasses(string $class, array $parents = [])
- {
- $strParent = get_parent_class($class);
-
- if ($strParent) {
- $parents[] = $strParent;
-
- $parents = $this->getParentClasses($strParent, $parents);
- }
-
- return $parents;
- }
-
- /**
- * Filter class constants by given prefixes and return the extracted constants.
- *
- * @param string $class the class that should be searched for constants in
- * @param array $prefixes an array of prefixes that should be used to filter the class constants
- * @param bool $returnValueAsKey boolean Return the extracted array keys from its value, if true
- *
- * @throws \ReflectionException
- *
- * @return array the extracted constants as array
- */
- public function getConstantsByPrefixes(string $class, array $prefixes = [], bool $returnValueAsKey = true)
- {
- $arrExtract = [];
-
- if (!class_exists($class)) {
- return $arrExtract;
- }
-
- $objReflection = new \ReflectionClass($class);
- $arrConstants = $objReflection->getConstants();
-
- if (!\is_array($arrConstants)) {
- return $arrExtract;
- }
-
- $arrExtract = $this->arrayUtil->filterByPrefixes($arrConstants, $prefixes);
-
- return $returnValueAsKey ? array_combine($arrExtract, $arrExtract) : $arrExtract;
- }
-
- /**
- * Returns all classes in the given namespace.
- *
- * @return array
- */
- public function getClassesInNamespace(string $namespace)
- {
- $arrOptions = [];
-
- foreach (get_declared_classes() as $strName) {
- if ($this->stringUtil->startsWith($strName, $namespace)) {
- $arrOptions[$strName] = $strName;
- }
- }
-
- asort($arrOptions);
-
- return $arrOptions;
- }
-
- /**
- * Returns all children of a given class.
- *
- * @param string $strNamespace
- *
- * @return array
- */
- public function getChildClasses(string $qualifiedClassName)
- {
- $arrOptions = [];
-
- foreach (get_declared_classes() as $strName) {
- if (\in_array($qualifiedClassName, $this->getParentClasses($strName))) {
- $arrOptions[$strName] = $strName;
- }
- }
-
- asort($arrOptions);
-
- return $arrOptions;
- }
-
- /**
- * @param $method
- * @param \ReflectionClass $rc
- * @return int|null
- */
- private static function getMethodNameStartIndex($method, \ReflectionClass $rc): ?int
- {
- $len = 3;
- $prefix = substr($method->name, 0, $len);
-
- /** vvv Prefixes with length 3. vvv */
-
- // get{MethodName}()
- if ('get' === $prefix)
- return $len;
-
- // has{MethodName}()
- if ('has' === $prefix) {
- $name = ucfirst(substr($method->name, 3, strlen($method->name)));
- if ($rc->hasMethod("is$name") || $rc->hasMethod("get$name"))
- return 0;
- return $len;
- }
-
- /** vvv Prefixes with length 2. vvv */
-
- $len = 2;
- $prefix = substr($method->name, 0, $len);
-
- // is{MethodName}()
- if ('is' === $prefix) {
- $name = ucfirst(substr($method->name, 2, strlen($method->name)));
- if ($rc->hasMethod("has$name") || $rc->hasMethod("get$name"))
- return 0;
- return $len;
- }
-
- return null;
- }
-
- /**
- * Serialize a class object to JSON by iterating over all public getters (get(), is(), ...).
- *
- * @param $object
- * @param array $data
- * @param array $options
- *
- * @throws \ReflectionException if the class or method does not exist
- */
- public function jsonSerialize($object, $data = [], $options = []): array
- {
- $class = \get_class($object);
-
- $rc = new \ReflectionClass($object);
-
- // get values of properties
- if (isset($options['includeProperties']) && $options['includeProperties']) {
- foreach ($rc->getProperties() as $reflectionProperty) {
- $propertyName = $reflectionProperty->getName();
-
- $property = $rc->getProperty($propertyName);
-
- if (isset($options['ignorePropertyVisibility']) && $options['ignorePropertyVisibility']) {
- $property->setAccessible(true);
- }
-
- $data[$propertyName] = $property->getValue($object);
-
- if (\is_object($data[$propertyName])) {
- if (!($data[$propertyName] instanceof \JsonSerializable)) {
- unset($data[$propertyName]);
-
- continue;
- }
-
- $data[$propertyName] = $this->jsonSerialize($data[$propertyName]);
- }
- }
- }
-
- if (isset($options['ignoreMethods']) && $options['ignoreMethods']) {
- return $data;
- }
-
- // get values of methods
- if (isset($options['ignoreMethodVisibility']) && $options['ignoreMethodVisibility']) {
- $methods = $rc->getMethods();
- } else {
- $methods = $rc->getMethods(\ReflectionMethod::IS_PUBLIC);
- }
-
- // add all public getter Methods
- foreach ($methods as $method) {
-
- $start = self::getMethodNameStartIndex($method, $rc);
- if ($start === null) continue;
-
- // skip methods with parameters
- $rm = new \ReflectionMethod($class, $method->name);
-
- if ($rm->getNumberOfRequiredParameters() > 0) {
- continue;
- }
-
- if (isset($options['skippedMethods']) && \is_array($options['skippedMethods']) && \in_array($method->name, $options['skippedMethods'])) {
- continue;
- }
-
- $property = lcfirst(substr($method->name, $start));
-
- if (!$method->isPublic()) {
- $method->setAccessible(true);
- $data[$property] = $method->invoke($object);
- } else {
- $data[$property] = $object->{$method->name}();
- }
-
- if (\is_object($data[$property])) {
- if (!($data[$property] instanceof \JsonSerializable)) {
- unset($data[$property]);
-
- continue;
- }
- $data[$property] = $this->jsonSerialize($data[$property]);
- }
- }
-
- return $data;
- }
-
- /**
- * Calls an object's method which is inaccessible.
- *
- * @param $entity
- *
- * @throws \ReflectionException
- *
- * @return mixed|null
- */
- public function callInaccessibleMethod($entity, string $method)
- {
- $rc = new \ReflectionClass($entity);
-
- if ($rc->hasMethod($method)) {
- $method = $rc->getMethod($method);
- $method->setAccessible(true);
-
- return $method->invoke($entity);
- }
-
- return null;
- }
-}
diff --git a/src/Command/CreateImageSizeItemsCommand.php b/src/Command/CreateImageSizeItemsCommand.php
deleted file mode 100644
index 8cf7c522..00000000
--- a/src/Command/CreateImageSizeItemsCommand.php
+++ /dev/null
@@ -1,179 +0,0 @@
-contaoFramework = $contaoFramework;
- $this->utils = $utils;
- }
-
- /**
- * {@inheritdoc}
- */
- protected function configure()
- {
- $this
- ->setDescription('Creates image size items for a given image size entity. Image size entities with existing image size items will be skipped.')
- ->addArgument(
- 'image-size-ids',
- InputArgument::OPTIONAL,
- 'The comma separated ids of the image size. Skip the parameter in order to create image size items for all image size entities.'
- )
- ->addArgument(
- 'breakpoints',
- InputArgument::OPTIONAL,
- 'The comma separated breakpoints as pixel amounts (defaults to "576,768,992,1200,1400").', implode(',', static::DEFAULT_BREAKPOINTS)
- );
- }
-
- /**
- * {@inheritdoc}
- */
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $this->contaoFramework->initialize();
-
- $io = new SymfonyStyle($input, $output);
-
- // prevent sql injection
- $imageSizeIds = preg_replace('@[^0-9,]@i', '', $input->getArgument('image-size-ids'));
-
- $imageSizeIds = explode(',', $imageSizeIds);
- $breakpoints = explode(',', $input->getArgument('breakpoints'));
-
- $this->createImageSizes($io, $breakpoints, $imageSizeIds);
-
- return 0;
- }
-
- /**
- * @param ImageSizeModel $imageSize
- */
- protected function createItem(Model $imageSize, int $index, int $breakpoint, ?int $nextBreakpoint, int $mode)
- {
- $item = new ImageSizeItemModel();
-
- $item->tstamp = time();
- $item->pid = $imageSize->id;
- $item->sorting = 128 * $index;
- $item->densities = $imageSize->densities;
- $item->resizeMode = $imageSize->resizeMode;
-
- switch ($mode) {
- case static::MODE_FIRST:
- $item->media = '(max-width: '.($breakpoint - 1).'px)';
- $item->width = $breakpoint - 1;
-
- break;
-
- case static::MODE_INTERMEDIATE:
- $item->media = '(min-width: '.$breakpoint.'px) and (max-width: '.($nextBreakpoint - 1).'px)';
- $item->width = $nextBreakpoint - 1;
-
- break;
-
- case static::MODE_LAST:
- $item->media = '(min-width: '.$breakpoint.'px)';
- $item->width = max($breakpoint, $imageSize->width);
-
- break;
- }
-
- $item->height = ($item->width * $imageSize->height) / $imageSize->width;
-
- $item->save();
- }
-
- private function createImageSizes(SymfonyStyle $io, array $breakpoints, array $imageSizeIds = [])
- {
- sort($breakpoints);
-
- $creationCount = 0;
- $columns = (empty($imageSizeIds) ? [] : ['tl_image_size.id IN ('.implode(',', $imageSizeIds).')']);
-
- if (null === ($imageSizes = $this->utils->model()->findModelInstancesBy('tl_image_size', $columns, []))) {
- $io->error('No image sizes found for the given ids.');
-
- return false;
- }
-
- /** @var ImageSizeModel $imageSize */
- foreach ($imageSizes as $imageSize) {
- $existingItems = $this->utils->model()->findModelInstancesBy('tl_image_size_item', ['tl_image_size_item.pid=?'], [$imageSize->id]);
-
- if (null !== $existingItems) {
- $io->warning('Skipping image size ID '.$imageSize->id.' because it already has existing image size items.');
-
- continue;
- }
-
- $j = 0;
-
- // first
- $this->createItem($imageSize, $j++, $breakpoints[0], null, static::MODE_FIRST);
- ++$creationCount;
-
- // intermediates
- foreach ($breakpoints as $i => $breakpoint) {
- if ($i === \count($breakpoints) - 1) {
- continue;
- }
-
- $this->createItem($imageSize, $j++, $breakpoint, $breakpoints[$i + 1], static::MODE_INTERMEDIATE);
-
- ++$creationCount;
- }
-
- // last
- $this->createItem($imageSize, $j++, $breakpoints[\count($breakpoints) - 1], null, static::MODE_LAST);
- ++$creationCount;
- }
-
- $io->success($creationCount.' image size items have been created.');
-
- return true;
- }
-}
diff --git a/src/Command/EntityFinderCommand.php b/src/Command/EntityFinderCommand.php
index 454c4aa8..d928f546 100644
--- a/src/Command/EntityFinderCommand.php
+++ b/src/Command/EntityFinderCommand.php
@@ -30,42 +30,26 @@
class EntityFinderCommand extends Command
{
protected static $defaultName = 'huh:utils:entity_finder';
+ protected static $defaultDescription = 'A command to find where an entity is included.';
- /** @var ContaoFramework */
- private $contaoFramework;
- /**
- * @var EventDispatcherInterface
- */
- private $eventDispatcher;
- /**
- * @var Connection
- */
- private $connection;
- /**
- * @var EntityFinderHelper
- */
- private $entityFinderHelper;
-
- public function __construct(ContaoFramework $contaoFramework, EventDispatcherInterface $eventDispatcher, Connection $connection, EntityFinderHelper $entityFinderHelper)
+ public function __construct(
+ private ContaoFramework $contaoFramework,
+ private EventDispatcherInterface $eventDispatcher,
+ private Connection $connection,
+ private EntityFinderHelper $entityFinderHelper)
{
parent::__construct();
-
- $this->contaoFramework = $contaoFramework;
- $this->eventDispatcher = $eventDispatcher;
- $this->connection = $connection;
- $this->entityFinderHelper = $entityFinderHelper;
}
- protected function configure()
+ protected function configure(): void
{
$this
->addArgument('table', InputArgument::REQUIRED, 'The database table')
->addArgument('id', InputArgument::REQUIRED, 'The entity id or alias (id is better supported).')
- ->setDescription('A command to find where an entity is included.')
;
}
- protected function execute(InputInterface $input, OutputInterface $output)
+ protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->contaoFramework->initialize();
$io = new SymfonyStyle($input, $output);
diff --git a/src/Comparison/CompareUtil.php b/src/Comparison/CompareUtil.php
deleted file mode 100644
index 6e79ae6e..00000000
--- a/src/Comparison/CompareUtil.php
+++ /dev/null
@@ -1,137 +0,0 @@
-framework = $framework;
- }
-
- /**
- * @param $value1
- * @param $value2
- */
- public function compareValue(string $operator, $value1, $value2 = null): bool
- {
- if (\in_array($operator, self::PHP_SINGLE_VALUE_OPERATORS)) {
- return $this->compareSingleValue($value1, $operator);
- }
-
- if (!$value1 || !$value2) {
- return false;
- }
-
- switch ($operator) {
- case self::PHP_OPERATOR_EQUAL:
- return $value1 == $value2;
-
- break;
-
- case self::PHP_OPERATOR_UNEQUAL:
- return $value1 != $value2;
-
- break;
-
- case self::PHP_OPERATOR_LIKE:
- return false !== strpos($value1, $value2);
-
- break;
-
- case self::PHP_OPERATOR_UNLIKE:
- return false === strpos($value1, $value2);
-
- break;
-
- case self::PHP_OPERATOR_IN_ARRAY:
- return \in_array($value2, $value1);
-
- break;
-
- case self::PHP_OPERATOR_NOT_IN_ARRAY:
- return !\in_array($value2, $value1);
-
- break;
-
- case self::PHP_OPERATOR_LOWER:
- return $value1 < $value2;
-
- break;
-
- case self::PHP_OPERATOR_LOWER_EQUAL:
- return $value1 <= $value2;
-
- break;
-
- case self::PHP_OPERATOR_GREATER:
- return $value1 > $value2;
-
- break;
-
- case self::PHP_OPERATOR_GREATER_EQUAL:
- return $value1 >= $value2;
- }
- }
-
- /**
- * @param $value
- */
- public function compareSingleValue($value, string $operator): bool
- {
- switch ($operator) {
- case self::PHP_OPERATOR_IS_NULL:
- return null === $value;
-
- break;
-
- case self::PHP_OPERATOR_IS_NOT_NULL:
- return null !== $value;
- }
- }
-}
diff --git a/src/Container/ContainerUtil.php b/src/Container/ContainerUtil.php
deleted file mode 100644
index 28c823ea..00000000
--- a/src/Container/ContainerUtil.php
+++ /dev/null
@@ -1,272 +0,0 @@
-container = $container;
- $this->utils = $utils;
- }
-
- /**
- * Returns the active bundles.
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use kernel.bundles parameter or KernelInterface::getBundles()
- */
- public function getActiveBundles(): array
- {
- return $this->container->getParameter('kernel.bundles');
- }
-
- /**
- * Checks if some bundle is active. Pass in the class name (e.g. 'HeimrichHannot\FilterBundle\HeimrichHannotContaoFilterBundle' or the legacy Contao 3 name like 'news').
- *
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isBundleActive(string $bundleName)
- {
- return $this->utils->container()->isBundleActive($bundleName);
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isBackend()
- {
- return $this->utils->container()->isBackend();
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isFrontend()
- {
- return $this->utils->container()->isFrontend();
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isFrontendCron()
- {
- return $this->utils->container()->isFrontendCron();
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isInstall()
- {
- return $this->utils->container()->isInstall();
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isDev()
- {
- return $this->utils->container()->isDev();
- }
-
- /**
- * @return mixed
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use RequestStack::getCurrentRequest() instead
- */
- public function getCurrentRequest()
- {
- return $this->container->get('request_stack')->getCurrentRequest();
- }
-
- /**
- * @param string $category Use constants in ContaoContext
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function log(string $text, string $function, string $category)
- {
- $this->utils->container()->log($text, $function, $category);
- }
-
- /**
- * Returns the project root path.
- *
- * @return mixed
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use KernelInterface::getProjectDir or kernel.project_dir parameter
- */
- public function getProjectDir()
- {
- return $this->container->getParameter('kernel.project_dir');
- }
-
- /**
- * Returns the web folder path.
- *
- * @return mixed
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use contao.web_dir parameter
- */
- public function getWebDir()
- {
- return $this->container->getParameter('contao.web_dir');
- }
-
- /**
- * Returns the path to the bundle in vendor folder
- * Attention: resolves symlinks!
- *
- * @param string $bundleClass The bundle class class constant (VendorMyBundle::class)
- *
- * @return bool|string False on error
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function getBundlePath(string $bundleClass)
- {
- $result = $this->utils->container()->getBundlePath($bundleClass);
-
- if (null === $result) {
- return false;
- }
-
- return $result;
- }
-
- /**
- * Returns the path or paths to a ressource within a bundle
- * Attention: resolves symlinks!
- *
- * @param string $bundleClass The bundle class class constant (VendorMyBundle::class)
- * @param string $ressourcePath a ressource or path to ressource
- * @param bool $first Returns only first occurrence if multiple paths found
- *
- * @return bool|string|array False on error
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function getBundleResourcePath(string $bundleClass, string $ressourcePath = '', $first = false)
- {
- $result = $this->utils->container()->getBundleResourcePath($bundleClass, $ressourcePath, $first);
-
- if (null === $result) {
- return false;
- }
-
- return $result;
- }
-
- /**
- * Recursively merges a config.yml with a $extensionConfigs array in the context of ExtensionPluginInterface::getExtensionConfig().
- * Must be static, because on Plugin::getExtensionConfig() no contao.framework nor service huh.utils.container is available.
- *
- * @return array
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use ConfigPluginInterface with class_exist instead
- */
- public static function mergeConfigFile(
- string $activeExtensionName,
- string $extensionName,
- array $extensionConfigs,
- string $configFile
- ) {
- if ($activeExtensionName === $extensionName && file_exists($configFile)) {
- $config = Yaml::parseFile($configFile);
-
- $extensionConfigs = array_merge_recursive(\is_array($extensionConfigs) ? $extensionConfigs : [], \is_array($config) ? $config : []);
- }
-
- return $extensionConfigs;
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isMaintenanceModeActive()
- {
- return $this->utils->container()->isMaintenanceModeActive();
- }
-
- /**
- * @return bool
- *
- * @codeCoverageIgnore
- *
- * @deprecated Use utils service instead
- */
- public function isPreviewMode()
- {
- return $this->utils->container()->isPreviewMode();
- }
-}
diff --git a/src/ContaoManager/Plugin.php b/src/ContaoManager/Plugin.php
index 25834a04..e1882554 100644
--- a/src/ContaoManager/Plugin.php
+++ b/src/ContaoManager/Plugin.php
@@ -13,7 +13,6 @@
use Contao\ManagerPlugin\Bundle\Config\BundleConfig;
use Contao\ManagerPlugin\Bundle\Parser\ParserInterface;
use Contao\ManagerPlugin\Config\ConfigPluginInterface;
-use HeimrichHannot\UtilsBundle\HeimrichHannotContaoUtilsBundle;
use HeimrichHannot\UtilsBundle\HeimrichHannotUtilsBundle;
use Symfony\Component\Config\Loader\LoaderInterface;
@@ -25,11 +24,8 @@ class Plugin implements BundlePluginInterface, ConfigPluginInterface
public function getBundles(ParserInterface $parser)
{
return [
- BundleConfig::create(HeimrichHannotContaoUtilsBundle::class)
- ->setLoadAfter([ContaoCoreBundle::class]),
BundleConfig::create(HeimrichHannotUtilsBundle::class)->setLoadAfter([
ContaoCoreBundle::class,
- HeimrichHannotContaoUtilsBundle::class,
]),
];
}
@@ -39,14 +35,6 @@ public function getBundles(ParserInterface $parser)
*/
public function registerContainerConfiguration(LoaderInterface $loader, array $managerConfig)
{
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/choices.yml');
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/parameters.yml');
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/services.yml');
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/twig.yml');
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/utils.yml');
-
- if (class_exists('HeimrichHannot\EncoreBundle\HeimrichHannotContaoEncoreBundle')) {
- $loader->load('@HeimrichHannotContaoUtilsBundle/Resources/config/config_encore.yml');
- }
+ $loader->load('@HeimrichHannotUtilsBundle/config/services.yml');
}
}
diff --git a/src/Content/ContentUtil.php b/src/Content/ContentUtil.php
deleted file mode 100644
index 48c4841b..00000000
--- a/src/Content/ContentUtil.php
+++ /dev/null
@@ -1,70 +0,0 @@
-framework = $container->get('contao.framework');
- $this->container = $container;
- }
-
- public function getMultilingualElements($id, $ptable)
- {
- if (null === ($contentElements = $this->container->get('huh.utils.model')->findModelInstancesBy('tl_content', ['tl_content.pid=?', 'tl_content.ptable=?'], [
- $id,
- $ptable,
- ], ['order' => 'tl_content.sorting ASC']))) {
- return '';
- }
-
- foreach ($contentElements as $contentElement) {
- $types = [
- 'colsetStart',
- 'colsetPart',
- 'colsetEnd',
- 'accordionStart',
- 'accordionStop',
- 'tiny-slider-content-start',
- 'tiny-slider-content-separator',
- 'tiny-slider-content-stop',
- ];
-
- $skip = \in_array($contentElement->type, $types);
-
- if ($this->container->get('huh.utils.dca')->isDcMultilingual('tl_calendar_events') &&
- $GLOBALS['TL_DCA']['tl_calendar_events']['config']['fallbackLang'] !== $GLOBALS['TL_LANGUAGE']) {
- if (!$contentElement->langPid && !$skip) {
- continue;
- }
-
- if (!$skip) {
- $contentElement->id = $contentElement->langPid;
- }
- }
-
- $result .= Controller::getContentElement($contentElement);
- }
-
- return $result;
- }
-}
diff --git a/src/Database/DatabaseUtil.php b/src/Database/DatabaseUtil.php
deleted file mode 100644
index 6fe82e4e..00000000
--- a/src/Database/DatabaseUtil.php
+++ /dev/null
@@ -1,1005 +0,0 @@
- 'like',
- self::OPERATOR_UNLIKE => 'notLike',
- self::OPERATOR_EQUAL => 'eq',
- self::OPERATOR_UNEQUAL => 'neq',
- self::OPERATOR_LOWER => 'lt',
- self::OPERATOR_LOWER_EQUAL => 'lte',
- self::OPERATOR_GREATER => 'gt',
- self::OPERATOR_GREATER_EQUAL => 'gte',
- self::OPERATOR_IN => 'in',
- self::OPERATOR_NOT_IN => 'notIn',
- self::OPERATOR_IS_NULL => 'isNull',
- self::OPERATOR_IS_NOT_NULL => 'isNotNull',
- ];
-
- /** @var ContaoFrameworkInterface */
- protected $framework;
-
- public function __construct(ContaoFrameworkInterface $framework)
- {
- $this->framework = $framework;
- }
-
- /**
- * Process a query in pieces, run callback within each cycle.
- *
- * @param string $countQuery The query that count the total rows, must contain "Select COUNT(*) as total"
- * @param string $query The query, with the rows that should be iterated over
- * @param callable $callback A callback that should be triggered after each cycle, contains $arrRows of current cycle
- * @param string $key The key of the value that should be set as key identifier for the returned result array entries
- * @param int $bulkSize The bulk size
- *
- * @return bool|int False if nothing to do, otherwise return the total number of processes entities
- */
- public function processInPieces(string $countQuery, string $query, $callback = null, string $key = null, int $bulkSize = 5000)
- {
- /** @var Database $database */
- $database = $this->framework->createInstance(Database::class);
- $total = $database->execute($countQuery);
-
- if ($total->total < 1) {
- return false;
- }
-
- $bulkSize = (int) $bulkSize;
- $totalCount = $total->total;
- $cycles = $totalCount / $bulkSize;
-
- for ($i = 0; $i <= $cycles; ++$i) {
- $result = $database->prepare($query)->limit($bulkSize, $i * $bulkSize)->execute();
-
- if ($result->numRows < 1) {
- return false;
- }
-
- if (\is_callable($callback)) {
- $return = [];
-
- while (false !== ($row = $result->fetchAssoc())) {
- if ($key) {
- if (isset($row[$key])) {
- $return[$row[$key]] = $row;
- }
-
- continue;
- }
-
- $return[] = $row;
- }
-
- \call_user_func_array($callback, [$return]);
- }
- }
-
- return $totalCount;
- }
-
- /**
- * Bulk insert SQL of given data.
- *
- * @param string $table The database table, where new items should be stored inside
- * @param array $data An array of values associated to its field
- * @param array $fixedValues A array of fixed values associated to its field that should be set for each row as fixed values
- * @param mixed $onDuplicateKey null = Throw error on duplicates, self::ON_DUPLICATE_KEY_IGNORE = ignore error duplicates (skip this entries),
- * self::ON_DUPLICATE_KEY_UPDATE = update existing entries
- * @param callable $callback A callback that should be triggered after each cycle, contains $arrValues of current cycle
- * @param callable $itemCallback A callback to change the insert values for each items, contains $arrValues as first argument, $arrFields as
- * second, $arrOriginal as third, expects an array as return value with same order as $arrFields, if no array is
- * returned, insert of the row will be skipped item insert
- * @param int $bulkSize The bulk size
- * @param string $pk The primary key of the current table (default: id)
- */
- public function doBulkInsert(
- string $table,
- array $data = [],
- array $fixedValues = [],
- $onDuplicateKey = null,
- $callback = null,
- $itemCallback = null,
- int $bulkSize = 100,
- string $pk = 'id'
- ) {
- /** @var Database $database */
- $database = $this->framework->createInstance(Database::class);
-
- if (!$database->tableExists($table) || empty($data)) {
- return null;
- }
-
- $fields = $database->getFieldNames($table, true);
- System::getContainer()->get('huh.utils.array')->removeValue($pk, $fields); // unset id
- $fields = array_values($fields);
-
- $bulkSize = (int) $bulkSize;
-
- $query = '';
- $duplicateKey = '';
- $startQuery = sprintf('INSERT %s INTO %s (%s) VALUES ', self::ON_DUPLICATE_KEY_IGNORE === $onDuplicateKey ? 'IGNORE' : '', $table, implode(',', $fields));
-
- if (self::ON_DUPLICATE_KEY_UPDATE === $onDuplicateKey) {
- $duplicateKey = ' ON DUPLICATE KEY UPDATE '.implode(
- ',',
- array_map(
- function ($val) {
- // escape double quotes
- return $val.' = VALUES('.$val.')';
- },
- $fields
- )
- );
- }
-
- $i = 0;
-
- $columnWildcards = array_map(
- function ($val) {
- return '?';
- },
- $fields
- );
-
- foreach ($data as $key => $varData) {
- if (0 === $i) {
- $values = [];
- $return = [];
- $query = $startQuery;
- }
-
- $columns = $columnWildcards;
-
- if ($varData instanceof Model) {
- $varData = $varData->row();
- }
-
- foreach ($fields as $n => $strField) {
- $varValue = isset($varData[$strField]) ? $varData[$strField] : 'DEFAULT';
-
- if (\in_array($strField, array_keys($fixedValues))) {
- $varValue = $fixedValues[$strField];
- }
-
- // replace SQL Keyword DEFAULT within wildcards ?
- if ('DEFAULT' === $varValue) {
- $columns[$n] = 'DEFAULT';
-
- continue;
- }
-
- $return[$i][$strField] = $varValue;
- }
-
- // manipulate the item
- if (\is_callable($itemCallback)) {
- if (!isset($return[$i])) {
- continue;
- }
- $varCallback = \call_user_func_array($itemCallback, [$return[$i], $fields, $varData]);
-
- if (!\is_array($varCallback)) {
- continue;
- }
-
- foreach ($fields as $n => $strField) {
- $varValue = isset($varCallback[$strField]) ? $varCallback[$strField] : 'DEFAULT';
-
- // replace SQL Keyword DEFAULT within wildcards ?
- if ('DEFAULT' === $varValue) {
- $columns[$n] = 'DEFAULT';
-
- continue;
- }
-
- $columns[$n] = '?';
- $return[$i][$strField] = $varValue;
- }
- }
-
- // add values to insert array
- $values = array_merge($values, array_values($return[$i]));
-
- $query .= '('.implode(',', $columns).'),';
-
- ++$i;
-
- if ($bulkSize === $i) {
- $query = rtrim($query, ',');
-
- if (self::ON_DUPLICATE_KEY_UPDATE === $onDuplicateKey) {
- $query .= $duplicateKey;
- }
-
- $database->prepare($query)->execute($values);
-
- if (\is_callable($callback)) {
- \call_user_func_array($callback, [$return]);
- }
-
- $query = '';
-
- $i = 0;
- }
- }
-
- // remaining elements < $intBulkSize
- if ($query) {
- $query = rtrim($query, ',');
-
- if (self::ON_DUPLICATE_KEY_UPDATE === $onDuplicateKey) {
- $query .= $duplicateKey;
- }
-
- $database->prepare($query)->execute($values);
-
- if (\is_callable($callback)) {
- \call_user_func_array($callback, [$return]);
- }
- }
- }
-
- /**
- * Create a where condition for a field that contains a serialized blob.
- *
- * @param string $field The field the condition should be checked against accordances
- * @param array $values The values array to check the field against
- * @param string $connective SQL_CONDITION_OR | SQL_CONDITION_AND
- * @param array $options Pass additional options.
- *
- * Options:
- * - inline_values: (bool) Inline the values in the sql part instead of using ? ('REGEXP (':"3"')' instead of 'REGEXP (?)'). Return value not change (still an array with an values index)
- *
- * @return array
- */
- public function createWhereForSerializedBlob(string $field, array $values, string $connective = self::SQL_CONDITION_OR, array $options = [])
- {
- $where = null;
- $returnValues = [];
- $inlineValues = $options['inline_values'] ?? false;
-
- if (!\in_array($connective, [self::SQL_CONDITION_OR, self::SQL_CONDITION_AND])) {
- throw new \Exception('Unknown sql junctor');
- }
-
- foreach ($values as $val) {
- if (null !== $where) {
- $where .= " $connective ";
- }
-
- $value = ":\"$val\"";
-
- $where .= self::SQL_CONDITION_AND == $connective ? '(' : '';
-
- $where .= "$field REGEXP (".($inlineValues ? $value : '?').')';
-
- $where .= self::SQL_CONDITION_AND == $connective ? ')' : '';
-
- $returnValues[] = $value;
- }
-
- return ["($where)", $returnValues];
- }
-
- /**
- * Transforms verbose operators to valid MySQL operators (aka junctors).
- * Supports: like, unlike, equal, unequal, lower, greater, lowerequal, greaterequal, in, notin.
- *
- * @return string|bool The transformed operator or false if not supported
- */
- public function transformVerboseOperator(string $verboseOperator)
- {
- switch ($verboseOperator) {
- case static::OPERATOR_LIKE:
- return 'LIKE';
-
- case static::OPERATOR_UNLIKE:
- return 'NOT LIKE';
-
- case static::OPERATOR_EQUAL:
- return '=';
-
- case static::OPERATOR_UNEQUAL:
- return '!=';
-
- case static::OPERATOR_LOWER:
- return '<';
-
- case static::OPERATOR_GREATER:
- return '>';
-
- case static::OPERATOR_LOWER_EQUAL:
- return '<=';
-
- case static::OPERATOR_GREATER_EQUAL:
- return '>=';
-
- case static::OPERATOR_IN:
- return 'IN';
-
- break;
-
- case static::OPERATOR_NOT_IN:
- return 'NOT IN';
-
- case static::OPERATOR_IS_NULL:
- return 'NOT IN';
-
- case static::OPERATOR_IS_NOT_NULL:
- return 'IS NOT NULL';
-
- case static::OPERATOR_IS_EMPTY:
- return '=""';
-
- case static::OPERATOR_IS_NOT_EMPTY:
- return '!=""';
- }
-
- return false;
- }
-
- /**
- * Computes a MySQL condition appropriate for the given operator.
- *
- * @param mixed $value
- * @param string $table
- *
- * @return array Returns array($strQuery, $arrValues)
- */
- public function computeCondition(string $field, string $operator, $value, string $table = null, bool $skipTablePrefix = false)
- {
- $operator = trim(strtolower($operator));
- $values = [];
- $pattern = '?';
- $addQuotes = false;
-
- $explodedField = explode('.', $field);
-
- // remove table if already added to field name
- if (\count($explodedField) > 1) {
- $field = end($explodedField);
- }
-
- if ($table) {
- Controller::loadDataContainer($table);
-
- $dca = &$GLOBALS['TL_DCA'][$table]['fields'][$field];
-
- if (isset($dca['sql']) && false !== stripos($dca['sql'], 'blob')) {
- $addQuotes = true;
- }
- }
-
- switch ($operator) {
- case static::OPERATOR_UNLIKE:
- if (\is_array($value)) {
- foreach ($value as $val) {
- $values[] = Controller::replaceInsertTags('%'.($addQuotes ? '"'.$val.'"' : $val).'%', false);
- }
-
- break;
- }
- $values[] = Controller::replaceInsertTags('%'.($addQuotes ? '"'.$value.'"' : $value).'%', false);
-
- break;
-
- case static::OPERATOR_EQUAL:
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_UNEQUAL:
- case '<>':
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_LOWER:
- $pattern = 'CAST(? AS DECIMAL)';
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_GREATER:
- $pattern = 'CAST(? AS DECIMAL)';
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_LOWER_EQUAL:
- $pattern = 'CAST(? AS DECIMAL)';
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_GREATER_EQUAL:
- $pattern = 'CAST(? AS DECIMAL)';
- $values[] = Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false);
-
- break;
-
- case static::OPERATOR_IN:
- $value = array_filter(explode(',', Controller::replaceInsertTags($value, false)));
-
- // skip if empty to avoid sql error
- if (empty($value)) {
- break;
- }
-
- $pattern = '('.implode(
- ',',
- array_map(
- function ($val) {
- return '"'.addslashes(trim($val)).'"';
- },
- $value
- )
- ).')';
-
- break;
-
- case static::OPERATOR_NOT_IN:
- $value = array_filter(explode(',', Controller::replaceInsertTags($value, false)));
-
- // skip if empty to avoid sql error
- if (empty($value)) {
- break;
- }
-
- $pattern = '('.implode(
- ',',
- array_map(
- function ($val) {
- return '"'.addslashes(trim($val)).'"';
- },
- $value
- )
- ).')';
-
- break;
-
- case static::OPERATOR_IS_NULL:
- case static::OPERATOR_IS_NOT_NULL:
- case static::OPERATOR_IS_EMPTY:
- case static::OPERATOR_IS_NOT_EMPTY:
- $pattern = '';
-
- break;
-
- default:
- if (\is_array($value)) {
- foreach ($value as $val) {
- $values[] = Controller::replaceInsertTags('%'.($addQuotes ? '"'.$val.'"' : $val).'%', false);
- }
-
- break;
- }
- $values[] = Controller::replaceInsertTags('%'.($addQuotes ? '"'.$value.'"' : $value).'%', false);
-
- break;
- }
-
- $operator = $this->transformVerboseOperator($operator);
-
- return [(!$skipTablePrefix && $table ? $table.'.' : '')."$field $operator $pattern", $values];
- }
-
- /**
- * @param null $value
- * @param array $options {wildcardSuffix: string}
- *
- * @return string
- */
- public function composeWhereForQueryBuilder(QueryBuilder $queryBuilder, string $field, string $operator, array $dca = null, $value = null, array $options = [])
- {
- $wildcardSuffix = $options['wildcardSuffix'] ?? '';
- $wildcard = ':'.str_replace('.', '_', $field).$wildcardSuffix;
- $wildcardParameterName = substr($wildcard, 1);
- $where = '';
-
- // remove dot for table prefixes
- if (false !== strpos($wildcard, '.')) {
- $wildcard = str_replace('.', '_', $wildcard);
- }
-
- switch ($operator) {
- case self::OPERATOR_LIKE:
- $where = $queryBuilder->expr()->like($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, '%'.Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false).'%');
-
- break;
-
- case self::OPERATOR_UNLIKE:
- $where = $queryBuilder->expr()->notLike($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, '%'.Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false).'%');
-
- break;
-
- case self::OPERATOR_EQUAL:
- $where = $queryBuilder->expr()->eq($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_UNEQUAL:
- $where = $queryBuilder->expr()->neq($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_LOWER:
- $where = $queryBuilder->expr()->lt($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_LOWER_EQUAL:
- $where = $queryBuilder->expr()->lte($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_GREATER:
- $where = $queryBuilder->expr()->gt($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_GREATER_EQUAL:
- $where = $queryBuilder->expr()->gte($field, $wildcard);
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
-
- break;
-
- case self::OPERATOR_IN:
- $value = array_filter(!\is_array($value) ? explode(',', $value) : $value);
-
- // if empty add an unfulfillable condition in order to avoid an sql error
- if (empty($value)) {
- $where = $queryBuilder->expr()->eq(1, 2);
- } else {
- $where = $queryBuilder->expr()->in($field, $wildcard);
- $preparedValue = array_map(
- function ($val) {
- return addslashes(Controller::replaceInsertTags(trim($val), false));
- },
- $value
- );
- $queryBuilder->setParameter($wildcardParameterName, $preparedValue, Connection::PARAM_STR_ARRAY);
- }
-
- break;
-
- case self::OPERATOR_NOT_IN:
- $value = array_filter(!\is_array($value) ? explode(',', $value) : $value);
-
- // if empty add an unfulfillable condition in order to avoid an sql error
- if (empty($value)) {
- $where = $queryBuilder->expr()->eq(1, 2);
- } else {
- $where = $queryBuilder->expr()->notIn($field, $wildcard);
- $preparedValue = array_map(
- function ($val) {
- return addslashes(Controller::replaceInsertTags(trim($val), false));
- },
- $value
- );
- $queryBuilder->setParameter($wildcardParameterName, $preparedValue, Connection::PARAM_STR_ARRAY);
- }
-
- break;
-
- case self::OPERATOR_IS_NULL:
- $where = $queryBuilder->expr()->isNull($field);
-
- break;
-
- case self::OPERATOR_IS_NOT_NULL:
- $where = $queryBuilder->expr()->isNotNull($field);
-
- break;
-
- case self::OPERATOR_IS_EMPTY:
- $where = $queryBuilder->expr()->eq($field, '\'\'');
-
- break;
-
- case self::OPERATOR_IS_NOT_EMPTY:
- $where = $queryBuilder->expr()->neq($field, '\'\'');
-
- break;
-
- case self::OPERATOR_REGEXP:
- case self::OPERATOR_NOT_REGEXP:
- $where = $field.(self::OPERATOR_NOT_REGEXP == $operator ? ' NOT REGEXP ' : ' REGEXP ').$wildcard;
-
- if (\is_array($dca) && isset($dca['eval']['multiple']) && $dca['eval']['multiple']) {
- // match a serialized blob
- if (\is_array($value)) {
- // build a regexp alternative, e.g. (:"1";|:"2";)
- $queryBuilder->setParameter(
- $wildcardParameterName,
- '('.implode(
- '|',
- array_map(
- function ($val) {
- return ':"'.Controller::replaceInsertTags($val, false).'";';
- },
- $value
- )
- ).')'
- );
- } else {
- $queryBuilder->setParameter($wildcardParameterName, ':"'.Controller::replaceInsertTags($value, false).'";');
- }
- } else {
- // TODO: this makes no sense, yet
- $queryBuilder->setParameter($wildcardParameterName, Controller::replaceInsertTags(\is_array($value) ? implode(' ', $value) : $value, false));
- }
-
- break;
- }
-
- return $where;
- }
-
- public function getChildRecords(array $parentIds, string $table, array $options = []): array
- {
- $children = [];
- $db = $this->framework->createInstance(Database::class);
- $sorting = (isset($options['sorting']) && $options['sorting'] ? ' ORDER BY '.$db->findInSet($table.'.pid', $parentIds).', sorting' : false);
- $fetchRows = isset($options['fetchRows']) && $options['fetchRows'];
- $recursive = isset($options['recursive']) && $options['recursive'];
-
- $childRecords = $db->query('SELECT '.($fetchRows ? '*' : "$table.id, $table.pid")." FROM $table WHERE $table.pid IN(".implode(',', $parentIds).')'.$sorting);
-
- if ($childRecords->numRows > 0) {
- while ($childRecords->next()) {
- $row = $childRecords->row();
- $children[] = $fetchRows ? $row : $row['id'];
- }
-
- if ($recursive) {
- $children = array_merge($children, $this->getChildRecords($childRecords->fetchEach('id'), $table, $options));
- }
- }
-
- return $children;
- }
-
- /**
- * Returns a database result for a given table and id(primary key).
- *
- * @param mixed $pk
- *
- * @return mixed
- */
- public function findResultByPk(string $table, $pk, array $options = [])
- {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- $options = array_merge(
- [
- 'limit' => 1,
- 'column' => 'id',
- 'value' => $pk,
- ],
- $options
- );
-
- $options['table'] = $table;
-
- if (isset($options['selectFields'])) {
- $query = $this->createQueryWithoutRelations($options['selectFields']);
- } else {
- $query = \Contao\Model\QueryBuilder::find($options);
- }
-
- $statement = $db->getInstance()->prepare($query);
-
- // Defaults for limit and offset
- if (!isset($options['limit'])) {
- $options['limit'] = 0;
- }
-
- if (!isset($options['offset'])) {
- $options['offset'] = 0;
- }
-
- // Limit
- if ($options['limit'] > 0 || $options['offset'] > 0) {
- $statement->limit($options['limit'], $options['offset']);
- }
-
- return $statement->execute($options['value']);
- }
-
- /**
- * Return a single database result by table and search criteria.
- *
- * @return mixed
- */
- public function findOneResultBy(string $table, ?array $columns, ?array $values, array $options = [])
- {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- $options = array_merge(
- [
- 'limit' => 1,
- 'column' => $columns,
- 'value' => $values,
- ],
- $options
- );
-
- $options['table'] = $table;
-
- if (isset($options['selectFields'])) {
- $query = $this->createQueryWithoutRelations($options['selectFields']);
- } else {
- $query = \Contao\Model\QueryBuilder::find($options);
- }
-
- $statement = $db->getInstance()->prepare($query);
-
- if (!isset($options['offset'])) {
- $options['offset'] = 0;
- }
-
- // Limit
- if ($options['limit'] > 0 || $options['offset'] > 0) {
- $statement->limit($options['limit'], $options['offset']);
- }
-
- return $statement->execute($options['value']);
- }
-
- public function findResultsBy(string $table, ?array $columns, ?array $values, array $options = [])
- {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- if (null !== $columns) {
- $options = array_merge(
- [
- 'column' => $columns,
- ],
- $options
- );
- }
-
- if (null !== $values) {
- $options = array_merge(
- [
- 'value' => $values,
- ],
- $options
- );
- }
-
- $options['table'] = $table;
-
- if (isset($options['selectFields'])) {
- $query = $this->createQueryWithoutRelations($options);
- } else {
- $query = \Contao\Model\QueryBuilder::find($options);
- }
-
- $statement = $db->getInstance()->prepare($query);
-
- // Defaults for limit and offset
- if (!isset($options['limit'])) {
- $options['limit'] = 0;
- }
-
- if (!isset($options['offset'])) {
- $options['offset'] = 0;
- }
-
- // Limit
- if ($options['limit'] > 0 || $options['offset'] > 0) {
- $statement->limit($options['limit'], $options['offset']);
- }
-
- return isset($options['value']) ? $statement->execute($options['value']) : $statement->execute();
- }
-
- public function insert(string $table, array $set, array $options = [])
- {
- $db = $options['databaseObject'] ?? null;
-
- if (!$db) {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- $db = $db->getInstance();
- }
-
- $columnNames = implode(',', array_keys($set));
-
- $wildcards = implode(',', array_map(function () {
- return '?';
- }, $set));
-
- $query = "INSERT INTO $table ($columnNames) VALUES ($wildcards)";
-
- return \call_user_func_array([$db->prepare($query), 'execute'], array_values($set));
- }
-
- public function update(string $table, array $set, string $where = null, array $whereValues = [], array $options = [])
- {
- $db = $options['databaseObject'] ?? null;
-
- if (!$db) {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- $db = $db->getInstance();
- }
-
- $assignments = implode(',', array_map(function ($column) {
- return "$column=?";
- }, array_keys($set)));
-
- $query = "UPDATE $table SET $assignments".($where ? " WHERE $where" : '');
-
- return \call_user_func_array([$db->prepare($query), 'execute'], array_merge(array_values($set), $whereValues));
- }
-
- public function delete(string $table, string $where = null, array $whereValues = [], array $options = [])
- {
- $db = $options['databaseObject'] ?? null;
-
- if (!$db) {
- /* @var Database $db */
- if (!($db = $this->framework->getAdapter(Database::class))) {
- return null;
- }
-
- $db = $db->getInstance();
- }
-
- $query = "DELETE FROM $table".($where ? " WHERE $where" : '');
-
- return \call_user_func_array([$db->prepare($query), 'execute'], $whereValues);
- }
-
- public function beginTransaction()
- {
- /* @var Database $db */
- if (!($db = $this->framework->createInstance(Database::class))) {
- return null;
- }
-
- $db->beginTransaction();
- }
-
- public function commitTransaction()
- {
- /* @var Database $db */
- if (!($db = $this->framework->createInstance(Database::class))) {
- return null;
- }
-
- $db->commitTransaction();
- }
-
- /**
- * Adapted from \Contao\Model\QueryBuilder::find().
- *
- * @return string
- */
- private function createQueryWithoutRelations(array $options)
- {
- $fields = $options['selectFields'] ?? [];
-
- $query = 'SELECT '.(empty($fields) ? '*' : implode(', ', $fields)).' FROM '.$options['table'];
-
- // Where condition
- if (isset($options['column'])) {
- $query .= ' WHERE '.(\is_array($options['column']) ? implode(' AND ', $options['column']) : $options['table'].'.'.Database::quoteIdentifier($options['column']).'=?');
- }
-
- // Group by
- if (isset($options['group'])) {
- @trigger_error('Using the "group" option has been deprecated and will no longer work in Contao 5.0. See https://github.com/contao/contao/issues/1680', \E_USER_DEPRECATED);
- $query .= ' GROUP BY '.$options['group'];
- }
-
- // Having (see #6446)
- if (isset($options['having'])) {
- $query .= ' HAVING '.$options['having'];
- }
-
- // Order by
- if (isset($options['order'])) {
- $query .= ' ORDER BY '.$options['order'];
- }
-
- return $query;
- }
-}
diff --git a/src/Date/DateUtil.php b/src/Date/DateUtil.php
deleted file mode 100644
index 99d15dee..00000000
--- a/src/Date/DateUtil.php
+++ /dev/null
@@ -1,482 +0,0 @@
-framework = $container->get('contao.framework');
- $this->container = $container;
- }
-
- /**
- * Get the timestamp based on input date, no matter input is timestamp or string date.
- *
- * @param string|int|\DateTime|null $date The input date/timestamp/insertTag
- * @param bool $replaceInsertTags Disable/enable {{date::}} insertTag support
- * @param string|null $timezone A valid timezone from DateTimeZone::ALL, if provided the timezone offset will be added to the timestamp
- *
- * @throws \Exception Throws error in case of an error when creating new DateTime instances
- *
- * @return int The integer timestamp presentation of the input date with added timezone offset
- */
- public function getTimeStamp($date = null, $replaceInsertTags = true, $timezone = null)
- {
- if (null === $date) {
- return 0;
- }
-
- if ($date instanceof \DateTime) {
- $timezone ? $date->setTimezone(new \DateTimeZone($timezone)) : null;
-
- return $date->getTimestamp();
- }
-
- if (true === $replaceInsertTags) {
- $date = Controller::replaceInsertTags($date, false);
- }
-
- if (is_numeric($date)) {
- $dateTime = new \DateTime(null, $timezone ? new \DateTimeZone($timezone) : null);
- $dateTime->setTimestamp($date);
-
- return $dateTime->getTimestamp();
- }
-
- if (false !== ($dateTime = strtotime($date))) {
- $dateTime = new \DateTime($date, $timezone ? new \DateTimeZone($timezone) : null);
-
- return $dateTime->getTimestamp();
- }
-
- return 0;
- }
-
- /**
- * Returns the time in seconds of an given time period.
- *
- * @param string|array $timePeriod Array or serialized string containing an value and an unit key
- *
- * @return float|int|null
- */
- public function getTimePeriodInSeconds($timePeriod)
- {
- $timePeriod = StringUtil::deserialize($timePeriod, true);
-
- if (!isset($timePeriod['unit']) || !isset($timePeriod['value'])) {
- return null;
- }
-
- $factor = 1;
-
- switch ($timePeriod['unit']) {
- case 'm':
- $factor = 60;
-
- break;
-
- case 'h':
- $factor = 60 * 60;
-
- break;
-
- case 'd':
- $factor = 24 * 60 * 60;
-
- break;
- }
-
- return $timePeriod['value'] * $factor;
- }
-
- /**
- * Format a php date formate pattern to an RFC3339 compliant format.
- *
- * @param string $format The php date format (see: http://php.net/manual/de/function.date.php#refsect1-function.date-parameters)
- *
- * @return string The RFC3339 compliant format (see: http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax or http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table)
- */
- public function transformPhpDateFormatToRFC3339(string $format): string
- {
- $mapping = [
- 'd' => 'dd', //Day of the month, 2 digits with leading zeros (01 to 31)
- 'D' => 'E', // A textual representation of a day, three letters (Mon through Sun)
- 'j' => 'd', // Day of the month without leading zeros (1 to 31)
- 'l' => 'EEEE', // A full textual representation of the day of the week (Sunday through Saturday)
- 'N' => 'd', // ISO-8601 numeric representation of the day of the week (added in PHP 5.1.0) (1 (for Monday) through 7 (for Sunday))
- 'S' => '', // Not supported yet: English ordinal suffix for the day of the month, 2 characters (st, nd, rd or th. Works well with j)
- 'w' => 'e', // Numeric representation of the day of the week (0 (for Sunday) through 6 (for Saturday))
- 'z' => 'D', // The day of the year (starting from 0) (0 through 365)
- 'W' => 'w', // ISO-8601 week number of year, weeks starting on Monday (Example: 42 (the 42nd week in the year))
- 'F' => 'MMMM', // A full textual representation of a month, such as January or March (January through December)
- 'm' => 'MM', // Numeric representation of a month, with leading zeros (01 through 12)
- 'M' => 'MMM', // A short textual representation of a month, three letters (Jan through Dec)
- 'n' => 'M', // Numeric representation of a month, without leading zeros (1 through 12)
- 't' => '', // Not supported yet: Number of days in the given month (28 through 31)
- 'L' => '', // Not supported yet: Whether it's a leap year (1 if it is a leap year, 0 otherwise.)
- 'o' => 'Y', // ISO-8601 week-numbering year. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0) (Examples: 1999 or 2003)
- 'Y' => 'yyyy', // A full numeric representation of a year, 4 digits (Examples: 1999 or 2003)
- 'y' => 'yy', // A two digit representation of a year (Examples: 99 or 03)
- 'a' => '', // Not supported yet: Lowercase Ante meridiem and Post meridiem (am or pm)
- 'A' => 'a', // Uppercase Ante meridiem and Post meridiem (AM or PM)
- 'B' => '', // Not supported yet: Swatch Internet time (000 through 999)
- 'g' => 'h', // 12-hour format of an hour without leading zeros (1 through 12)
- 'G' => 'H', // 24-hour format of an hour without leading zeros (0 through 23)
- 'h' => 'hh', // 12-hour format of an hour with leading zeros (01 through 12)
- 'H' => 'HH', // 24-hour format of an hour with leading zeros (00 through 23)
- 'i' => 'mm', // Minutes with leading zeros (00 to 59)
- 's' => 'ss', // Seconds, with leading zeros (00 to 59)
- 'u' => '', // Not supported yet: Microseconds (added in PHP 5.2.2). Note that date() will always generate 000000 since it takes an integer parameter, whereas DateTime::format() does support microseconds if DateTime was created with microseconds. (Example: 654321)
- 'v' => '', // Not supported yet: Milliseconds (added in PHP 7.0.0). Same note applies as for u. (Example: 654)
- 'e' => 'VV', // Timezone identifier (added in PHP 5.1.0) (Examples: UTC, GMT, Atlantic/Azores)
- 'I' => '', // Not supported yet: Whether or not the date is in daylight saving time (1 if Daylight Saving Time, 0 otherwise.)
- 'O' => 'xx', // Difference to Greenwich time (GMT) in hours (Example: +0200)
- 'P' => 'xxx', // Difference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3) (Example: +02:00)
- 'T' => '', // Not supported yet: Timezone abbreviation (Examples: EST, MDT)
- 'Z' => '', // Not supported yet: Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. (-43200 through 50400)
- 'c' => "yyyy-MM-dd'T'HH:mm:ssxxx", // ISO 8601 date (added in PHP 5) (2004-02-12T15:19:21+00:00)
- 'r' => '', // Not supported yet: » RFC 2822 formatted date (Example: Thu, 21 Dec 2000 16:01:07 +0200)
- 'U' => '', // Not supported yet: Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)
- ];
-
- $chunks = str_split($format);
-
- foreach ($chunks as $k => $v) {
- if (!isset($mapping[$v])) {
- continue;
- }
-
- $chunks[$k] = $mapping[$v];
- }
-
- return preg_replace('/([a-zA-Z])/', '$1', implode('', $chunks));
- }
-
- /**
- * Format a php date formate pattern to an ISO8601 compliant format.
- *
- * @param string $format The date format (e.g. "d.m.y H:i")
- *
- * @return string The ISO8601 compliant format (see: https://de.wikipedia.org/wiki/ISO_8601)
- */
- public function transformPhpDateFormatToISO8601(string $format): string
- {
- $mapping = [
- 'd' => 'DD', //Day of the month, 2 digits with leading zeros (01 to 31)
- 'D' => 'D', // A textual representation of a day, three letters (Mon through Sun)
- 'j' => 'd', // Day of the month without leading zeros (1 to 31)
- 'l' => 'DD', // A full textual representation of the day of the week (Sunday through Saturday)
- 'N' => '', // ISO-8601 numeric representation of the day of the week (added in PHP 5.1.0) (1 (for Monday) through 7 (for Sunday))
- 'S' => '', // Not supported yet: English ordinal suffix for the day of the month, 2 characters (st, nd, rd or th. Works well with j)
- 'w' => '', // Numeric representation of the day of the week (0 (for Sunday) through 6 (for Saturday))
- 'z' => 'o', // The day of the year (starting from 0) (0 through 365)
- 'W' => '', // ISO-8601 week number of year, weeks starting on Monday (Example: 42 (the 42nd week in the year))
- 'F' => 'MM', // A full textual representation of a month, such as January or March (January through December)
- 'm' => 'MM', // Numeric representation of a month, with leading zeros (01 through 12)
- 'M' => 'M', // A short textual representation of a month, three letters (Jan through Dec)
- 'n' => 'm', // Numeric representation of a month, without leading zeros (1 through 12)
- 't' => '', // Not supported yet: Number of days in the given month (28 through 31)
- 'L' => '', // Not supported yet: Whether it's a leap year (1 if it is a leap year, 0 otherwise.)
- 'o' => '', // ISO-8601 week-numbering year. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0) (Examples: 1999 or 2003)
- 'Y' => 'YYYY', // A full numeric representation of a year, 4 digits (Examples: 1999 or 2003)
- 'y' => 'y', // A two digit representation of a year (Examples: 99 or 03)
- 'a' => '', // Not supported yet: Lowercase Ante meridiem and Post meridiem (am or pm)
- 'A' => '', // Uppercase Ante meridiem and Post meridiem (AM or PM)
- 'B' => '', // Not supported yet: Swatch Internet time (000 through 999)
- 'g' => '', // 12-hour format of an hour without leading zeros (1 through 12)
- 'G' => '', // 24-hour format of an hour without leading zeros (0 through 23)
- 'h' => '', // 12-hour format of an hour with leading zeros (01 through 12)
- 'H' => 'hh', // 24-hour format of an hour with leading zeros (00 through 23)
- 'i' => 'mm', // Minutes with leading zeros (00 to 59)
- 's' => 'ss', // Seconds, with leading zeros (00 to 59)
- 'u' => '', // Not supported yet: Microseconds (added in PHP 5.2.2). Note that date() will always generate 000000 since it takes an integer parameter, whereas DateTime::format() does support microseconds if DateTime was created with microseconds. (Example: 654321)
- 'v' => '', // Not supported yet: Milliseconds (added in PHP 7.0.0). Same note applies as for u. (Example: 654)
- 'e' => '', // Timezone identifier (added in PHP 5.1.0) (Examples: UTC, GMT, Atlantic/Azores)
- 'I' => '', // Not supported yet: Whether or not the date is in daylight saving time (1 if Daylight Saving Time, 0 otherwise.)
- 'O' => '', // Difference to Greenwich time (GMT) in hours (Example: +0200)
- 'P' => 'z', // Difference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3) (Example: +02:00)
- 'T' => '', // Not supported yet: Timezone abbreviation (Examples: EST, MDT)
- 'Z' => '', // Not supported yet: Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. (-43200 through 50400)
- 'c' => "YYYY-MM-DD'T'hh:mm:ssz", // ISO 8601 date (added in PHP 5) (2004-02-12T15:19:21+00:00)
- 'r' => '', // Not supported yet: » RFC 2822 formatted date (Example: Thu, 21 Dec 2000 16:01:07 +0200)
- 'U' => '', // Not supported yet: Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)
- ];
-
- $chunks = str_split($format);
-
- foreach ($chunks as $k => $v) {
- if (!isset($mapping[$v])) {
- continue;
- }
-
- $chunks[$k] = $mapping[$v];
- }
-
- return preg_replace('/([a-zA-Z])/', '$1', implode('', $chunks));
- }
-
- /**
- * transfer a given timestamp to a gmt timestamp at midnight.
- *
- * @return int
- */
- public function getGMTMidnightTstamp(int $tstamp)
- {
- $date = new \DateTime(date('Y-m-d', $tstamp));
- $date->setTimezone(new \DateTimeZone('GMT'));
- $date->setTime(0, 0, 0);
-
- return $date->getTimestamp();
- }
-
- /**
- * Checks if a form of month is available in the date format.
- *
- * @return bool
- */
- public function isMonthInDateFormat(string $dateFormat)
- {
- return false !== strpos($dateFormat, 'F') ||
- false !== strpos($dateFormat, 'M') ||
- false !== strpos($dateFormat, 'm') ||
- false !== strpos($dateFormat, 'n');
- }
-
- /**
- * Checks if a form of day is available in the date format.
- *
- * @return bool
- */
- public function isDayInDateFormat(string $dateFormat)
- {
- return false !== strpos($dateFormat, 'd') ||
- false !== strpos($dateFormat, 'D') ||
- false !== strpos($dateFormat, 'j') ||
- false !== strpos($dateFormat, 'l') ||
- false !== strpos($dateFormat, 'N') ||
- false !== strpos($dateFormat, 'z');
- }
-
- /**
- * Checks if a form of year is available in the date format.
- *
- * @return bool
- */
- public function isYearInDateFormat(string $dateFormat)
- {
- return false !== strpos($dateFormat, 'o') ||
- false !== strpos($dateFormat, 'Y') ||
- false !== strpos($dateFormat, 'y');
- }
-
- public function getMonthTranslationMap()
- {
- $map = [];
-
- $months = [
- 'January',
- 'February',
- 'March',
- 'April',
- 'May',
- 'June',
- 'July',
- 'August',
- 'September',
- 'October',
- 'November',
- 'December',
- ];
-
- System::loadLanguageFile('default');
-
- foreach ($GLOBALS['TL_LANG']['MONTHS'] as $index => $translated) {
- $map[$months[$index]] = $translated;
- }
-
- return $map;
- }
-
- public function getShortMonthTranslationMap()
- {
- $map = [];
-
- $months = [
- 'Jan',
- 'Feb',
- 'Mar',
- 'Apr',
- 'May',
- 'Jun',
- 'Jul',
- 'Aug',
- 'Sep',
- 'Oct',
- 'Nov',
- 'Dec',
- ];
-
- System::loadLanguageFile('default');
-
- foreach ($GLOBALS['TL_LANG']['MONTHS_SHORT'] as $index => $translated) {
- $map[$months[$index]] = $translated;
- }
-
- return $map;
- }
-
- /**
- * Translates available months inside a given string into their English representations taking into account the current language.
- *
- * @return mixed|string
- */
- public function translateMonthsToEnglish(string $date)
- {
- foreach ($this->getMonthTranslationMap() as $english => $translated) {
- if (false !== strpos($date, $translated)) {
- $date = str_replace($translated, $english, $date);
- }
- }
-
- foreach ($this->getShortMonthTranslationMap() as $english => $translated) {
- if (false !== strpos($date, $translated)) {
- $date = str_replace($translated, $english, $date);
- }
- }
-
- return $date;
- }
-
- /**
- * Translates available months inside a given string from English to the current language.
- *
- * @return mixed|string
- */
- public function translateMonths(string $date)
- {
- foreach (array_flip($this->getMonthTranslationMap()) as $translated => $english) {
- if (false !== strpos($date, $english)) {
- $date = str_replace($english, $translated, $date);
- }
- }
-
- foreach (array_flip($this->getShortMonthTranslationMap()) as $translated => $english) {
- if (false !== strpos($date, $english)) {
- $date = str_replace($english, $translated, $date);
- }
- }
-
- return $date;
- }
-
- public function getFormattedDateTime($startDate, $endDate = 0, $addTime = false, $startTime = 0, $endTime = 0, array $options = []): ?string
- {
- $dateFormat = $options['dateFormat'] ?? Date::getNumericDateFormat();
- $datimFormat = $options['datimFormat'] ?? Date::getNumericDatimFormat();
- $timeFormat = $options['timeFormat'] ?? Date::getNumericTimeFormat();
- $separator = $options['separator'] ?? ' – ';
- $translateMonths = $options['translateMonths'] ?? false;
-
- $startDateFormatted = date($dateFormat, $startDate);
- $endDateFormatted = date($dateFormat, $endDate);
-
- if ($addTime) {
- if (!$endDate || $startDateFormatted === $endDateFormatted) {
- $startTimeFormatted = date($timeFormat, $startTime);
- $endTimeFormatted = date($timeFormat, $endTime);
-
- if ($startTimeFormatted === $endTimeFormatted) {
- $result = $startDateFormatted.' '.$startTimeFormatted;
- } else {
- $result = $startDateFormatted.' '.$startTimeFormatted.$separator.$endTimeFormatted;
- }
-
- return $translateMonths ? $this->translateMonths($result) : $result;
- }
- $startDateTimeFormatted = date($datimFormat, $startTime);
- $endDateTimeFormatted = date($datimFormat, $endTime);
-
- if (!$endTime || $startDateTimeFormatted === $endDateTimeFormatted) {
- return $translateMonths ? $this->translateMonths($startDateTimeFormatted) : $startDateTimeFormatted;
- }
-
- return $translateMonths ? $this->translateMonths($startDateTimeFormatted.$separator.$endDateTimeFormatted) : $startDateTimeFormatted.$separator.$endDateTimeFormatted;
- }
-
- if (!$endDate || $startDateFormatted === $endDateFormatted) {
- return $translateMonths ? $this->translateMonths($startDateFormatted) : $startDateFormatted;
- }
-
- return $translateMonths ? $this->translateMonths($startDateFormatted.$separator.$endDateFormatted) : $startDateFormatted.$separator.$endDateFormatted;
- }
-
- public function getFormattedDateTimeByEvent(Model $event): ?string
- {
- return $this->getFormattedDateTime($event->startDate, $event->endDate, $event->addTime, $event->startTime, $event->endTime);
- }
-
- /**
- * @param bool $returnFullDays If true, only full days are returned (0.67 -> 0)
- *
- * @return float|int
- */
- public function getDaysBetween(int $smallerTimestamp, int $largerTimestamp = null, bool $returnFullDays = false)
- {
- $largerTimestamp = null === $largerTimestamp ? time() : $largerTimestamp;
-
- $result = ($largerTimestamp - $smallerTimestamp) / (60 * 60 * 24);
-
- return $returnFullDays ? floor($result) : $result;
- }
-
- public function convertSecondsToHumanReadableFormat($seconds)
- {
- $days = floor($seconds / 86400);
- $seconds -= ($days * 86400);
-
- $hours = floor($seconds / 3600);
- $seconds -= ($hours * 3600);
-
- $minutes = floor($seconds / 60);
- $seconds -= ($minutes * 60);
-
- $values = [
- 'day' => $days,
- 'hour' => $hours,
- 'minute' => $minutes,
- 'second' => $seconds,
- ];
-
- $parts = [];
-
- foreach ($values as $text => $value) {
- if ($value > 0) {
- $parts[] = $value.' '.strtolower($GLOBALS['TL_LANG']['MSC'][$text.($value > 1 ? 's' : '')]);
- }
- }
-
- return implode(', ', $parts);
- }
-}
diff --git a/src/Dca/AuthorField.php b/src/Dca/AuthorField.php
new file mode 100644
index 00000000..4cb3034c
--- /dev/null
+++ b/src/Dca/AuthorField.php
@@ -0,0 +1,32 @@
+
+ */
+ public static function getRegistrations(): array
+ {
+ return static::$tables;
+ }
+}
\ No newline at end of file
diff --git a/src/Dca/AuthorFieldOptions.php b/src/Dca/AuthorFieldOptions.php
new file mode 100644
index 00000000..dfd6c17f
--- /dev/null
+++ b/src/Dca/AuthorFieldOptions.php
@@ -0,0 +1,106 @@
+table = $table;
+ }
+
+
+ public function getTable(): string
+ {
+ return $this->table;
+ }
+
+ public function getType(): string
+ {
+ return $this->type;
+ }
+
+ public function setType(string $type): AuthorFieldOptions
+ {
+ $this->type = $type;
+ return $this;
+ }
+
+ public function hasFieldNamePrefix(): bool
+ {
+ return !empty($this->fieldNamePrefix);
+ }
+
+ public function getFieldNamePrefix(): string
+ {
+ return $this->fieldNamePrefix;
+ }
+
+ public function setFieldNamePrefix(string $fieldNamePrefix): AuthorFieldOptions
+ {
+ $this->fieldNamePrefix = $fieldNamePrefix;
+ return $this;
+ }
+
+ public function isUseDefaultLabel(): bool
+ {
+ return $this->useDefaultLabel;
+ }
+
+ public function setUseDefaultLabel(bool $useDefaultLabel): AuthorFieldOptions
+ {
+ $this->useDefaultLabel = $useDefaultLabel;
+ return $this;
+ }
+
+ public function isExclude(): bool
+ {
+ return $this->exclude;
+ }
+
+ public function setExclude(bool $exclude): AuthorFieldOptions
+ {
+ $this->exclude = $exclude;
+ return $this;
+ }
+
+ public function isSearch(): bool
+ {
+ return $this->search;
+ }
+
+ public function setSearch(bool $search): AuthorFieldOptions
+ {
+ $this->search = $search;
+ return $this;
+ }
+
+ public function isFilter(): bool
+ {
+ return $this->filter;
+ }
+
+ public function setFilter(bool $filter): AuthorFieldOptions
+ {
+ $this->filter = $filter;
+ return $this;
+ }
+}
\ No newline at end of file
diff --git a/src/Dca/DcaUtil.php b/src/Dca/DcaUtil.php
deleted file mode 100644
index fd98eed2..00000000
--- a/src/Dca/DcaUtil.php
+++ /dev/null
@@ -1,1795 +0,0 @@
-container = $container;
- $this->framework = $framework;
- $this->routingUtil = $routingUtil;
- $this->connection = $connection;
- }
-
- /**
- * Get a contao backend modal edit link.
- *
- * @param string $module Name of the module
- * @param int $id Id of the entity
- * @param string|null $label The label text
- *
- * @return string The edit link
- */
- public function getEditLink(string $module, int $id, string $label = null): string
- {
- $url = $this->container->get('huh.utils.url')->getCurrentUrl([
- 'skipParams' => true,
- ]);
-
- if (!$id) {
- return '';
- }
-
- $label = sprintf(StringUtil::specialchars($label ?: $GLOBALS['TL_LANG']['tl_content']['editalias'][1]), $id);
-
- return sprintf(
- ' %s',
- $module,
- $id,
- $this->container->get('security.csrf.token_manager')->getToken($this->container->getParameter('contao.csrf_token_name'))->getValue(),
- $label,
- Image::getHtml('alias.svg', $label, 'style="vertical-align:top"')
- );
- }
-
- /**
- * Get a contao backend modal edit link.
- *
- * @param string $module Name of the module
- * @param int $id Id of the entity
- * @param string|null $label The label text
- * @param string $table The dataContainer table
- * @param int $width The modal window width
- *
- * @return string The modal edit link
- *
- * @deprecated Use DcaUtil::getPopupWizardLink() instead
- */
- public function getModalEditLink(string $module, int $id, string $label = null, string $table = '', int $width = 1024): string
- {
- $url = $this->container->get('huh.utils.url')->getCurrentUrl([
- 'skipParams' => true,
- ]);
-
- if (!$id) {
- return '';
- }
-
- $label = sprintf(StringUtil::specialchars($label ?: $GLOBALS['TL_LANG']['tl_content']['editalias'][1]), $id);
-
- return sprintf(
- ' %s',
- $module,
- $id,
- ($table ? '&table='.$table : ''),
- $this->container->get('security.csrf.token_manager')->getToken($this->container->getParameter('contao.csrf_token_name'))->getValue(),
- $label,
- $width,
- $label,
- Image::getHtml('alias.svg', $label, 'style="vertical-align:top"')
- );
- }
-
- /**
- * Get a contao backend modal archive edit link.
- *
- * @param string $module Name of the module
- * @param int $id Id of the entity
- * @param string $table The dataContainer table
- * @param string|null $label The label text
- * @param int $width The modal window width
- *
- * @return string The modal archive edit link
- *
- * @deprecated Use DcaUtil::getPopupWizardLink() instead
- */
- public function getArchiveModalEditLink(string $module, int $id, string $table, string $label = null, int $width = 1024): string
- {
- $url = $this->container->get('huh.utils.url')->getCurrentUrl([
- 'skipParams' => true,
- ]);
-
- if (!$id) {
- return '';
- }
-
- $label = sprintf(StringUtil::specialchars($label ?: $GLOBALS['TL_LANG']['tl_content']['editalias'][1]), $id);
-
- return sprintf(
- ' %s',
- $module,
- $id,
- $table,
- $this->container->get('security.csrf.token_manager')->getToken($this->container->getParameter('contao.csrf_token_name'))->getValue(),
- $label,
- $width,
- $label,
- Image::getHtml('alias.svg', $label, 'style="vertical-align:top"')
- );
- }
-
- /**
- * Get a contao backend popup link.
- *
- * Options:
- * - attributes: (array) Link attributes as key value pairs. Will override title and style option. href and onclick are not allowed and will be removed from list.
- * - title: (string) Overrride default link title
- * - style: (string) Override default css style properties
- * - onclick: (string) Override default onclick javascript code
- * - icon: (string) Link icon to show as link text. Overrides default icon.
- * - linkText: (string) A linkTitle to show as link text. Will be displayed after the link icon. Default empty.
- * - url-only: (boolean) Return only url instead of a complete link element
- *
- * @param array $parameter An array of parameter. Using string is deprecated and will be removed in a future version.
- *
- * @return string
- */
- public function getPopupWizardLink($parameter, array $options = [])
- {
- if (\is_string($parameter)) {
- @trigger_error('Using string as parameter is deprecated and will be removed in a future version.', \E_USER_DEPRECATED);
- $result = [];
- $query = parse_url($parameter, \PHP_URL_QUERY);
-
- if (\is_string($query)) {
- $parameter = $query;
- }
- parse_str($parameter, $result);
- $parameter = $result;
- }
-
- $route = $options['route'] ?? 'contao_backend';
-
- $parameter['popup'] = 1;
- $parameter['nb'] = 1;
-
- $url = $this->routingUtil->generateBackendRoute($parameter, true, true, $route);
-
- if (isset($options['url-only']) && true === $options['url-only']) {
- return $url;
- }
-
- $attributes = [];
-
- if (isset($options['attributes'])) {
- $attributes = $options['attributes'];
- }
-
- // title
- if (!isset($options['title']) || !$options['title']) {
- $title = $GLOBALS['TL_LANG']['tl_content']['edit'][0];
- } else {
- $title = StringUtil::specialchars($options['title']);
- }
-
- if (!isset($attributes['title'])) {
- $attributes['title'] = $title;
- }
-
- // style
- $style = !isset($options['style']) ? 'padding-left: 5px; padding-top: 2px; display: inline-block;' : $options['style'];
-
- if (!empty($style) && !isset($attributes['style'])) {
- $attributes['style'] = $style;
- }
-
- // onclick
- if (!isset($options['onclick']) || !$options['onclick']) {
- $popupWidth = !isset($options['popupWidth']) || !$options['popupWidth'] ? 991 : $options['popupWidth'];
- $popupTitle = !isset($options['popupTitle']) || !$options['popupTitle'] ? $title : $options['popupTitle'];
-
- $onclick = sprintf(
- 'onclick="Backend.openModalIframe({\'width\':%s,\'title\':\'%s'.'\',\'url\':this.href});return false"',
- $popupWidth,
- $popupTitle
- );
- } else {
- $onclick = $options['onclick'];
- }
-
- if (!isset($attributes['onclick'])) {
- $attributes['onclick'] = $onclick;
- }
-
- // link text and icon
- $linkText = '';
-
- if (!isset($options['icon'])) {
- $linkText .= $this->framework->getAdapter(Image::class)->getHtml('alias.svg', $title, 'style="vertical-align:top"');
- } elseif (!empty($options['icon'])) {
- $linkText = $this->framework->getAdapter(Image::class)->getHtml($options['icon'], $title, 'style="vertical-align:top"');
- }
-
- if (isset($options['linkText']) || !empty($options['linkText'])) {
- $linkText .= $options['linkText'];
- }
-
- // Attributes
- $attributeQuery = '';
-
- foreach ($attributes as $key => $value) {
- if (\in_array($key, ['href', 'onclick'])) {
- continue;
- }
- $attributeQuery .= $key.'="'.htmlspecialchars($value).'" ';
- }
-
- return sprintf(
- '%s',
- $url,
- $attributeQuery,
- $onclick,
- $linkText
- );
- }
-
- /**
- * Set initial $varData from dca.
- *
- * @param string $strTable Dca table name
- * @param mixed $varData Object or array
- *
- * @return mixed Object or array with the default values
- */
- public function setDefaultsFromDca($strTable, $varData = null, bool $includeSql = false)
- {
- $this->framework->getAdapter(Controller::class)->loadDataContainer($strTable);
-
- if (empty($GLOBALS['TL_DCA'][$strTable])) {
- return $varData;
- }
-
- $dbFields = [];
-
- foreach (Database::getInstance()->listFields($strTable) as $data) {
- if (!isset($data['default'])) {
- continue;
- }
-
- $dbFields[$data['name']] = $data['default'];
- }
-
- // Get all default values for the new entry
- foreach ($GLOBALS['TL_DCA'][$strTable]['fields'] as $k => $v) {
- $addDefaultValue = false;
- $defaultValue = null;
-
- // check sql definition
- if ($includeSql && isset($dbFields[$k])) {
- $addDefaultValue = true;
- $defaultValue = $dbFields[$k];
- }
-
- // check dca default value
- if (\array_key_exists('default', $v)) {
- $addDefaultValue = true;
- $defaultValue = \is_array($v['default']) ? serialize($v['default']) : $v['default'];
- }
-
- if (!$addDefaultValue) {
- continue;
- }
-
- // Encrypt the default value (see #3740)
- if ($GLOBALS['TL_DCA'][$strTable]['fields'][$k]['eval']['encrypt'] ?? false) {
- $defaultValue = $this->container->get('huh.utils.encryption')->encrypt($defaultValue);
- }
-
- if ($addDefaultValue) {
- if (\is_object($varData)) {
- $varData->{$k} = $defaultValue;
- } else {
- if (null === $varData) {
- $varData = [];
- }
-
- if (\is_array($varData)) {
- $varData[$k] = $defaultValue;
- }
- }
- }
- }
-
- return $varData;
- }
-
- /**
- * Retrieves an array from a dca config (in most cases eval) in the following priorities:.
- *
- * 1. The value associated to $array[$property]
- * 2. The value retrieved by $array[$property . '_callback'] which is a callback array like ['Class', 'method'] or ['service.id', 'method']
- * 3. The value retrieved by $array[$property . '_callback'] which is a function closure array like ['Class', 'method']
- *
- * @param $property
- *
- * @return mixed|null The value retrieved in the way mentioned above or null
- */
- public function getConfigByArrayOrCallbackOrFunction(array $array, $property, array $arguments = [])
- {
- if (isset($array[$property])) {
- return $array[$property];
- }
-
- if (!isset($array[$property.'_callback'])) {
- return null;
- }
-
- if (\is_array($array[$property.'_callback'])) {
- $callback = $array[$property.'_callback'];
-
- if (!isset($callback[0]) || !isset($callback[1])) {
- return null;
- }
-
- try {
- $instance = Controller::importStatic($callback[0]);
- } catch (\Exception $e) {
- return null;
- }
-
- if (!method_exists($instance, $callback[1])) {
- return null;
- }
-
- try {
- return \call_user_func_array([$instance, $callback[1]], $arguments);
- } catch (\Error $e) {
- return null;
- }
- } elseif (\is_callable($array[$property.'_callback'])) {
- try {
- return \call_user_func_array($array[$property.'_callback'], $arguments);
- } catch (\Error $e) {
- return null;
- }
- }
-
- return null;
- }
-
- /**
- * Sets the current date as the date added -> usually used on submit.
- */
- public function setDateAdded(DataContainer $dc)
- {
- $modelUtil = $this->container->get('huh.utils.model');
-
- if (null === $dc || null === ($model = $modelUtil->findModelInstanceByPk($dc->table, $dc->id)) || $model->dateAdded > 0) {
- return null;
- }
-
- $this->framework->createInstance(Database::class)->prepare("UPDATE $dc->table SET dateAdded=? WHERE id=? AND dateAdded = 0")->execute(time(), $dc->id);
- }
-
- /**
- * Sets the current date as the date added -> usually used on copy.
- *
- * @param $insertId
- */
- public function setDateAddedOnCopy($insertId, DataContainer $dc)
- {
- $modelUtil = $this->container->get('huh.utils.model');
-
- if (null === $dc || null === ($model = $modelUtil->findModelInstanceByPk($dc->table, $insertId)) || $model->dateAdded > 0) {
- return null;
- }
-
- $this->framework->createInstance(Database::class)->prepare("UPDATE $dc->table SET dateAdded=? WHERE id=? AND dateAdded = 0")->execute(time(), $insertId);
- }
-
- /**
- * Returns a list of fields as an option array for dca fields.
- *
- * Possible options:
- * - array inputTypes Restrict to certain input types
- * - array evalConditions restrict to certain dca eval
- * - bool localizeLabels
- * - bool skipSorting
- *
- * @deprecated Use Utils service instead
- * @codeCoverageIgnore
- */
- public function getFields(string $table, array $options = []): array
- {
- $fields = [];
-
- if (!$table) {
- return $fields;
- }
-
- $this->framework->getAdapter(Controller::class)->loadDataContainer($table);
- System::loadLanguageFile($table);
-
- if (!isset($GLOBALS['TL_DCA'][$table]['fields'])) {
- return $fields;
- }
-
- foreach ($GLOBALS['TL_DCA'][$table]['fields'] as $name => $data) {
- // restrict to certain input types
- if (isset($options['inputTypes']) && \is_array($options['inputTypes']) && !empty($options['inputTypes']) && (isset($data['inputType']) && !\in_array($data['inputType'], $options['inputTypes']))) {
- continue;
- }
-
- // restrict to certain dca eval
- if (isset($options['evalConditions']) && \is_array($options['evalConditions']) && !empty($options['evalConditions'])) {
- foreach ($options['evalConditions'] as $key => $value) {
- if (!isset($data['eval'][$key]) || $data['eval'][$key] !== $value) {
- continue 2;
- }
- }
- }
-
- if (isset($options['localizeLabels']) && !$options['localizeLabels']) {
- $fields[$name] = $name;
- } else {
- $label = $name;
-
- if (isset($data['label'][0]) && $data['label'][0]) {
- $label .= ' ['.$data['label'][0].']';
- }
-
- $fields[$name] = $label;
- }
- }
-
- if (!isset($options['skipSorting']) || !$options['skipSorting']) {
- asort($fields);
- }
-
- return $fields;
- }
-
- /**
- * Adds an override selector to every field in $fields to the dca associated with $destinationTable.
- */
- public function addOverridableFields(array $fields, string $sourceTable, string $destinationTable, array $options = [])
- {
- $this->framework->getAdapter(Controller::class)->loadDataContainer($sourceTable);
- System::loadLanguageFile($sourceTable);
- $sourceDca = $GLOBALS['TL_DCA'][$sourceTable];
-
- $this->framework->getAdapter(Controller::class)->loadDataContainer($destinationTable);
- System::loadLanguageFile($destinationTable);
- $destinationDca = &$GLOBALS['TL_DCA'][$destinationTable];
-
- foreach ($fields as $field) {
- // add override boolean field
- $overrideFieldname = 'override'.ucfirst($field);
-
- $destinationDca['fields'][$overrideFieldname] = [
- 'label' => &$GLOBALS['TL_LANG'][$destinationTable][$overrideFieldname],
- 'exclude' => true,
- 'inputType' => 'checkbox',
- 'eval' => ['tl_class' => 'w50', 'submitOnChange' => true, 'isOverrideSelector' => true],
- 'sql' => "char(1) NOT NULL default ''",
- ];
-
- if (isset($options['checkboxDcaEvalOverride']) && \is_array($options['checkboxDcaEvalOverride'])) {
- $destinationDca['fields'][$overrideFieldname]['eval'] = array_merge($destinationDca['fields'][$overrideFieldname]['eval'], $options['checkboxDcaEvalOverride']);
- }
-
- // important: nested selectors need to be in reversed order -> see DC_Table::getPalette()
- $destinationDca['palettes']['__selector__'] = array_merge([$overrideFieldname], isset($destinationDca['palettes']['__selector__']) && \is_array($destinationDca['palettes']['__selector__']) ? $destinationDca['palettes']['__selector__'] : []);
-
- // copy field
- $destinationDca['fields'][$field] = $sourceDca['fields'][$field];
-
- // subpalette
- $destinationDca['subpalettes'][$overrideFieldname] = $field;
-
- if (!isset($options['skipLocalization']) || !$options['skipLocalization']) {
- $GLOBALS['TL_LANG'][$destinationTable][$overrideFieldname] = [
- $this->container->get('translator')->trans('huh.utils.misc.override.label', [
- '%fieldname%' => $GLOBALS['TL_DCA'][$sourceTable]['fields'][$field]['label'][0] ?? $field,
- ]),
- $this->container->get('translator')->trans('huh.utils.misc.override.desc', [
- '%fieldname%' => $GLOBALS['TL_DCA'][$sourceTable]['fields'][$field]['label'][0] ?? $field,
- ]),
- ];
- }
- }
- }
-
- /**
- * Retrieves a property of given contao model instances by *ascending* priority, i.e. the last instance of $instances
- * will have the highest priority.
- *
- * CAUTION: This function assumes that you have used addOverridableFields() in this class!! That means, that a value in a
- * model instance is only used if it's either the first instance in $arrInstances or "overrideFieldname" is set to true
- * in the instance.
- *
- * @param string $property The property name to retrieve
- * @param array $instances An array of instances in ascending priority. Instances can be passed in the following form:
- * ['tl_some_table', $instanceId] or $objInstance
- *
- * @return mixed
- */
- public function getOverridableProperty(string $property, array $instances)
- {
- $result = null;
- $preparedInstances = [];
-
- // prepare instances
- foreach ($instances as $instance) {
- if (\is_array($instance)) {
- if (null !== ($objInstance = $this->container->get('huh.utils.model')->findModelInstanceByPk($instance[0], $instance[1]))) {
- $preparedInstances[] = $objInstance;
- }
- } elseif ($instance instanceof Model || \is_object($instance)) {
- $preparedInstances[] = $instance;
- }
- }
-
- foreach ($preparedInstances as $i => $preparedInstance) {
- if (0 == $i || $preparedInstance->{'override'.ucfirst($property)}) {
- $result = $preparedInstance->{$property};
- }
- }
-
- return $result;
- }
-
- /**
- * This function transforms an entity's palette (that can also contain sub palettes and concatenated type selectors) to a flatten
- * palette where every field can be overridden.
- *
- * CAUTION: This function assumes that you have used addOverridableFields() for adding the fields that are overridable. The latter ones
- * are $overridableFields
- *
- * This function is useful if you want to adjust a palette for sub entities that can override properties of their ancestor(s).
- * Use $this->getOverridableProperty() for computing the correct value respecting the entity hierarchy.
- */
- public function flattenPaletteForSubEntities(string $table, array $overridableFields)
- {
- $this->framework->getAdapter(Controller::class)->loadDataContainer($table);
-
- $pm = PaletteManipulator::create();
-
- $dca = &$GLOBALS['TL_DCA'][$table];
- $arrayUtil = $this->container->get('huh.utils.array');
-
- // Contao 4.4 fix
- $replaceFields = [];
-
- // palette
- foreach ($overridableFields as $field) {
- if (true === ($dca['fields'][$field]['eval']['submitOnChange'] ?? false)) {
- unset($dca['fields'][$field]['eval']['submitOnChange']);
-
- if (\in_array($field, $dca['palettes']['__selector__'])) {
- // flatten concatenated type selectors
- foreach ($dca['subpalettes'] as $selector => $subPaletteFields) {
- if (false !== strpos($selector, $field.'_')) {
- if ($dca['subpalettes'][$selector]) {
- $subPaletteFields = explode(',', $dca['subpalettes'][$selector]);
-
- foreach (array_reverse($subPaletteFields) as $subPaletteField) {
- $pm->addField($subPaletteField, $field);
- }
- }
-
- // remove nested field in order to avoid its normal "selector" behavior
- $arrayUtil->removeValue($field, $dca['palettes']['__selector__']);
- unset($dca['subpalettes'][$selector]);
- }
- }
-
- // flatten sub palettes
- if (isset($dca['subpalettes'][$field]) && $dca['subpalettes'][$field]) {
- $subPaletteFields = explode(',', $dca['subpalettes'][$field]);
-
- foreach (array_reverse($subPaletteFields) as $subPaletteField) {
- $pm->addField($subPaletteField, $field);
- }
-
- // remove nested field in order to avoid its normal "selector" behavior
- $arrayUtil->removeValue($field, $dca['palettes']['__selector__']);
- unset($dca['subpalettes'][$field]);
- }
- }
- }
-
- $replaceFields[] = $field;
-
-// $pm->addField('override'.ucfirst($field), $field)->removeField($field);
- }
-
- $pm->applyToPalette('default', $table);
-
- foreach ($replaceFields as $replaceField) {
- $dca['palettes']['default'] = str_replace($replaceField, 'override'.ucfirst($replaceField), $dca['palettes']['default']);
- }
- }
-
- /**
- * Return if the current alias already exist in table.
- *
- * @throws \Doctrine\DBAL\DBALException
- */
- public function aliasExist(string $alias, int $id, string $table, $options = []): bool
- {
- $aliasField = $options['aliasField'] ?? 'alias';
-
- $stmt = $this->connection->prepare('SELECT id FROM '.$table.' WHERE '.$aliasField.'=? AND id!=?');
-
- return $stmt->executeQuery([$alias, $id])->rowCount() > 0;
- }
-
- /**
- * Generate an alias with unique check.
- *
- * @param mixed $alias The current alias (if available)
- * @param int $id The entity's id
- * @param string|null $table The entity's table (pass a comma separated list if the validation should be expanded to multiple tables like tl_news AND tl_member. ATTENTION: the first table needs to be the one we're currently in). Pass null to skip unqiue check.
- * @param string $title The value to use as a base for the alias
- * @param bool $keepUmlauts Set to true if German umlauts should be kept
- *
- * @throws \Exception
- *
- * @return string
- */
- public function generateAlias(?string $alias, int $id, ?string $table, string $title, bool $keepUmlauts = true, $options = [])
- {
- $autoAlias = false;
- $aliasField = $options['aliasField'] ?? 'alias';
-
- // Generate alias if there is none
- if (empty($alias)) {
- $autoAlias = true;
- $alias = StringUtil::generateAlias($title);
- }
-
- if (!$keepUmlauts) {
- $alias = preg_replace(['/ä/i', '/ö/i', '/ü/i', '/ß/i'], ['ae', 'oe', 'ue', 'ss'], $alias);
- }
-
- if (null === $table) {
- return $alias;
- }
-
- $originalAlias = $alias;
-
- // multiple tables?
- if (false !== strpos($table, ',')) {
- $tables = explode(',', $table);
-
- foreach ($tables as $i => $partTable) {
- // the table in which the entity is
- if (0 === $i) {
- if ($this->aliasExist($alias, $id, $table, $options)) {
- if (!$autoAlias) {
- throw new \InvalidArgumentException(sprintf($GLOBALS['TL_LANG']['ERR']['aliasExists'], $alias));
- }
-
- $alias = $originalAlias.'-'.$id;
- }
- } else {
- // another table
- $stmt = $this->connection->prepare("SELECT id FROM {$partTable} WHERE ' . $aliasField . '=?");
-
- // Check whether the alias exists
- if ($stmt->execute([$alias])->rowCount() > 0) {
- throw new \InvalidArgumentException(sprintf($GLOBALS['TL_LANG']['ERR']['aliasExists'], $alias));
- }
- }
- }
- } else {
- if (!$this->aliasExist($alias, $id, $table, $options)) {
- return $alias;
- }
-
- // Check whether the alias exists
- if (!$autoAlias) {
- throw new \Exception(sprintf($GLOBALS['TL_LANG']['ERR']['aliasExists'], $alias));
- }
-
- // Add ID to alias
- $alias .= '-'.$id;
- }
-
- return $alias;
- }
-
- public function addAuthorFieldAndCallback(string $table, string $fieldPrefix = '')
- {
- $this->framework->getAdapter(Controller::class)->loadDataContainer($table);
-
- // callbacks
- $GLOBALS['TL_DCA'][$table]['config']['oncreate_callback']['setAuthorIDOnCreate'] = [self::class, 'setAuthorIDOnCreate'];
- $GLOBALS['TL_DCA'][$table]['config']['onload_callback']['modifyAuthorPaletteOnLoad'] = [self::class, 'modifyAuthorPaletteOnLoad', true];
-
- // fields
- $GLOBALS['TL_DCA'][$table]['fields'][$fieldPrefix ? $fieldPrefix.ucfirst(static::PROPERTY_AUTHOR_TYPE) : static::PROPERTY_AUTHOR_TYPE] = [
- 'label' => &$GLOBALS['TL_LANG']['MSC']['utilsBundle']['authorType'],
- 'exclude' => true,
- 'filter' => true,
- 'default' => static::AUTHOR_TYPE_NONE,
- 'inputType' => 'select',
- 'options' => [
- static::AUTHOR_TYPE_NONE,
- static::AUTHOR_TYPE_MEMBER,
- static::AUTHOR_TYPE_USER,
- // session is only added if it's already set in the dca
- ],
- 'reference' => $GLOBALS['TL_LANG']['MSC']['utilsBundle']['authorType'],
- 'eval' => ['doNotCopy' => true, 'submitOnChange' => true, 'mandatory' => true, 'tl_class' => 'w50 clr'],
- 'sql' => "varchar(255) NOT NULL default 'none'",
- ];
-
- $GLOBALS['TL_DCA'][$table]['fields'][$fieldPrefix ? $fieldPrefix.ucfirst(static::PROPERTY_AUTHOR) : static::PROPERTY_AUTHOR] = [
- 'label' => &$GLOBALS['TL_LANG']['MSC']['utilsBundle']['author'],
- 'exclude' => true,
- 'search' => true,
- 'filter' => true,
- 'inputType' => 'select',
- 'default' => '0',
- 'options_callback' => function () {
- return $this->container->get('huh.utils.choice.model_instance')->getCachedChoices([
- 'dataContainer' => 'tl_member',
- 'labelPattern' => '%firstname% %lastname% (ID %id%)',
- ]);
- },
- 'save_callback' => [function ($value, $dc) {
- if (!$value) {
- return 0;
- }
-
- return $value;
- }],
- 'eval' => [
- 'doNotCopy' => true,
- 'chosen' => true,
- 'includeBlankOption' => true,
- 'tl_class' => 'w50',
- ],
- 'sql' => "varchar(64) NOT NULL default '0'",
- ];
- }
-
- public function setAuthorIDOnCreate(string $table, int $id, array $row, DataContainer $dc)
- {
- /** @var Model $model */
- $model = $this->container->get(ModelUtil::class)->findModelInstanceByPk($table, $id);
- /** @var Database $db */
- $db = $this->framework->createInstance(Database::class);
-
- if (null === $model
- || !$db->fieldExists(static::PROPERTY_AUTHOR_TYPE, $table)
- || !$db->fieldExists(static::PROPERTY_AUTHOR, $table)) {
- return false;
- }
-
- $stmt = $db->prepare(
- 'UPDATE '.$model::getTable()
- .' SET '.static::PROPERTY_AUTHOR_TYPE.'=?, '.static::PROPERTY_AUTHOR.'=?'
- .' WHERE id=?'
- );
-
- if ($this->container->get('huh.utils.container')->isFrontend()) {
- if (FE_USER_LOGGED_IN) {
- $stmt->execute(static::AUTHOR_TYPE_MEMBER, $this->framework->getAdapter(FrontendUser::class)->getInstance()->id, $model->id);
- } else {
- // php session
- $stmt->execute(static::AUTHOR_TYPE_SESSION, session_id(), $model->id);
- }
- } else {
- $stmt->execute(static::AUTHOR_TYPE_USER, $this->framework->getAdapter(BackendUser::class)->getInstance()->id, $model->id);
- }
- }
-
- public function modifyAuthorPaletteOnLoad(DataContainer $dc)
- {
- if (!$this->container->get('huh.utils.container')->isBackend()) {
- return false;
- }
-
- if (null === $dc || !$dc->id || !$dc->table) {
- return false;
- }
-
- if (null === ($model = $this->container->get('huh.utils.model')->findModelInstanceByPk($dc->table, $dc->id))) {
- return false;
- }
-
- $dca = &$GLOBALS['TL_DCA'][$dc->table];
-
- // author handling
- if ($model->{static::PROPERTY_AUTHOR_TYPE} == static::AUTHOR_TYPE_NONE) {
- unset($dca['fields'][static::PROPERTY_AUTHOR]);
- }
-
- if ($model->{static::PROPERTY_AUTHOR_TYPE} == static::AUTHOR_TYPE_USER) {
- $dca['fields'][static::PROPERTY_AUTHOR]['options_callback'] = function () {
- return $this->container->get(ModelInstanceChoice::class)->getCachedChoices([
- 'dataContainer' => 'tl_user',
- 'labelPattern' => '%name% (ID %id%)',
- ]);
- };
- }
-
- if ($model->{static::PROPERTY_AUTHOR_TYPE} == static::AUTHOR_TYPE_SESSION) {
- $dca['fields'][static::PROPERTY_AUTHOR_TYPE]['options'] = array_merge($dca['fields'][static::PROPERTY_AUTHOR_TYPE]['options'], [static::AUTHOR_TYPE_SESSION]);
- // do not allow to edit in backend
- $dca['fields'][static::PROPERTY_AUTHOR_TYPE]['eval']['readonly'] = true;
-
- unset($dca['fields'][static::PROPERTY_AUTHOR]['options_callback']);
- $dca['fields'][static::PROPERTY_AUTHOR]['inputType'] = 'text';
- // do not allow to edit in backend
- $dca['fields'][static::PROPERTY_AUTHOR]['eval']['readonly'] = true;
- $dca['fields'][static::PROPERTY_AUTHOR]['label'][0] = $GLOBALS['TL_LANG']['MSC']['utilsBundle'][static::PROPERTY_AUTHOR_TYPE][self::AUTHOR_TYPE_SESSION];
- }
- }
-
- /**
- * Returns (nearly) all registered datacontainers as array.
- *
- * Options:
- * - bool onlyTableType: Return only table data containers
- *
- * @return array
- */
- public function getDataContainers(array $options = [])
- {
- $dcaTables = $this->framework->createInstance(Database::class)->listTables();
-
- if (isset($options['onlyTableType']) && true === $options['onlyTableType']) {
- return $dcaTables;
- }
-
- foreach ($GLOBALS['BE_MOD'] as $arrSection) {
- foreach ($arrSection as $strModule => $arrModule) {
- foreach ($arrModule as $strKey => $varValue) {
- if (\is_array($arrModule['tables'] ?? null)) {
- $dcaTables = array_merge($dcaTables, $arrModule['tables']);
- }
- }
- }
- }
- $dcaTables = array_unique($dcaTables);
- asort($dcaTables);
-
- return array_values($dcaTables);
- }
-
- /**
- * @param bool $includeNotificationCenterPlusTokens
- *
- * @return array
- */
- public function getNewNotificationTypeArray($includeNotificationCenterPlusTokens = false)
- {
- $type = [
- 'recipients' => ['admin_email'],
- 'email_subject' => ['admin_email'],
- 'email_text' => ['admin_email'],
- 'email_html' => ['admin_email'],
- 'file_name' => ['admin_email'],
- 'file_content' => ['admin_email'],
- 'email_sender_name' => ['admin_email'],
- 'email_sender_address' => ['admin_email'],
- 'email_recipient_cc' => ['admin_email'],
- 'email_recipient_bcc' => ['admin_email'],
- 'email_replyTo' => ['admin_email'],
- 'attachment_tokens' => [],
- ];
-
- if ($includeNotificationCenterPlusTokens) {
- foreach ($type as $field => $tokens) {
- $type[$field] = array_unique(array_merge([
- 'env_*',
- 'page_*',
- 'user_*',
- 'date',
- 'last_update',
- ], $tokens));
- }
- }
-
- return $type;
- }
-
- public function activateNotificationType($strGroup, $strType, $arrType)
- {
- $GLOBALS['NOTIFICATION_CENTER']['NOTIFICATION_TYPE'] = array_merge_recursive(
- (array) $GLOBALS['NOTIFICATION_CENTER']['NOTIFICATION_TYPE'],
- [
- $strGroup => [
- $strType => $arrType,
- ],
- ]
- );
- }
-
- /**
- * Adds an alias field to the dca and to the desired palettes.
- *
- * @param $dca
- * @param $generateAliasCallback mixed The callback to call for generating the alias
- * @param $paletteField String The field after which to insert the alias field in the palettes
- * @param array $palettes The palettes in which to insert the field
- */
- public function addAliasToDca(string $dca, $generateAliasCallback, string $paletteField, array $palettes = ['default'])
- {
- Controller::loadDataContainer($dca);
-
- $arrDca = &$GLOBALS['TL_DCA'][$dca];
-
- // add to palettes
- foreach ($palettes as $strPalette) {
- $arrDca['palettes'][$strPalette] = preg_replace('/('.$paletteField.')(;|,)/', '$1,alias$2', $arrDca['palettes'][$strPalette]);
- }
-
- // add field
- $arrDca['fields']['alias'] = [
- 'label' => &$GLOBALS['TL_LANG']['MSC']['alias'],
- 'exclude' => true,
- 'search' => true,
- 'inputType' => 'text',
- 'eval' => ['rgxp' => 'alias', 'unique' => true, 'maxlength' => 128, 'tl_class' => 'w50'],
- 'save_callback' => [$generateAliasCallback],
- 'sql' => "varchar(128) COLLATE utf8_bin NOT NULL default ''",
- ];
- }
-
- /**
- * @param $strField
- * @param $strTable
- *
- * @return mixed
- */
- public function getLocalizedFieldName($strField, $strTable)
- {
- Controller::loadDataContainer($strTable);
- System::loadLanguageFile($strTable);
-
- return $GLOBALS['TL_DCA'][$strTable]['fields'][$strField]['label'][0] ?: $strField;
- }
-
- /**
- * Load a data container in a testable way.
- */
- public function loadDc(string $table)
- {
- if (!isset($GLOBALS['TL_DCA'][$table]) || null === $GLOBALS['TL_DCA'][$table]) {
- /** @var Controller $controller */
- $controller = $this->framework->getAdapter(Controller::class);
-
- $controller->loadDataContainer($table);
- }
- }
-
- /**
- * Load a language file in a testable way.
- */
- public function loadLanguageFile(string $table)
- {
- /** @var System $system */
- $system = $this->framework->getAdapter(System::class);
-
- $system->loadLanguageFile($table);
- }
-
- public function isDcMultilingual(string $table)
- {
- $this->loadDc($table);
-
- $bundleName = 'Terminal42\DcMultilingualBundle\Terminal42DcMultilingualBundle';
-
- return isset($GLOBALS['TL_DCA'][$table]['config']['dataContainer']) &&
- 'Multilingual' === $GLOBALS['TL_DCA'][$table]['config']['dataContainer'] &&
- $this->container->get('huh.utils.container')->isBundleActive($bundleName);
- }
-
- public function isDcMultilingual3()
- {
- return class_exists('Terminal42\DcMultilingualBundle\Model\Multilingual') &&
- !method_exists('Terminal42\DcMultilingualBundle\Model\Multilingual', 'createModelFromDbResult');
- }
-
- public function generateDcOperationsButtons($row, $table, $rootIds = [], $options = [])
- {
- $return = '';
-
- // Edit multiple
- if ('select' == Input::get('act')) {
- $return .= '';
- } // Regular buttons
- else {
- $return .= $this->doGenerateDcOperationsButtons($row, $table, $rootIds, false, null, $options);
-
- // no picker support due to DataContainer not being extensible
- }
-
- return $return;
- }
-
- public function doGenerateDcOperationsButtons($arrRow, $strTable, $arrRootIds = [], $blnCircularReference = false, $arrChildRecordIds = null, $options = [])
- {
- if (empty($GLOBALS['TL_DCA'][$strTable]['list']['operations'])) {
- return '';
- }
-
- $return = '';
-
- $skipOperations = $options['skipOperations'] ?? [];
- $operations = $options['operations'] ?? array_keys($GLOBALS['TL_DCA'][$strTable]['list']['operations']);
-
- if (!empty($skipOperations) && !isset($options['operations'])) {
- $operations = array_diff($operations, $skipOperations);
- }
-
- foreach ($GLOBALS['TL_DCA'][$strTable]['list']['operations'] as $k => $v) {
- if (!\in_array($k, $operations)) {
- continue;
- }
-
- $v = \is_array($v) ? $v : [$v];
- $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
-
- $label = isset($v['label']) ? (\is_array($v['label']) ? $v['label'][0] : $v['label']) : $k;
- $title = sprintf(isset($v['label']) ? (\is_array($v['label']) ? $v['label'][1] : $v['label']) : $k, $id);
- $attributes = ('' != $v['attributes']) ? ' '.ltrim(sprintf($v['attributes'], $id, $id)) : '';
-
- parse_str(StringUtil::decodeEntities($v['href'] ?? ''), $params);
-
- if (version_compare(VERSION, '4.13', '>=') && \in_array($k, ['toggle', 'feature'])) {
- $state = $arrRow[$params['field']] ? 1 : 0;
-
- if ($v['reverse'] ?? false) {
- $state = $arrRow[$params['field']] ? 0 : 1;
- }
-
- $icon = $v['icon'];
- $_icon = pathinfo($v['icon'], \PATHINFO_FILENAME).'_.'.pathinfo($v['icon'], \PATHINFO_EXTENSION);
-
- if (false !== strpos($v['icon'], '/')) {
- $_icon = \dirname($v['icon']).'/'.$_icon;
- }
-
- if ('visible.svg' == $icon) {
- $_icon = 'invisible.svg';
- }
-
- if (false === strpos($attributes, 'onclick')) {
- $attributes = sprintf(
- 'onclick="Backend.getScrollOffset();return AjaxRequest.toggleField(this,'.($state ? 'true' : 'false').')"',
- $id, $id
- );
- }
- }
-
- // Add the key as CSS class
- if (false !== strpos($attributes, 'class="')) {
- $attributes = str_replace('class="', 'class="'.$k.' ', $attributes);
- } else {
- $attributes = ' class="'.$k.'"'.$attributes;
- }
-
- // Call a custom function instead of using the default button
- if (\is_array($v['button_callback'])) {
- $callback = System::importStatic($v['button_callback'][0]);
- $return .= $callback->{$v['button_callback'][1]}($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, null, null, $this);
-
- continue;
- } elseif (\is_callable($v['button_callback'])) {
- $return .= $v['button_callback']($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, null, null, $this);
-
- continue;
- }
-
- // Generate all buttons except "move up" and "move down" buttons
- if ('move' != $k && 'move' != $v) {
- if ('show' == $k) {
- $return .= ''.Image::getHtml($v['icon'], $label).' ';
- } else {
- $href = Controller::addToUrl($v['href'].'&id='.$arrRow['id'].(Input::get('nb') ? '&nc=1' : '')).'&rt='.RequestToken::get();
-
- if (version_compare(VERSION, '4.13', '>=') && \in_array($k, ['toggle', 'feature'])) {
- $icon = Image::getHtml($state ? $icon : $_icon, $label, 'data-icon="'.Image::getPath($icon).'" data-icon-disabled="'.Image::getPath($_icon).'" data-state="'.$state.'"');
- } else {
- $icon = Image::getHtml($v['icon'], $label);
- }
-
- $return .= ''.$icon.' ';
- }
-
- continue;
- }
- }
-
- return trim($return);
- }
-
- public function generateSitemap()
- {
- $automator = System::importStatic('Automator');
- $automator->generateSitemap();
- }
-
- /**
- * Mostly used for Form::prepareSpecialValueForOutput().
- *
- * @param $activeRecord
- */
- public function getDCTable(string $table, $activeRecord): DC_Table_Utils
- {
- $dc = new DC_Table_Utils($table);
- $dc->activeRecord = $activeRecord;
- $dc->id = $activeRecord->id;
-
- return $dc;
- }
-
- public function getAuthorNameByUserId($id)
- {
- if (null !== ($user = $this->container->get('huh.utils.model')->findModelInstanceByPk('tl_user', $id))) {
- return $user->name;
- }
-
- return false;
- }
-
- public function getAuthorNameLinkByUserId($id)
- {
- if (null !== ($user = $this->container->get('huh.utils.model')->findModelInstanceByPk('tl_user', $id))) {
- return ''.Controller::replaceInsertTags('{{email_open::'.$user->email.'}}').$user->name.'';
- }
-
- return false;
- }
-
- public function setFieldsToReadOnly(&$dca, array $config = [])
- {
- $skipFields = $config['skipFields'] ?? [];
- $fields = $config['fields'] ?? [];
-
- foreach ($dca['fields'] as $field => &$data) {
- if (!empty($fields)) {
- if (!\in_array($field, $fields)) {
- continue;
- }
- } elseif (\in_array($field, $skipFields)) {
- continue;
- }
-
- switch ($data['inputType']) {
- case 'checkbox':
- case 'radio':
- case 'radioTable':
- $data['eval']['disabled'] = true;
-
- break;
-
- case 'select':
- case 'imageSize':
- $data['eval']['readonly'] = true;
- $data['eval']['class'] = 'readonly';
-
- break;
-
- case 'fileTree':
- case 'metaWizard':
- case 'tagsinput':
- $data['eval']['readonly'] = true;
- $data['eval']['tl_class'] = $data['eval']['tl_class'].' readonly';
-
- break;
-
- case 'multiColumnEditor':
- $data['eval']['readonly'] = true;
-
- $this->setFieldsToReadOnly($data['eval']['multiColumnEditor'], $config);
-
- break;
-
- default:
- $data['eval']['readonly'] = true;
-
- // TODO dispatch event for custom
- break;
- }
- }
- }
-
- public function getTranslatedModuleNameByTable(string $table)
- {
- foreach ($GLOBALS['BE_MOD'] as $groupName => $groupModules) {
- if (empty($groupModules)) {
- continue;
- }
-
- foreach ($groupModules as $moduleName => $moduleConfig) {
- if (!isset($moduleConfig['tables']) || !\is_array($moduleConfig['tables'])) {
- continue;
- }
-
- if (\in_array($table, $moduleConfig['tables'])) {
- return StringUtil::specialchars($GLOBALS['TL_LANG']['MOD'][$moduleName][0]);
- }
- }
- }
-
- return false;
- }
-
- public function getRenderedDiff(string $table, array $source, array $target, array $config = [])
- {
- $result = '';
-
- $skipFields = $config['skipFields'] ?? [];
- $restrictFields = $config['restrictFields'] ?? [];
- $tableCallbacks = $config['tableCallbacks'] ?? [];
-
- $this->loadDc($table);
- $this->loadLanguageFile($table);
-
- $dca = $GLOBALS['TL_DCA'][$table];
-
- $arrayUtil = System::getContainer()->get('huh.utils.array');
-
- // Get the order fields
- $dcaExtractor = DcaExtractor::getInstance($table);
- $fields = $dcaExtractor->getFields();
- $orderFields = $dcaExtractor->getOrderFields();
-
- // Find the changed fields and highlight the changes
- foreach ($target as $k => $v) {
- if (empty($restrictFields) && \in_array($k, $skipFields)) {
- continue;
- }
-
- if (!empty($restrictFields) && !\in_array($k, $restrictFields)) {
- continue;
- }
-
- if ($source[$k] != $target[$k]) {
- if ($dca['fields'][$k]['eval']['doNotShow'] || $dca['fields'][$k]['eval']['hideInput']) {
- continue;
- }
-
- $isBinary = 0 === strncmp($fields[$k], 'binary(', 7) || 0 === strncmp($fields[$k], 'blob ', 5);
-
- if ($dca['fields'][$k]['eval']['multiple'] || \in_array($k, $orderFields)) {
- if (isset($dca['fields'][$k]['eval']['csv'])) {
- $delimiter = $dca['fields'][$k]['eval']['csv'];
-
- if (isset($target[$k])) {
- $target[$k] = preg_replace('/'.preg_quote($delimiter, ' ?/').'/', $delimiter.' ', $target[$k]);
- }
-
- if (isset($source[$k])) {
- $source[$k] = preg_replace('/'.preg_quote($delimiter, ' ?/').'/', $delimiter.' ', $source[$k]);
- }
- } else {
- // Convert serialized arrays into strings
- if (\is_array(($tmp = StringUtil::deserialize($target[$k]))) && !\is_array($target[$k])) {
- $target[$k] = $arrayUtil->implodeRecursive($tmp, $isBinary);
- }
-
- if (\is_array(($tmp = StringUtil::deserialize($source[$k]))) && !\is_array($source[$k])) {
- $source[$k] = $arrayUtil->implodeRecursive($tmp, $isBinary);
- }
- }
- }
-
- unset($tmp);
-
- // Convert binary UUIDs to their hex equivalents (see #6365)
- if ($isBinary) {
- if (Validator::isBinaryUuid($target[$k])) {
- $target[$k] = StringUtil::binToUuid($target[$k]);
- }
-
- if (Validator::isBinaryUuid($source[$k])) {
- $source[$k] = StringUtil::binToUuid($source[$k]);
- }
- }
-
- // Convert date fields
- if ('date' == $dca['fields'][$k]['eval']['rgxp']) {
- $target[$k] = \Date::parse(Config::get('dateFormat'), $target[$k] ?: '');
- $source[$k] = \Date::parse(Config::get('dateFormat'), $source[$k] ?: '');
- } elseif ('time' == $dca['fields'][$k]['eval']['rgxp']) {
- $target[$k] = \Date::parse(Config::get('timeFormat'), $target[$k] ?: '');
- $source[$k] = \Date::parse(Config::get('timeFormat'), $source[$k] ?: '');
- } elseif ('datim' == $dca['fields'][$k]['eval']['rgxp'] || 'tstamp' == $k) {
- $target[$k] = \Date::parse(Config::get('datimFormat'), $target[$k] ?: '');
- $source[$k] = \Date::parse(Config::get('datimFormat'), $source[$k] ?: '');
- }
-
- // Decode entities if the "decodeEntities" flag is not set (see #360)
- if (empty($dca['fields'][$k]['eval']['decodeEntities'])) {
- $target[$k] = StringUtil::decodeEntities($target[$k]);
- $source[$k] = StringUtil::decodeEntities($source[$k]);
- }
-
- // Convert strings into arrays
- if (!\is_array($target[$k])) {
- $target[$k] = explode("\n", $target[$k]);
- }
-
- if (!\is_array($source[$k])) {
- $source[$k] = explode("\n", $source[$k]);
- }
-
- // custom callbacks to modify data
- if (isset($tableCallbacks[$table]) && \is_callable($tableCallbacks[$table])) {
- $tableCallbacks[$table]($k, $v, $source, $target);
- }
-
- $diff = new \Diff($source[$k], $target[$k]);
- $result .= $diff->render(new DiffRenderer(['field' => ($dca['fields'][$k]['label'][0] ?: (isset($GLOBALS['TL_LANG']['MSC'][$k]) ? (\is_array($GLOBALS['TL_LANG']['MSC'][$k]) ? $GLOBALS['TL_LANG']['MSC'][$k][0] : $GLOBALS['TL_LANG']['MSC'][$k]) : $k))]));
- }
- }
-
- // Identical versions
- if ('' == $result) {
- $result = '
- {% else %}
- 
- {% endif %}
-
- {% if sources %}
- 
assertNotFalse(strpos($result, 'title="Edit"'));
-
- $result = $dcautil->getPopupWizardLink([
- 'do' => 'newsletter',
- 'act' => 'edit',
- 'id' => 1,
- ], [
- 'title' => 'Hello',
- 'icon' => 'hello.png',
- ]);
- $this->assertStringStartsWith('
assertNotFalse(strpos($result, 'title="Hello"'));
- $this->assertNotFalse(strpos($result, 'onclick="Backend.openModalIframe'));
-
- $result = $dcautil->getPopupWizardLink([
- 'do' => 'newsletter',
- 'act' => 'edit',
- 'id' => 1,
- ], [
- 'title' => 'Hello',
- 'icon' => 'hello.png',
- 'onclick' => 'onclick="alert(\'Wow!\');"',
- 'linkText' => 'Foo!',
- 'attributes' => [
- 'title' => 'World',
- 'class' => 'tl_button',
- 'href' => 'abc.html',
- 'onclick' => 'event();',
- ],
- ]);
- $this->assertStringStartsWith('