This bundle offers various utility functionality for the Contao CMS.
- Install via composer:
composer require heimrichhannot/contao-utils-bundle - Update database
Add following dependencies to your project composer file, if you want to use one of the following utils:
| Util | Dependency |
|---|---|
"mpdf/mpdf": "^7.0|^8.0" |
|
| huh.utils.pdf.preview | "spatie/pdf-to-image": "^1.8" or/and "alchemy/ghostscript": "^4.1" |
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 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.
use HeimrichHannot\UtilsBundle\Util\Utils;
class MyClass{
/** @var Utils */
protected $utils;
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 (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
PdfCreator - High-level API to create pdf files with PHP (PDFCreator was moved into it's own library)
The bundle assets (js) are prepared to be used with webpack/encore. If you don't use Foxy, you need to add "@hundh/contao-utils-bundle": "^1.5.0" to your project package.json.
See package Repository for documentation.
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.
import "@hundh/contao-utils-bundle";
...
utilsBundle.ajax.get(url, data, config);
# or
utilsBundle.ajax.post(url, data, config);
Following configuration parameter can be overridden:
# Default configuration for extension with alias: "huh_utils"
huh_utils:
tmp_folder: files/tmp/huh_utils_bundle
# Default folder where to store pdf preview images.
pdfPreviewFolder: null
cache:
# 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: trueThese bundle add server twig filters:
| 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. |
Use the image extension to resize contao images inside your twig template.
{% for box in boxes %}
{{ box.image|image([0,0,6],{'href' : box.url, 'linkTitle' : 'vmd.content.more.default'|trans})|raw }}
{% endfor %}
- size: array containing width, height or image size config id (
Theme image size id) - data: additional image data like css class, linkTitle or href
Use the download extension to render download elements, get download links, download path or download data.
{% 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. #}
| 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) |
Entity finder - A command to search for any contao entities in your database.
Image size creator - Creates image size items for a given image size entity.
Description:
Creates image size items for a given image size entity. Image size entities with existing image size items will be skipped.
Usage:
huh:utils:create-image-size-items [<image-size-ids> [<breakpoints>]]
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