josefglatz/cropvariantsbuilder

Simplify writing cropVariants for TYPO3 Integrators/Developers

Maintainers

Details

github.com/josefglatz/cropvariantsbuilder

Source

Issues

Installs: 17 752

Dependents: 1

Suggesters: 0

Security: 0

Stars: 7

Watchers: 2

Forks: 5

Open Issues: 5

Type:typo3-cms-extension

2.0.1 2024-10-31 04:53 UTC

Requires

Replaces

  • typo3-ter/cropvariantsbuilder: 2.0.1

GPL-2.0-or-later e44843aa4fed915fc4b75b384e0e237dbf5290bd

extensiontypo3imagemanipulationcropvariantcropvariants

This package is auto-updated.

Last update: 2024-10-31 04:56:15 UTC

README

TYPO3 extension to simplify writing cropVariants for TYPO3 Integrators/Developers

→ → → Table of Contents
  1. → About
    1. Past
    2. Present
    3. Future
  2. → Installation
    1. Installation using Composer
    2. Installation as extension from TYPO3 Extension Repository (TER)
  3. → Configuration
    1. Name of the extension where the general configuration file lives
    2. Example of using your own CropVariants.yaml file
    3. Example of using your own CropVariants.yaml file while using the \TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader->load() imports feature
  4. → Detailed manual and more examples
    1. Handling of cropVariants in TYPO3
      1. Centralized configuration for AspectRatio, Cover-/CropArea presets and CropVariant definitions
      2. Handling of cropVariants in TYPO3: Simplified cropVariants configuration for the Table Configuration Array
    2. Defaults And Presets
    3. CropVariantsBuilder
      1. Example 1: Set a global default cropVariants configuration
      2. Example 2: Set custom cropVariants for a specific field of a specific table (pages.tx_my_nice_site_extension_nav_image)
      3. Example 3: Set custom cropVariants for tx_news_domain_model_news.fal_media
      4. Example 4: Set custom cropVariants for tt_content.image for CType tx_my_nice_site_extension_custom_ce1
    4. Translation logic for cropVariant label

About

This extensions centralizes the configuration of

  • default aspectRatios,
  • aspectRatios used within the TYPO3 instance,
  • coverAreas used within the TYPO3 instance,
  • cropAreas used within the TYPO3 instance,
  • focusAreas used within the TYPO3 instance.

This extension makes it easy to configure cropVariants within TCA (EXT:your_ext/Configuration/TCA/**/*.php) modifications in your "site package" extension.

The extension relies 100% on the TYPO3 core functionality and can be seen as an on-top-time-saver for TYPO3 integrators.

Past

The initial public version was part of https://github.com/josefglatz/TYPO3-Distribution. The demands grew in 2019 and therefore I came up with a new idea to support also the TYPO3 site configuration which was introduced in TYPO3 9.5 LTS.

Present

This extension doesn't support the TYPO3 site configuration. With that known fact, it's not possible to distinguish between multiple sites in a multitree environment.

Future

The functionality of this extension will stay as it is. There will be no direct successor to which you can update and migrate automatically (from my current perspective). I will link the new extension here when it's publicly available.

At the time of writing about the future my plan is to re-adding the functionality completely via the TYPO3 site configuration and the FormDataProvider. With that in mind, it's possible to make site specific configurations. Even the configuration can be done completely via a YAML file beside your existing YAML file of one configured site.

If it makes really sense, I probably add also the functionality of EXT:cropvariantsbuilder to make global TCA modifications possible (not yet specified if you have to write YAML or the known PHP syntax).

Installation

Installation using Composer

The recommended way to install the extension is by using Composer. In your Composer based TYPO3 project root, just do composer require josefglatz/cropvariantsbuilder.

Installation as extension from TYPO3 Extension Repository (TER)

Download and install the extension with the TYPO3 CMS extension manager module or directly via typo3.org.

Version Matrix

Development

The ongoing development is done within the main branch!

You can use composer require josefglatz/cropvariantsbuilder:dev-main if you want to test the current development state.

Configuration

Name of the extension where the general configuration file lives

The following options must be set within the TYPO3 extension configuration:

configurationProviderExtension = my_nice_site_extension

So if you place the configuration file in EXT:my_nice_site_extension/Configuration/ImageManipulation/CropVariants.yaml you have to set the value to my_nice_site_extension.

configurationProviderLocallangFilename = locallang

So if you place the translations in EXT:my_nice_site_extension/Resources/Private/Language/locallang.xlf you have to set the value to locallang. Read more about the supported translation logic.

The following example shows the resulting PHP configuration part:

// TYPO3 >= 9.5 LTS:
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['cropvariantsbuilder'] = [
    'configurationProviderExtension' => 'my_nice_site_extension',
    'configurationProviderLocallangFilename' => 'locallang',
];

// TYPO3 =< 8.7 LTS
$GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['cropvariantsbuilder'] = serialize([
    'configurationProviderExtension' => 'my_nice_site_extension',
    'configurationProviderLocallangFilename' => 'locallang',
]);

Example of using your own CropVariants.yaml file

Just clone the file EXT:cropvariantsbuilder/Configuration/ImageManipulation/CropVariants.yaml to EXT:my_nice_site_extension/Configuration/ImageManipulation/CropVariants.yaml and modify it however you want. With that approach, you have no dependencies on the default CropVariants.yaml of EXT:cropvariantsbuilder.

Example of using your own CropVariants.yaml file while using the \TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader->load() imports feature

The following example represents the content of the file EXT:my_nice_site_extension/Configuration/ImageManipulation/CropVariants.yaml.

imageManipulation:
  cropVariants:
    defaults:
      aspectRatios:
        "1.91:1":
          title: "This is the new title for an existing aspectRatio within EXT:cropvariantsbuilder"
        "123:321":
          title: "Completely new introduced aspect ratio"
          value: 123 / 321

      defaultCropVariantsConfiguration:
        default:
          aspectRatios:
            - "3:2"
            - "2:3"
            - "123:321"
            - "NaN"

imports:
  -
    resource: 'EXT:cropvariantsbuilder/Configuration/ImageManipulation/CropVariants.yaml'

You can rely on the default CropVariants.yaml of EXT:cropvariantsbuilder while modifying it to meet the demands of your specific project with the example shown above. And of course, you can import any other YAML file. You don't have to rely on the default CropVariants.yaml if the resulting YAML file includes a configuration for every necessary part.

Detailed manual and more examples

Cheers to all TYPO3 enthusiasts out there!

Created by

http://josefglatz.at/

Support

Many thanks to my employer supseven.at for sponsoring work time.