golib_fal

golib_fal

\GOSIGN\GolibFal\Controller\FrontendController USAGE EXAMPLES

getImage()

einfaches Rendern aller Inhalte, die sich im fal-Element befinden

Diese Methode muss für Einzelbildfelder verwendet werden.

Verwenden Sie diese Methode für Felder mit mehreren Bildern, wenn Sie nur das erste Bild zurückgeben möchten, ansonsten verwenden Sie getImages()

Innerhalb dieser Funktion wird die Beschneide- und Positionierungsfunktionalität automatisch verarbeitet

aufruf:

\GOSIGN\GolibFal\Controller\FrontendController::getImage((
    $this->cObj,
    array(
        imageResourceConf' => array((
            Tabelle' => 'tt_content',
            ident' =>'single image_1',
            'uid' => $this->cObj->data['uid']
        )
    )
);

zurückkehren:

* für den Fall, dass vom Benutzer nichts im fal-Element verwaltet wird:

<div class="imageWrap">
    <img src="relativ/pfad/zu/dem/ersten/gefundenen/image/for/this/contentelemen/image.jpg" />
</div>

* falls es eine Änderung oder einen Titel gibt, der vom Benutzer im fal-Element verwaltet wird:

<div class="imageWrap">
    <img alt="alt landet hier" title="title landet hier" src="relativ/path/to/the/first/found/image/for/this/contentelement/image.jpg" />
</div>

* falls es einen Link gibt, der vom Benutzer im fal-Element verwaltet wird:

<div class="imageWrap">
    <a >
        <img src="relativ/pfad/zu/dem/ersten/gefundenen/image/for/this/contentelement/image.jpg" />
    </a>
</div>

* falls es eine Beschreibung gibt, die vom Benutzer im fal-Element verwaltet wird:

<div class="imageWrap">
    <img src="relativ/pfad/zu/dem/ersten/gefundenen/image/for/this/contentelement/image.jpg" />
    <p class="description">
        beschreibung landet hier im p-Tag
    </p>
</div>

* falls alle verwaltbaren Dinge vom Benutzer eingegeben werden

<div class="imageWrap">
    <a >
    <img alt="alt landet hier" title="title landet hier" src="relativ/path/to/the/first/found/image/for/this/contentelement/image.jpg" />
    </a>
    <p class="description">
        beschreibung landet hier im p-Tag
    </p>
</div>

verwendung der Konfiguration für das Rendering

alle zusätzlichen Dinge (Beschreibung, Wraps, Links) können im Funktionsaufruf deaktiviert oder überschrieben werden

z.B. einen Funktionsaufruf zum Deaktivieren des Main Wrap und der Beschreibung und das Setzen eines Links auf die Seite mit der ID 5:

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImage((
        $this->cObj,
        array(
            imageResourceConf' => array((
                Tabelle' => 'tt_content',
                ident' =>'single image_1',
                'uid' => $this->cObj->data['uid']
            )
            imageProcessingConfig' => array((
                descriptionConf' => array((
                    allowDescription' => FALSE
                )
                wrapConf' => array((
                    allowWrap' => FALSE
                )
                linkConf' => array((
                    linkTo' => '5',
                ),
            )
        )
    );

zurückkehren:

    <a >
        <img src="relativ/pfad/zu/dem/ersten/gefundenen/image/for/this/contentelement/image.jpg" />
    </a>

HINWEIS: Wenn der Benutzer hier eine Beschreibung oder einen Link im Fal-Element verwaltet, wird dieser ignoriert. Seien Sie also vorsichtig, wenn Sie eines dieser Elemente überschreiben oder deaktivieren. title und alt werden jedoch in das Image-Tag geparst.

Überprüfen Sie die Kommentare des Funktionskopfes, um alle verfügbaren Optionen anzuzeigen.

getImages()

Diese Methode muss für Multiple-Image-Felder verwendet werden.

Es werden alle gefundenen Bilder für dieses Inhaltselement in dem angegebenen Relationsfeld angezeigt.

konfiguration ist die gleiche wie in getImage().

Innerhalb dieser Funktion wird die Beschneide- und Positionierungsfunktionalität automatisch verarbeitet

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImages(
        $this->cObj,
        array(
            imageResourceConf' => array((
                Tabelle' => 'tt_content',
                ident' =>'multiple image_1',
                'uid' => $this->cObj->data['uid']
            )
            imageProcessingConfig' => array((
                descriptionConf' => array((
                    allowDescription' => FALSE
                )
                wrapConf' => array((
                    allowWrap' => FALSE
                )
                linkConf' => array((
                    linkTo' => '5',
                ),
            )
        )
    );

zurückkehren:

    array(
        2' => '<a >
                <img src="relativ/pfad/zu/dem/ersten/gefundenen/image/for/this/contentelement/image.jpg" />
            </a>'
        4' => '<a >
                <img src="relativ/pfad/zu/der/sekunde/gefunden/bild/for/diesem/contentelement/image.jpg" />
            </a>'
        ...
        17' => '<a >
                <img src="relativ/pfad/zu/dem/letzten/gefundenen/gefundenen/image/for/this/contentelement/image.jpg" />
            </a>'
    )

fal element ids werden hier als Array-Index verwendet.

HINWEIS: Wenn Sie Ihre Konfigurationen für diese Methode einrichten, wird if für alle gefundenen Bilder verwendet. In diesem Beispiel werden also alle Bilder auf die Seite mit der ID 5 verlinkt.

Überprüfen Sie die Kommentare des Funktionskopfes, um alle verfügbaren Optionen anzuzeigen.

getImageByResource()

Diese Methode muss verwendet werden, wenn Sie eine Bildressource haben, für die Sie einen img-tag haben möchten.

(!) Innerhalb dieser Funktion wird die Beschneide- und Positionierungsfunktionalität NICHT verarbeitet

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageByResource(
        $this->cObj,
        relativ/pfad/zu/die/ihr/ihr/bild.jpg'
    );

zurückkehren:

    <div class="imageWrap">
        <img src="relativ/pfad/zu/deinem/deinem/ihrem/bild.jpg" />
    </div>

für Alt-/Titelattribute, Links und Beschreibung können Sie den optionalen dritten Parameter verwenden:

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageByResource(
        $this->cObj,
        relativ/pfad/zu/die/ihr/ihr/bild.jpg'
        array(
            fileRecord' => array(()
                alternativ' => 'alt Text hier',
                title' => 'title text here',
                Beschreibung' =>'Beschreibung hier',
                'link' => '42',
            ),
        )
    );

zurückkehren:

    <div class="imageWrap">
        <a "
            <img alt="alt text here" title="title text here" src="relativ/path/to/the/your/image.jpg" />
        </a>
        <p class="description">
            beschreibung hier
        </p>
    </div>

HINWEIS: Beachten Sie, dass Sie neben der Option fileRecord auch dieser Funktion eine imageProcessingConfig geben können. Weitere Informationen über die Option imageProcessingConfig finden Sie unter getImage().

getImageResource()

Diese Methode muss verwendet werden, wenn Sie nur die Bildressource benötigen. Die getImage() sollte alles verarbeiten, was Sie für die Bildwiedergabe benötigen, also überlegen Sie zweimal, ob Sie getImageResource() wirklich benötigen oder ob getImage() Ihr Bild so wiedergeben kann, wie Sie es benötigen.

(!) Innerhalb dieser Funktion wird die Beschneide- und Positionierungsfunktionalität NICHT verarbeitet

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageResource(
        $this->cObj,
        array(
            imageResourceConf' => array((
                ident' =>'single image_1',
            ),
        )
    );

zurückkehren:

    relativ/pfad/zu/mein/bild.jpg

Es gibt einen optionalen Parameter für die Bildkonfiguration (Resizing/Cropping). Wenn dieser Parameter gesetzt ist, erhalten Sie die Ressource des verarbeiteten Bildes.

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageResource(
        $this->cObj,
        array(
            imageResourceConf' => array((
                ident' =>'single image_1',
            ),
            imageConf' => array(()
                maxW'=> '141c',
            ),
        )
    );

zurückkehren:

    relativ/pfad/zu/mir/bearbeitet/image.jpg

getImageResources()

Diese Methode muss für Multiple-Image-Felder verwendet werden. Die getImages() sollte alles verarbeiten, was Sie für die Bildwiedergabe benötigen, also überlegen Sie zweimal, ob Sie getImageResources() wirklich benötigen oder ob getImages() Ihre Bilder so wiedergeben kann, wie Sie sie benötigen.

(!) Innerhalb dieser Funktion wird die Beschneide- und Positionierungsfunktionalität NICHT verarbeitet

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageResources(
        $this->cObj,
        array(
            imageResourceConf' => array((
                ident' =>'single image_1',
            ),
        )
    );

zurückkehren:

    array(
        2' =>'relativ/pfad/zu/mein/bild2.jpg'
        4' =>'relativ/pfad/zu/mir/image4.jpg''
        ...
        17' =>'relativ/pfad/zu/mit/mit/Bild17.jpg''
    )

Äquivalent zu getImageResource() gibt es einen optionalen Parameter für Bildkonfigurationen (Resizing/Cropping). Wenn dieser Parameter gesetzt ist, erhalten Sie alle Ressourcen der verarbeiteten Bilder.

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getImageResources(
        $this->cObj,
        array(
            imageResourceConf' => array((
                ident' =>'single image_1',
            ),
            imageConf' => array(()
                maxW'=> '141c',
            ),
        )
    );

zurückkehren:

    array(
        2' =>'relativ/pfad/zu/mir/bearbeitet/image2.jpg''
        4' =>'relativ/pfad/zu/mir/bearbeitet/image4.jpg''
        ...
        17' =>'relativ/pfad/zu/mir/bearbeitet/im Bild17.jpg''
    )

getFileLink()

Diese Methode muss für Singlefile-Felder verwendet werden.

Verwenden Sie diese Methode für Felder mit mehreren Dateien, wenn Sie nur die erste Datei zurückgeben möchten. andernfalls verwenden Sie getFileLinks()

aufruf:

\GOSIGN\GolibFal\Controller\FrontendController::getFileLinks((
    $this->cObj,
    array(
        fileResourceConf' => array(()
            Tabelle' => 'tt_content',
            ident' =>'single image_1',
            'uid' => $this->cObj->data['uid']
        )
    )
);

zurückkehren:

<div class="fileWrap">
    <a >title</a>
</div>

Gemäß getImage() gibt es mehrere Optionen, die gesetzt werden können, um das zurückgegebene html zu minimieren.
Überprüfen Sie die Kommentare des Funktionskopfes, um alle verfügbaren Optionen anzuzeigen.

getFileLinks()

Diese Methode muss für Felder mit mehreren Dateien verwendet werden.

Es werden alle gefundenen Dateien für dieses Inhaltselement in dem angegebenen Relationsfeld angezeigt.

die Konfiguration ist die gleiche wie in getFileLink().

aufruf:

    \GOSIGN\GolibFal\Controller\FrontendController::getFileLinks((
        $this->cObj,
        array(
            fileResourceConf' => array(()
                Tabelle' => 'tt_content',
                ident' =>'multipleeimage_1',
                'uid' => $this->cObj->data['uid']
            )
            fileRenderingConfig' => array((
                descriptionConf' => array((
                    allowDescription' => FALSE
                )
                wrapConf' => array((
                    allowWrap' => FALSE
                )
                labelConf' => array(()
                    labelField' =>'Alternative',
                ),
            )
        )
    );

zurückkehren:

    array(
        2' => <a >
                Inhalt von $fileRecords[2]['Alternative']}
            </a>'
        4' => <a >
                Inhalt von $fileRecords[4]['Alternative']}
            </a>'
        ...
        17' => <a >
                Inhalt von $fileRecords[17]['Alternative']}
            </a>'
    )

fal element ids werden hier als Array-Index verwendet.

HINWEIS: Wenn Sie Ihre Konfigurationen für diese Methode einrichten, wird if für alle gefundenen Dateien verwendet. In diesem Beispiel haben also alle Dateien den Inhalt ihrer Alt-Felder als Label mit Dateinamen als Fallback (Standard).

Überprüfen Sie die Kommentare des Funktionskopfes, um alle verfügbaren Optionen anzuzeigen.

einige andere nützliche Methoden

* getFileRecord()

* getFileRecords()

* getFilePublicUrl()

* getFilePublicUrls()

* getFilesByRelation()

alle diese Methoden erwarten das gleiche Config-Array wie der Parameter:

    $defaults = array(
        Tabelle' => 'tt_content',
        ident' => ''',
        'uid' => '',
    );

ident und uid MÜSSEN gesetzt sein. Die Tabelle ist auf tt_content voreingestellt.

\GOSIGN\GolibFal\Configuration\TcaConfiguration USAGE BEISPIELE

getFalColumn()

Diese Methode muss in ext_tables.php oder tca.php verwendet werden, um eine tca-Konfiguration für ein Feld zu erhalten.

aufruf:

    \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn(()
        Einzelbild',
        mySingleImageField'
    )

zurückkehren:

    array(
        ausschließen' => 1,
        label' => 'LLL:EXT:golib_fal/Ressourcen/Private/Language/locallang_db.xml:tx_golibfal.singleimage,
        config' => array((
            // Siehe ExtensionManagementUtility::getFileFieldTCAConfig() für weitere Informationen
        )
    )

das Return-Array kann überschrieben werden, indem man den dritten Parameter von \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn() verwendet, der ein optionaler Parameter ist.

z.B. durch Geben von

    array(
        label' =>'LLL:EXT:go_extension/locallang_db.xml:tx_goextension.singleimage',
        config' => array((
            foreign_table' => 'myOwnFileReferenceTable'
        )
    )

die Konfiguration überschreibt das Rückgabefeld mit diesen Feldern.

Bildausschnitt

Das Zuschneiden des Bildes wird standardmäßig in der Funktion \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn hinzugefügt.

Dies geschieht durch Setzen des vierten Parameters auf \GOSIGN\GolibFal\Configuration\TcaConfiguration::CROPPING. Dies ist die Voreinstellung.

beispiel:
    \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn(()
        Einzelbild',
        mySingleImageField',
        array(), // Konfiguration array
        \GOSIGN\GolibFal\Configuration\TcaConfiguration::CROPPINGING
    )

Um das Zuschneiden zu deaktivieren, müssen Sie den vierten Parameter auf NULL setzen

beispiel:
    \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn(()
        Einzelbild',
        mySingleImageField',
        array(), // Konfiguration array
        NULL
    )

Konfiguration des Zuschneidefeldes

Die Struktur der Konfiguration

Die Konfiguration des Beschneidefeldes erfolgt innerhalb des Arrays $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL'].

Der erste Schlüssel des Arrays ist der Feldname, in dem die Beschneidungsinformationen gespeichert sind, standardmäßig'tx_golibfal_imagemask'

Innerhalb der Feldkonfiguration können Sie den Schlüssel'defaults' für die systemweite Standardkonfiguration verwenden.

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        / / Konfiguration hier einstellen
    );

Wenn Sie eine Konfiguration für ein bestimmtes Bildfeld definieren möchten, können Sie den Namen dieses Feldes als Schlüssel verwenden. Dies funktioniert mit jeder Tabelle (tt_content, Seiten oder benutzerdefinierte Tabellen)

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['name_of_image_field'] = array(
        / / Konfiguration hier einstellen
    );

Und Sie können eine Konfiguration für ein Bildfeld innerhalb eines speziellen Elementtyps definieren ('CType' für tt_content oder'doktype' für Seiten oder jedes andere definierte Typfeld von benutzerdefinierten Tabellen)

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['name_of_the_element_type']['name_of_image_field'] = array(
        / / Konfiguration hier einstellen
    );

Die spezielleren Konfigurationen überschreiben immer die weniger speziellen.

Der Inhalt der Konfiguration

Das Konfigurations-Array hat zwei Tasten, "Workspace" und "Selector".

Die Arbeitsbereichskonfiguration

(!) Diese Funktion funktioniert im Moment nicht.

Der Arbeitsbereich definiert die maximale Breite und Höhe des Zuschneidelements im Backend. Es kann die Schlüssel'maxWidth' und'maxHeight' enthalten.

Wenn ein Bild größer als der Arbeitsbereich ist, wird es in der Größe angepasst, um in den Arbeitsbereich zu passen

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        Arbeitsbereich' => array(
            MaxWidth' => '800',
            maxHeight' => '800',
        ),
    );

Die Konfiguration des Wahlschalters

Der Wahlschalter definiert die Mindestgröße des Wahlschalters und kann ein festes Verhältnis einstellen. Es kann die Schlüssel'minWidth','minHeight' und'ratio' enthalten

Für die Definition des Verhältnisses sollte die statische Funktion \GOSIGN\GolibFal\ImageHandling\HandlerUtility::calculateRatio($width, $height, $precision) verwendet werden.

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        Selektor' => array(
            Mindestbreite' => 200,
            minHeight' => 150,
            Verhältnis' => \GOSIGN\GolibFal\ImageHandling\HandlerUtility::calculateRatio(200, 150, 2),
        ),
    );

Bildpositionierung

Diese Erweiterung beinhaltet die Funktionalität, ein oder mehrere Bilder und Texte über ein Hintergrundbild zu legen.

Die Konfiguration muss dem Bildfeld hinzugefügt werden, das das Hintergrundbild enthält.

Dies geschieht durch Setzen des vierten Parameters von \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn mit der Konstanten \GOSIGN\GolibFal\Configuration\TcaConfiguration::POSITIONING. Dazu gehört auch die Beschneidungskonfiguration.

beispiel:
    \GOSIGN\GolibFal\Configuration\TcaConfiguration::getFalColumn(()
        Einzelbild',
        mySingleImageField',
        array(), // Konfiguration array
        \GOSIGN\GolibFal\Configuration\TcaConfiguration::POSITIONINGING
    )

Das Hintergrundbild wird beschnitten, bevor es an die Positionierungsfunktionalität übergeben wird

Konfiguration des Positionierungsfeldes

Die Struktur der Konfiguration

Die Struktur ist die gleiche wie beim Zuschneidefeld. Das Standardfeld ist'tx_golibfal_positioning'

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_positioning']['default'] = array(
        / / Konfiguration hier einstellen
    );

Die speziellen Konfigurationen funktionieren wie beim Zuschneidefeld

Der Inhalt der Konfiguration

Das Konfigurations-Array hat nur den Schlüssel'Workspace'.

Die Arbeitsbereichskonfiguration

Der Arbeitsbereich unterscheidet sich vom Arbeitsbereich der Beschneidungskonfiguration. Es definiert einen realen Raum, der für den Positionierungsbereich verwendet wird, auch wenn das Bild kleiner als der Arbeitsbereich ist. Wenn das Bild größer als der Arbeitsbereich ist, wird es in der Größe angepasst, um in den Arbeitsbereich zu passen.

Innerhalb der Konfiguration des Arbeitsbereichs gibt es vier mögliche Schlüssel: 'Breite', 'Höhe', 'BildPosition' und 'Frontend'

width' und'height' definieren die Größe des Arbeitsbereichs.

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        Arbeitsbereich' => array(
            Breite' => 800,
            Höhe' => 400,
        ),
    );

Mit'imagePostition' können Sie die Größe und den Versatz des Bildes innerhalb des Arbeitsbereichs einstellen. Mögliche Schlüssel sind'width','height','offsetX' und'offsetY'. Es sind nur positive Offsets erlaubt und 'Bildgröße' + 'Offset' muss kleiner als die Arbeitsbereichsgröße sein.

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        Arbeitsbereich' => array(
            Breite' => 800,
            Höhe' => 400,
            imagePosition' => array(()
                offsetX' => 50,
                OffsetY' => 20,
                Breite' => 700,
                Höhe' => 360,
            ),
        ),
    );

Mit 'frontend' können Sie einen zusätzlichen Offset für das Frontend css einstellen.

beispiel:
    $GLOBALS['TYPO3_CONF_VARS']['GOLIB_FAL']['tx_golibfal_imagemask']['defaults'] = array(
        Arbeitsbereich' => array(
            Frontend' => array((
                offsetX' => 0,
                OffsetY' => -20,
            ),
        ),
    );