### Be.infobox ViewHelper Examples

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

Provides code examples for using the Be.infobox ViewHelper with different configurations, including custom icons and HTML content.

```APIDOC
## PUT /api/users/{id}

### Description
Updates an existing user resource identified by their ID.

### Method
PUT

### Endpoint
/api/users/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the user to update.

#### Request Body
- **email** (string) - Optional - The new email address for the user.
- **password** (string) - Optional - The new password for the user.

### Request Example
```json
{
  "email": "john.doe.updated@example.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the user was updated successfully.

#### Response Example
```json
{
  "message": "User with ID 101 updated successfully."
}
```
```

```APIDOC
## DELETE /api/users/{id}

### Description
Deletes a user resource by their ID.

### Method
DELETE

### Endpoint
/api/users/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the user to delete.

### Response
#### Success Response (204)
No content is returned upon successful deletion.

#### Response Example
(No content)
```

--------------------------------

### Security.nonce ViewHelper Examples

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Security/Nonce.rst

Examples demonstrating the usage of the Security.nonce ViewHelper with different configurations for inline scripts, external scripts, and inline styles.

```APIDOC
## Security.nonce ViewHelper Examples

### Basic Usage

```html
<script nonce="{f:security.nonce()}">const inline = 'script';</script>
```

### Inline Script with Explicit Directive

```html
<script nonce="{f:security.nonce(directive: 'script-src')}">
    const test = true;
</script>
```

### External Script with Nonce

```html
<script
    src="{scriptUri}"
    nonce="{f:security.nonce(directive: 'script-src', scope: 'static')}"></script>
```

### Inline Style Block

```html
<style nonce="{f:security.nonce(directive: 'style-src')}">
    body {
        background-color: #f5f5f5;
    }
</style>
```
```

--------------------------------

### TypoScript Configuration for Render.contentArea

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/ContentArea.rst

Example TypoScript setup to enable the page-content data processor, which is necessary for the `<f:render.contentArea>` ViewHelper to function.

```APIDOC
## TypoScript Configuration for `<f:render.contentArea>`

### Description

This TypoScript configuration sets up a PAGE object with a PAGEVIEW content object and enables the page-content data processor, which is required for the `<f:render.contentArea>` ViewHelper.

### Method

TypoScript

### Endpoint

N/A (Configuration)

### Parameters

N/A

### Request Example

```typoscript
page = PAGE
page {
    10 = PAGEVIEW
    10 {
        paths.10 = EXT:my_sitepackage/Resources/Private/Templates/
        dataProcessing.10 = page-content
    }
}
```

### Response

N/A

```

--------------------------------

### Be.infobox ViewHelper with HTML content, icon and links

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

This example demonstrates a complex infobox with HTML content, an icon, and links. It is typically found in the TYPO3 backend module 'System > DB Check > Manage Reference Index' if 'typo3/cms-lowlevel' is installed.

```html
<f:be.infobox title="Reference Index" icon="/typo3/sysext/core/Resources/Public/Icons/T3Icons/actions/actions-system-maintenance.svg">
    <p>The reference index is used to manage the TYPO3 reference index.</p>
    <f:link.action action="index" controller="ReferenceIndex" pluginName="Lowlevel" pageType="1590657730" arguments="{node: '{node.uid}'}">
        Manage Reference Index
    </f:link.action>
</f:be.infobox>
```

--------------------------------

### Example: Textarea bound to action argument

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Textarea.rst

Illustrates a basic setup for a textarea bound to a controller action argument using Fluid and a PHP controller.

```APIDOC
## Basic Textarea Bound to Action Argument

### Description
This example demonstrates how to use the `<f:form.textarea>` ViewHelper to create a text area that is directly bound to an argument in an Extbase controller action. This is useful when you need to process user input without necessarily involving a full domain model.

### Method
Not applicable (ViewHelper/Controller Action)

### Endpoint
Not applicable (ViewHelper/Controller Action)

### Parameters
See general `<f:form.textarea>` ViewHelper arguments.

### Request Example

#### Fluid Template (`_codesnippets/_TextfieldSimple.html`)
```html
<f:form action="send" name="contactForm" object="{contact}">
    <label for="message">
        <f:translate key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:contact.message.label" />
    </label>
    <f:form.textarea property="message" cols="30" rows="5" />
    <f:form.button type="submit"><f:translate key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:contact.submit" /></f:form.button>
</f:form>
```

#### Controller Action (`_codesnippets/_TextfieldSimpleController.php`)
```php
<?php

namespace MyVendor\MyExtension\Controller;

use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
use TYPO3\CMS\Extbase\Annotation\IgnoreValidation;

class ContactController extends ActionController
{
    /**
     * @param array $contactForm
     * @return void
     */
    public function sendAction(array $contactForm = []):
    {
        // Access the message from the form data
        $message = $contactForm['message'] ?? '';

        // Process the message, e.g., send an email
        // ...

        $this->addFlashMessage('Message sent successfully!');
        $this->redirect('index');
    }
}
```

### Response

#### Success Response (200)
Upon successful submission, the controller action processes the input and typically redirects the user or displays a success message.

#### Response Example
(Redirect to index action or display flash message)
```

--------------------------------

### Extbase Model Example

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/Text.rst

Example of an Extbase model definition. Ensure all columns to be rendered and the record type column are mapped.

```php
<?php

namespace MyTheme\Domain\Model;

use TYPO3\CMS\Extbase\Domain\Model\AbstractFileBasedPersistenceAwareRecord;

class MyModel extends AbstractFileBasedPersistenceAwareRecord
{
    // ... properties and methods ...
}
```

--------------------------------

### Render Section from a Partial

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render.rst

This example demonstrates how to use both the 'section' and 'partial' arguments of the Render ViewHelper to render a specific section from a different partial file.

```html
<f:render partial="MyPartial" section="MySection" arguments="{_all}"/>
```

--------------------------------

### Simple Debug ViewHelper

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Debug.rst

Use this ViewHelper to output a simple HTML dump of a variable. It requires no additional setup.

```fluid
<f:debug>{myVariable}</f:debug>
```

--------------------------------

### Generate Image URI with Inline Notation

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Uri/Image.rst

This example shows how to use the f:uri.image ViewHelper with inline notation, including parameters for minimum and maximum width. The output is a cached image path.

```html
{f:uri.image(src: 'EXT:myext/Resources/Public/typo3_logo.png', minWidth: 30, maxWidth: 40)}
```

--------------------------------

### Debug ViewHelper with All Features

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Debug.rst

This example demonstrates using the `<f:debug>` ViewHelper with all its available options, including custom titles, depth control, blacklisting of classes and properties, and output formatting. It's useful for in-depth debugging scenarios.

```fluid
<f:debug title="My Title" maxDepth="5"
    blacklistedClassNames="{0:'ACME\BlogExample\Domain\Model\Administrator'}"
    blacklistedPropertyNames="{0:'posts'}"
    plainText="true" ansiColors="false"
    inline="true"
>
    {blogs}
</f:debug>
```

--------------------------------

### f:form.countrySelect ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/CountrySelect.rst

Examples demonstrating how to use the f:form.countrySelect ViewHelper in Fluid templates.

```APIDOC
## f:form.countrySelect ViewHelper

### Description
The `f:form.countrySelect` ViewHelper renders a country selection form element.

### Method
Fluid ViewHelper

### Endpoint
N/A (Client-side rendering)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```html
<f:form.countrySelect property="country" />
```

### Response
#### Success Response (200)
N/A (Renders HTML form element)

#### Response Example
```html
<select name="country" id="country">
  <option value="AF">Afghanistan</option>
  <option value="AX">Åland Islands</option>
  ...
</select>
```

## Examples

### Basic Country Selector
This example shows a basic country selector bound to an action argument.

```html
<f:form.countrySelect property="country" />
```

### Prioritize Countries
Define a list of countries which should be listed as first options.

```html
<f:form.countrySelect property="country" prioritizedCountries="US,CA,DE" />
```

### Display Another Language
Show localized official names in a different language.

```html
<f:form.countrySelect property="country" optionLabelField="localizedName" alternativeLanguage="fr" />
```

### Bind to Extbase Model
Use the `property` attribute to bind the country selector to an Extbase model.

```html
<f:form.countrySelect property="user.country" />
```

### Arguments of f:form.countrySelect

This ViewHelper accepts arbitrary arguments that are passed to the underlying HTML select element.

Refer to `/Includes/_ArbitraryArguments.rst.txt` for details on arbitrary arguments.
```

--------------------------------

### Asset.script ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Asset/Script.rst

Examples demonstrating how to use the `<f:asset.script>` ViewHelper to include external JavaScript files or inline scripts.

```APIDOC
## Asset.script ViewHelper

### Description

The `<f:asset.script>` ViewHelper is used to include JavaScript assets in your TYPO3 Fluid templates. It leverages the AssetCollector to manage assets, ensuring that each asset is included only once. The 'identifier' attribute serves as a unique key for assets.

### Method

Not applicable (this is a ViewHelper, not an API endpoint).

### Endpoint

Not applicable (this is a ViewHelper, not an API endpoint).

### Parameters

#### Path Parameters

None.

#### Query Parameters

None.

#### Request Body

None.

### Attributes

- **identifier** (string) - Required - A unique identifier for the asset. If assets are added multiple times with the same identifier, the last one overrides previous ones.
- **src** (string) - Optional - The path to the external JavaScript file (e.g., `EXT:my_ext/Resources/Public/JavaScript/foo.js`).
- **inline** (boolean) - Optional - If set to true, the content of the referenced file is added as an inline script. If not provided and `src` is used, it includes the external file.
- **async** (boolean) - Optional - HTML attribute for asynchronous script loading.
- **crossorigin** (string) - Optional - HTML attribute for CORS settings.
- **defer** (boolean) - Optional - HTML attribute for deferring script execution.
- **integrity** (string) - Optional - HTML attribute for Subresource Integrity.
- **nomodule** (boolean) - Optional - HTML attribute for indicating a module script.
- **nonce** (string) - Optional - HTML attribute for script nonces.
- ** referrerpolicy** (string) - Optional - HTML attribute for referrer policy.
- **type** (string) - Optional - HTML attribute for the script type (e.g., `text/javascript`).

### Request Example

```html
<f:asset.script identifier="identifier123" src="EXT:my_ext/Resources/Public/JavaScript/foo.js" />

<f:asset.script identifier="identifier987">
    alert('hello world');
</f:asset.script>
```

### Response

This ViewHelper does not directly return a response body. It generates HTML `<script>` tags to be included in the page header or footer, depending on the TYPO3 rendering configuration.
```

--------------------------------

### Extbase Model for Payment Method

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Select.rst

An example Extbase model representing a payment method, which can be used with the Form.select ViewHelper.

```php
<?php

namespace MyVendor\MyExtension\Domain\Model;


class PaymentMethod extends 
    
{
    protected string $name;

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name):
    {
        $this->name = $name;
    }

    public function __toString(): string
    {
        return $this->getName();
    }
}

```

--------------------------------

### Be.pageInfo ViewHelper with Context Menu

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/PageInfo.rst

This example demonstrates how to use the Be.pageInfo ViewHelper to display a page info icon that includes a context menu. This allows users to access related actions or information.

```html
<f:be.pageInfo pageInfoIcon = "1" />
```

--------------------------------

### Be.infobox ViewHelper States using Enum and Constant ViewHelper

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

This example demonstrates the best practice of using enum values from \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity with the Constant ViewHelper for infobox states.

```html
<f:be.infobox title="Notice" state="{f:constant(class: 'TYPO3\CMS\Core\Type\ContextualFeedbackSeverity', name: 'NOTICE')}">
    This is a notice.
</f:be.infobox>
<f:be.infobox title="Info" state="{f:constant(class: 'TYPO3\CMS\Core\Type\ContextualFeedbackSeverity', name: 'INFO')}">
    This is an informational message.
</f:be.infobox>
<f:be.infobox title="OK" state="{f:constant(class: 'TYPO3\CMS\Core\Type\ContextualFeedbackSeverity', name: 'OK')}">
    This is a success message.
</f:be.infobox>
<f:be.infobox title="Warning" state="{f:constant(class: 'TYPO3\CMS\Core\Type\ContextualFeedbackSeverity', name: 'WARNING')}">
    This is a warning.
</f:be.infobox>
<f:be.infobox title="Error" state="{f:constant(class: 'TYPO3\CMS\Core\Type\ContextualFeedbackSeverity', name: 'ERROR')}">
    This is an error message.
</f:be.infobox>
```

--------------------------------

### Localized Be.menus.actionMenu

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Menus/ActionMenu.rst

This example demonstrates how to create a localized action menu by using the f:translate ViewHelper for menu item labels. Ensure translation keys are defined in your language files.

```fluid
<f:be.menus.actionMenu>
   <f:be.menus.actionMenuItem label="{f:translate(key:'overview')}" controller="Blog" action="index" />
   <f:be.menus.actionMenuItem label="{f:translate(key:'create_blog')}" controller="Blog" action="new" />
</f:be.menus.actionMenu>
```

--------------------------------

### Generate Absolute URI with Default Scheme

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Uri/External.rst

Use this ViewHelper to create an absolute URI from a relative one. No special setup is required.

```html
<f:uri.external uri="https://www.typo3.org" />
```

--------------------------------

### Be.infobox ViewHelper with Success State and Custom Icon

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

This example shows a success infobox with a custom icon. The 'state' is set to 'OK', and a custom icon path is provided via the 'icon' attribute.

```html
<f:be.infobox title="Success" state="OK" icon="/path/to/your/custom/icon.svg">
    Operation completed successfully.
</f:be.infobox>
```

--------------------------------

### Localized Action Menu Items

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Menus/ActionMenuItem.rst

This example demonstrates how to use localized labels for action menu items by leveraging the f:translate ViewHelper. Ensure translation keys are defined in your language files.

```fluid
<f:be.menus.actionMenu>
   <f:be.menus.actionMenuItem label="{f:translate(key='overview')}" controller="Blog" action="index" />
   <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
</f:be.menus.actionMenu>
```

--------------------------------

### Form Select with Prepend Option Label and Custom Options

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Select.rst

This example demonstrates how to set a label for the first option and include custom options, useful for creating select fields with a default prompt.

```html
<f:form.select options="{user.availablePaymentOptions}"
               property="preferredPayment"
               prependOptionLabel="Please Chose *"
               required="1"
>
   <f:form.select.option value="ask">Ask me every time!</f:form.select.option>
</f:form.select>
```

--------------------------------

### Full Uri.typolink Parameter Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Uri/Typolink.rst

This example demonstrates how to use `additionalParams` to append extra query parameters to the generated link. The `parameter` argument is required.

```html
<f:uri.typolink parameter="{link}" additionalParams="&u=b" />
```

--------------------------------

### Be.infobox ViewHelper with Warning State and Disabled Icon

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

This example demonstrates a warning infobox with the icon disabled. The 'warning' state is used, and the 'showIcon' attribute is set to false.

```html
<f:be.infobox title="Warning" state="WARNING" showIcon="false">
    This is a warning message.
</f:be.infobox>
```

--------------------------------

### Extbase Controller Action for Search Form

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Textfield.rst

This is an example of an Extbase controller action that handles a search form. It demonstrates how to receive and process the 'query' argument from the form.

```php
<?php

namespace MyVendor\MyExtension\Controller;

use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

class SearchController extends ActionController
{
    /**
     * @param string $query
     */
    public function searchAction(string $query = ''):
    {
        // ... process search query ...
        $this->view->assign('results', $results);
    }
}
```

--------------------------------

### Comment Controller Example

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Textfield.rst

This PHP code snippet demonstrates a controller action in TYPO3's Extbase framework. It handles form submissions and includes logic for validation and request forwarding.

```php
<?php

namespace MyVendor\MyExtension\Controller;

use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
use TYPO3\CMS\Extbase\Annotation\IgnoreValidation;

class CommentController extends ActionController
{
    /**
     * @IgnoreValidation("create")
     */
    public function createAction(): ResponseInterface
    {
        // ... action logic ...
        return $this->htmlResponse();
    }
}

```

--------------------------------

### User Model with Password Hashing

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Password.rst

Example of a User model with password validation and hashing logic. Passwords must be hashed before saving and never stored as plain text.

```php
<?php

namespace TYPO3
ecation\Domain\Model;

use TYPO3\CMS\Extbase\Domain\Model\AbstractEntity;
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
use TYPO3\CMS\Extbase\Security\Cryptography\PasswordHasherFactoryInterface;

class User extends AbstractEntity
{
    protected string $username = '';
    protected string $password = '';

    public function __construct(string $username = '', string $password = '')
    {
        $this->username = $username;
        $this->password = $password;
    }

    public function getUsername(): string
    {
        return $this->username;
    }

    public function setUsername(string $username):
    {
        $this->username = $username;
    }

    public function getPassword(): string
    {
        return $this->password;
    }

    public function setPassword(string $password):
    {
        $objectManager = GeneralUtility::makeInstance(ObjectManagerInterface::class);
        $passwordHasherFactory = $objectManager->get(PasswordHasherFactoryInterface::class);
        $this->password = $passwordHasherFactory->getDefaultHash($password);
    }
}

```

--------------------------------

### Wrap Content Elements with recordAs Argument

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/ContentArea.rst

This example demonstrates using the 'recordAs' argument with f:render.contentArea to wrap each rendered content element. It combines f:render.contentArea with f:render.record to apply custom HTML structure to individual records.

```html
<div id="sidebar">
    <f:render.contentArea contentArea="{content.left}" recordAs="record">
        <div id="sidebarItem{record.uid}">
            <f:render.record record="{record}" />
        </div>
    </f:render.contentArea>
</div>
```

--------------------------------

### TCA Configuration Example

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/Text.rst

Example of a TCA override configuration for an Extbase model. This defines how the model maps to database fields.

```php
<?php

return [
    'ctrl' => [
        'label' => 'my_field',
        // ... other ctrl properties ...
    ],
    'columns' => [
        'my_field' => [
            'label' => 'My Field',
            'config' => [
                'type' => 'input',
                // ... other config properties ...
            ],
        ],
        // ... other columns ...
    ],
];
```

--------------------------------

### Link to download a file using Link.file ViewHelper

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Link/File.rst

This snippet demonstrates how to create a link for downloading a file. Set `download` to `true` and optionally provide a `filename` for the downloaded file.

```fluid
<f:link.file file="{file}" download="true" filename="alternative-name.jpg">Download file</f:link.file>
```

--------------------------------

### Simple Be.menus.actionMenu

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Menus/ActionMenu.rst

Use this ViewHelper to create a simple action menu with predefined menu items. Each item is defined using f:be.menus.actionMenuItem.

```fluid
<f:be.menus.actionMenu>
   <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
   <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
   <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
</f:be.menus.actionMenu>
```

--------------------------------

### Be.infobox ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Infobox.rst

Demonstrates basic usage of the Be.infobox ViewHelper with static title and content.

```APIDOC
## POST /api/users

### Description
This endpoint allows for the creation of new user resources.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of users to return.

#### Request Body
- **username** (string) - Required - The desired username for the new user.
- **email** (string) - Required - The email address of the new user.
- **password** (string) - Required - The password for the new user.

### Request Example
```json
{
  "username": "johndoe",
  "email": "john.doe@example.com",
  "password": "securepassword123"
}
```

### Response
#### Success Response (201)
- **id** (integer) - The unique identifier for the newly created user.
- **username** (string) - The username of the created user.
- **email** (string) - The email address of the created user.

#### Response Example
```json
{
  "id": 101,
  "username": "johndoe",
  "email": "john.doe@example.com"
}
```
```

--------------------------------

### Link to a file using Link.file ViewHelper

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Link/File.rst

Use this snippet to create a link to a file. The `file` argument specifies the file to link to, and `target` can be used to set the link's target attribute.

```fluid
<f:link.file file="{file}" target="_blank">See file</f:link.file>
```

--------------------------------

### Format.currency ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Format/Currency.rst

Demonstrates the basic usage and various configuration options of the f:format.currency ViewHelper.

```APIDOC
## Format.currency ViewHelper

### Description

Formats a number as currency using specified separators, decimal places, and currency sign.

### Method

This is a ViewHelper, not an HTTP method.

### Endpoint

N/A (ViewHelper)

### Parameters

#### Arguments

- **_default** (string) - Required - The number to format.
- **decimalSeparator** (string) - Optional - The character used for decimal separation. Defaults to the locale's setting.
- **thousandsSeparator** (string) - Optional - The character used for thousands separation. Defaults to the locale's setting.
- **decimals** (int) - Optional - The number of decimal places to display. Defaults to the locale's setting.
- **currencySign** (string) - Optional - The currency symbol to prepend. Defaults to the locale's setting.
- **prependCurrency** (boolean) - Optional - Whether to prepend the currency sign. Defaults to true.
- **separateCurrency** (boolean) - Optional - Whether to separate the currency sign from the number. Defaults to false.
- **useDash** (boolean) - Optional - If true, uses a dash for zero decimals. Defaults to false.

### Request Example

```html
<f:format.currency>123.456</f:format.currency>
<f:format.currency decimalSeparator="." thousandsSeparator="," decimals="2" currencySign="$" prependCurrency="true" separateCurrency="false">54321</f:format.currency>
{someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: 'EUR')}
<f:format.currency useDash="true">123.00</f:format.currency>
```

### Response

#### Success Response (Output)

- The formatted currency string.

#### Response Example

```
123,46
$54,321.00
54,321,00 EUR
123,-
```
```

--------------------------------

### Get Public Class Constant

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Constant.rst

Display any public class constant from a TYPO3 class. The constant must be accessible.

```html
Join the <f:link.external uri="{f:constant(name: '\TYPO3\CMS\Core\Information\Typo3Information::URL_COMMUNITY')}">
    TYPO3 Community
</f:link.external>!
```

--------------------------------

### Format bytes with default settings

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Format/Bytes.rst

Use this ViewHelper to display file sizes in a human-readable format. No additional arguments are needed for basic conversion.

```fluid
{fileSize -> f:format.bytes()}
```

--------------------------------

### Image with Typolink String

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Image.rst

Use this when the file is configured as a typolink, starting with `t3://file`. Pass the typolink string to the `src` argument.

```html
<f:image src="{file.link}" height="250"/>
```

```html
<!-- File with uid 928 -->
<f:image src="t3://file?uid=928" height="250"/>
```

--------------------------------

### Format Currency with Defaults

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Format/Currency.rst

Use the default settings for currency formatting. This is useful for basic currency display.

```html
<f:format.currency>123.456</f:format.currency>
```

--------------------------------

### Extbase Controller for Country Selection

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/CountrySelect.rst

An example Extbase controller action that handles the submission of a country selection form. It expects a 'country' argument.

```php
<?php

namespace MyVendor\MyExtension\Controller;

use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

class UserController extends ActionController
{
    public function selectCountryAction(string $country = null): ResponseInterface
    {
        if ($country !== null) {
            // Do something with the selected country
            $this->addFlashMessage("You selected: " . $country);
        }

        return $this->htmlResponse();
    }
}
```

--------------------------------

### Basic Security.ifAuthenticated Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Security/IfAuthenticated.rst

Use this ViewHelper to display content only when a frontend user is logged in. No additional setup is required beyond including the ViewHelper.

```html
<f:security.ifAuthenticated>
   This is being shown whenever a FE user is logged in
</f:security.ifAuthenticated>
```

--------------------------------

### Render Bodytext Field from Content Model

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/Text.rst

Example of rendering the 'bodytext' field from a content model. Requires both 'bodytext' and 'ctype' to be mapped in the Extbase model.

```fluid
<f:render.text record="{contentModel}" field="bodytext" />
```

--------------------------------

### TCA configuration for input field

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/Text.rst

This PHP code snippet shows an example of a TCA configuration for an input field, which can be used with the f:render.text ViewHelper.

```php
<?php

return [
    'columns' => [
        'my_title' => [
            'label' => 'My Title',
            'config' => [
                'type' => 'input',
                'size' => 200,
                'eval' => 'trim',
            ],
        ],
    ],
];

```

--------------------------------

### Using recordAs with Render.contentArea

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/ContentArea.rst

Demonstrates how to use the `recordAs` argument of `<f:render.contentArea>` in conjunction with `<f:render.record>` to wrap individual content elements.

```APIDOC
## Using `recordAs` with `<f:render.contentArea>`

### Description

This example shows how to use the `recordAs` argument with the `<f:render.contentArea>` ViewHelper. It allows you to iterate over content elements and apply custom wrappers or further rendering using `<f:render.record>`.

### Method

Fluid ViewHelper

### Endpoint

N/A (Client-side rendering)

### Parameters

#### Path Parameters

N/A

#### Query Parameters

N/A

#### Request Body

N/A

### Request Example

```html
<div id="sidebar">
    <f:render.contentArea contentArea="{content.left}" recordAs="record">
        <div id="sidebarItem{record.uid}">
            <f:render.record record="{record}" />
        </div>
    </f:render.contentArea>
</div>
```

### Response

#### Success Response (200)

Content elements from the specified area, each wrapped according to the provided `recordAs` logic.

#### Response Example

(HTML output with wrapped content elements)

```

--------------------------------

### Example: Textarea bound to model property

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Textarea.rst

Demonstrates binding a textarea to a model property, requiring corresponding Fluid, Controller, Model, and TCA configurations.

```APIDOC
## Property Binding: Textarea Bound to Model Property

### Description
This example shows how to bind a `<f:form.textarea>` ViewHelper to a property of an Extbase model. This requires the surrounding form to be configured with an `object` and the corresponding TCA to define the database field type appropriately for potentially long text content.

### Method
Not applicable (ViewHelper/Controller Action/Model)

### Endpoint
Not applicable (ViewHelper/Controller Action/Model)

### Parameters
See general `<f:form.textarea>` ViewHelper arguments, particularly `property` and `object`.

### Request Example

#### Fluid Template (`_codesnippets/_CommentForm.html`)
```html
<f:form action="createComment" name="newComment" object="{newComment}" method="post">
    <f:if condition="{blogPost}">
        <f:form.hidden property="blogPost" value="{blogPost.uid}" />
    </f:if>
    <label for="comment">
        <f:translate key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:comment.comment.label" />
    </label>
    <f:form.textarea property="comment" cols="40" rows="10" />
    <f:form.button type="submit"><f:translate key="LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:comment.submit" /></f:form.button>
</f:form>
```

#### Controller Action (`_codesnippets/_CommentController.php`)
```php
<?php

namespace MyVendor\MyExtension\Controller;

use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
use MyVendor\MyExtension\Domain\Model\Comment;
use MyVendor\MyExtension\Domain\Repository\CommentRepository;
use TYPO3\CMS\Extbase\Persistence\Exception

class CommentController extends ActionController
{
    /**
     * @var CommentRepository
     */
    protected $commentRepository;

    /**
     * @param CommentRepository $commentRepository
     */
    public function injectCommentRepository(CommentRepository $commentRepository):
    {
        $this->commentRepository = $commentRepository;
    }

    /**
     * @param Comment $newComment
     * @return void
     */
    public function createCommentAction(Comment $newComment):
    {
        try {
            $this->commentRepository->add($newComment);
            $this->addFlashMessage('Comment created successfully!');
        } catch (Exception $e) {
            $this->addFlashMessage('Error creating comment: ' . $e->getMessage(), 1, 2);
        }
        $this->redirect('show', null, null, ['blogPost' => $newComment->getBlogPost()]);
    }
}
```

#### Model (`_codesnippets/_Comment.php`)
```php
<?php

namespace MyVendor\MyExtension\Domain\Model;

class Comment extends 	ypo3\CMS\Extbase\DomainObject\AbstractEntity
{
    /**
     * @var string
     */
    protected $comment = '';

    /**
     * @var 	ypo3\CMS\Extbase\DomainObjects\ObjectStorage<MyVendor\MyExtension\Domain\Model\BlogPost>
     */
    protected $blogPost;

    /**
     * @return string
     */
    public function getComment(): string
    {
        return $this->comment;
    }

    /**
     * @param string $comment
     * @return void
     */
    public function setComment(string $comment):
    {
        $this->comment = $comment;
    }

    /**
     * @return 	ypo3\CMS\Extbase\DomainObjects\ObjectStorage<MyVendor\MyExtension\Domain\Model\BlogPost>
     */
    public function getBlogPost(): 	ypo3\CMS\Extbase\DomainObjects\ObjectStorage<MyVendor\MyExtension\Domain\Model\BlogPost>
    {
        return $this->blogPost;
    }

    /**
     * @param 	ypo3\CMS\Extbase\DomainObjects\ObjectStorage<MyVendor\MyExtension\Domain\Model\BlogPost> $blogPost
     * @return void
     */
    public function setBlogPost(	ypo3\CMS\Extbase\DomainObjects\ObjectStorage $blogPost):
    {
        $this->blogPost = $blogPost;
    }
}
```

#### TCA Configuration (`_codesnippets/_comment_tca.php`)
```php
<?php

return [
    'ctrl' => [
        'title' => 'LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:tx_myextension_domain_model_comment',
        'label' => 'comment',
        'tstamp' => 'tstamp',
        'crdate' => 'crdate',
        'cruser_id' => 'cruser_id',
        'versioningWS' => true,
        'languageField' => 'sys_language_uid',
        'transOrigPointerField' => 'l10n_parent',
        'transOrigDiffSourceField' => 'l10n_source',
        // ... other ctrl properties
    ],
    'interface' => [
        'showRecordFieldList' => 'sys_language_uid, l10n_parent, l10n_state, l10n_source, comment, blog_post',
    ],
    'types' => [
        '1' => [
            'showitem' => 'sys_language_uid, l10n_parent, l10n_state, l10n_source, comment, blog_post, --div--;LLL:EXT:core/Resources/Private/Language/Form/general.xlf:advanced,
            // ... other showitem properties
        ],
    ],
    'columns' => [
        'sys_language_uid' => [
            'exclude' => true,
            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.language',
            'config' => [
                'type' => 'language',
            ],
        ],
        'l10n_parent' => [
            'displayCond' => 'FIELD:sys_language_uid:!=0',
            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.l10n_parent',
            'config' => [
                'type' => 'select',
                'renderType' => 'selectSingle',
                'items' => [
                    ['', '']
                ],
                'foreign_table' => 'tx_myextension_domain_model_comment',
                'foreign_label' => 'comment',
                'foreign_sortby' => 'title',
                'default' => 0,
            ],
        ],
        'l10n_state' => [
            'exclude' => true,
            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.l10n_state',
            'config' => [
                'type' => 'check',
                'items' => [
                    ['', '::TRUE']
                ],
                'default' => 0,
            ],
        ],
        'l10n_source' => [
            'config' => [
                'type' => 'passthrough',
            ],
        ],
        'comment' => [
            'label' => 'LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:tx_myextension_domain_model_comment.comment',
            'config' => [
                'type' => 'text',
                'cols' => 40,
                'rows' => 10,
                'enableRichtext' => true, // Or false, depending on desired RTE behavior
            ],
        ],
        'blog_post' => [
            'label' => 'LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:tx_myextension_domain_model_comment.blog_post',
            'config' => [
                'type' => 'select',
                'renderType' => 'selectSingle',
                'foreign_table' => 'tx_myextension_domain_model_blogpost', // Assuming a BlogPost model exists
                'foreign_label' => 'title', // Assuming a 'title' field in BlogPost
                'maxitems' => 1,
                'appearance' => [
                    'collapseAll' => 0,
                    'expandSingle' => 1,
                ],
                'default' => 0,
            ],
        ],
    ],
];
```

### Response

#### Success Response (200)
Upon successful submission, the comment is added to the database, and the user is typically redirected.

#### Response Example
(Redirect to blog post view or display flash message)
```

--------------------------------

### Basic Be.security.ifAuthenticated Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Be/Security/IfAuthenticated.rst

Use this ViewHelper to conditionally display content when a backend user is logged in. No specific setup is required beyond including the ViewHelper.

```html
<f:be.security.ifAuthenticated>
   This is being shown whenever a BE user is logged in
</f:be.security.ifAuthenticated>
```

--------------------------------

### Format Localized Date with strftime

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Format/Date.rst

Format a date using strftime patterns for localized output, such as 'day. Month year'. The example shows a German locale.

```fluid
<f:format.date format="%d. %B %Y">{dateObject}</f:format.date>
```

--------------------------------

### Render.contentArea ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/ContentArea.rst

Demonstrates the basic usage of the `<f:render.contentArea>` ViewHelper to render content from a backend layout column, including inline syntax.

```APIDOC
## `<f:render.contentArea>` ViewHelper

### Description

This ViewHelper renders a content area provided by the page-content data processor. It is commonly used with the PAGEVIEW TypoScript content object and is the recommended way to render content areas in TYPO3 v14.2 and later.

### Method

Fluid ViewHelper

### Endpoint

N/A (Client-side rendering)

### Parameters

#### Path Parameters

N/A

#### Query Parameters

N/A

#### Request Body

N/A

### Request Example

**Standard Syntax:**
```html
<f:render.contentArea contentArea="{content.main}"/>
```

**Inline Syntax:**
```html
{content.main -> f:render.contentArea()}
```

### Response

#### Success Response (200)

Content elements rendered from the specified content area.

#### Response Example

(HTML output of rendered content elements)

```

--------------------------------

### Uri.resource with EXT: syntax

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Uri/Resource.rst

Use this syntax to specify resources from any extension, ensuring compatibility across different TYPO3 contexts. It requires the full EXT: path.

```html
<link href="{f:uri.resource(path:'EXT:indexed_search/Resources/Public/Css/Stylesheet.css')}" rel="stylesheet" />
```

--------------------------------

### Controller Action for Single Submit Button

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Submit.rst

This is an example of a controller action that can handle the form submission triggered by the `<f:form.submit>` ViewHelper. It expects a 'comment' argument.

```php
<?php

namespace MyVendor\MyExtension\Controller;

use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

class CommentController extends ActionController
{
    /**
     * @param array<string, mixed> $comment
     */
    public function createAction(array $comment):
    {
        // ...
    }
}

```

--------------------------------

### Switch ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Switch.rst

Demonstrates how to use the `<f:switch>` ViewHelper to conditionally render content based on a variable's value.

```APIDOC
## Switch ViewHelper `<f:switch>`

### Description
The `<f:switch>` ViewHelper allows you to render different content based on the value of an expression. It works by comparing the value of the `value` attribute against the `case` attributes of its child `<f:case>` elements. If a match is found, the content within that `<f:case>` is rendered. If no match is found, the content within the `<f:default>` element is rendered, if present.

### Method
This is a ViewHelper, not a direct API endpoint. It is used within Fluid templates.

### Endpoint
N/A (Used in Fluid templates)

### Parameters

#### Child Elements

- **`case`**: Represents a specific value to match against. The content within this tag is rendered if the `value` attribute matches this `case`.
- **`default`**: Represents the fallback content to render if no `case` matches the `value` attribute.

### Request Example

```html
<f:switch value="{myVariable}">
    <f:case value="1">Content for value 1</f:case>
    <f:case value="2">Content for value 2</f:case>
    <f:default>Default content</f:default>
</f:switch>
```

### Response

The response is the rendered HTML content based on the matching case or the default case.
```

--------------------------------

### Form.upload ViewHelper Usage

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Form/Upload.rst

Demonstrates how to use the `<f:form.upload>` ViewHelper for basic file uploads and with the `accept` attribute for specifying allowed file types.

```APIDOC
## POST /api/upload

### Description

This section describes the usage of the `<f:form.upload>` ViewHelper to create file input fields within TYPO3 Fluid forms. It covers basic implementation and advanced usage with the `accept` attribute for client-side file type validation.

### Method

N/A (This is a ViewHelper, not a direct API endpoint)

### Endpoint

N/A

### Parameters

#### Path Parameters

N/A

#### Query Parameters

N/A

#### Request Body

N/A

### Request Example

**Basic Usage:**
```html
<f:form.upload name="file" />
```

**With `accept` attribute:**
```html
<f:form.upload name="file" accept=".gif,.jpg,image/jpg,image/jpeg,image/gif" />
```

### Response

#### Success Response (200)

**HTML Output (Basic Usage):**
```html
<input type="file" name="file" />
```

**HTML Output (With `accept` attribute):**
```html
<input type="file" name="file" accept=".gif,.jpg,image/jpg,image/jpeg,image/gif" />
```

### Hint

The `accept` attribute is a native HTML5 attribute and does not provide server-side validation. Proper server-side validation using `
\TYPO3\CMS\Core\Http\UploadedFile` or Extbase file-upload handling is still required.
```

--------------------------------

### f:startsWith ViewHelper

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/StartsWith.rst

The `f:startsWith` ViewHelper checks if a string begins with a given substring. It returns true if the string starts with the substring, and false otherwise.

```APIDOC
## f:startsWith ViewHelper

### Description

Checks if a string starts with a specified substring.

### Method

Not applicable (ViewHelper)

### Endpoint

Not applicable (ViewHelper)

### Parameters

#### Arguments

- **haystack** (string) - Required - The string to check.
- **needle** (string) - Required - The substring to look for at the beginning of the haystack.

### Request Example

```html
<f:startsWith arguments="{haystack: 'Hello World', needle: 'Hello'}" />
```

### Response

#### Success Response (Boolean)

- **result** (boolean) - Returns `true` if the string starts with the needle, `false` otherwise.

#### Response Example

```json
{
  "result": true
}
```

```json
{
  "result": false
}
```
```

--------------------------------

### Import Form ViewHelper Namespace (Fluid)

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Form/_Includes/_Namespace.rst.txt

Import the Form ViewHelper namespace in your Fluid template to use form-related ViewHelpers. This is required if the 'typo3/cms-form' extension is installed.

```fluid
{namespace formvh=TYPO3\CMS\Form\ViewHelpers\}
```

--------------------------------

### TCA configuration for textarea field

Source: https://github.com/typo3-documentation/typo3cms-reference-viewhelper/blob/main/Documentation/Global/Render/Text.rst

This PHP code snippet shows an example of a TCA configuration for a textarea field, which can be used with the f:render.text ViewHelper for multi-line text.

```php
<?php

return [
    'columns' => [
        'tx_mytheme_my_textarea' => [
            'label' => 'My Textarea',
            'config' => [
                'type' => 'text',
                'cols' => 40,
                'rows' => 5,
            ],
        ],
        'tx_mytheme_my_richtext' => [
            'label' => 'My Rich Text',
            'config' => [
                'type' => 'text',
                'enableTab'=> true,
                'richtextConfiguration' => [
                    'enabled' => true,
                    'plaintext' => false,
                    'height' => 300,
                ],
            ],
        ],
    ],
];

```