‪TYPO3CMS  ‪main
TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture Class Reference
Inheritance diagram for TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture:
TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher TYPO3\CMS\Form\Domain\Finishers\FinisherInterface

Public Member Functions

 parseOption (string $optionName)
 
 substituteRuntimeReferences ($needle, FormRuntime $formRuntime)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
 setFinisherIdentifier (string $finisherIdentifier)
 
 getFinisherIdentifier ()
 
 setOptions (array $options)
 
 setOption (string $optionName, $optionValue)
 
string null execute (FinisherContext $finisherContext)
 
 isEnabled ()
 

Public Attributes

 $options = array( )
 
 $defaultOptions = array( )
 
 $finisherContext
 

Protected Member Functions

 executeInternal ()
 
 translateFinisherOption ( $subject, FormRuntime $formRuntime, string $optionName, $optionValue, array $translationOptions)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
int string array resolveRuntimeReference (string $property, FormRuntime $formRuntime)
 
 getTypoScriptFrontendController ()
 

Additional Inherited Members

- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string $finisherIdentifier = ''
 
string $shortFinisherIdentifier = ''
 
array $options = array( )
 
array $defaultOptions = array( )
 
TYPO3 CMS Form Domain Finishers FinisherContext $finisherContext
 

Detailed Description

Definition at line 27 of file AbstractFinisherFixture.php.

Member Function Documentation

◆ executeInternal()

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::executeInternal ( )
protected

This method is called in the concrete finisher whenever self::execute() is called.

Override and fill with your own implementation!

Returns
‪string|void|null

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 33 of file AbstractFinisherFixture.php.

◆ parseOption()

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::parseOption ( string  $optionName)

Read the option called $optionName from $this->options, and parse {...} as object accessors.

Then translate the value.

If $optionName was not found, the corresponding default option is returned (from $this->defaultOptions)

Parameters
string$optionName
Returns
‪string|array|int|null

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 38 of file AbstractFinisherFixture.php.

◆ substituteRuntimeReferences()

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::substituteRuntimeReferences (   $needle,
FormRuntime  $formRuntime 
)

You can encapsulate an option value with {}. This enables you to access every gettable property from the TYPO3\CMS\Form\Domain\Runtime\FormRuntime.

For example: {formState.formValues.<elementIdentifier>} or {<elementIdentifier>}

Both examples are equal to "$formRuntime->getFormState()->getFormValues()[<elementIdentifier>]" There is a special option value '{__currentTimestamp}'. This will be replaced with the current timestamp.

Parameters
string | array$needle
FormRuntime$formRuntime
Returns
‪mixed

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 53 of file AbstractFinisherFixture.php.

◆ translateFinisherOption()

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::translateFinisherOption (   $subject,
FormRuntime  $formRuntime,
string  $optionName,
  $optionValue,
array  $translationOptions 
)
protected

Wraps TranslationService::translateFinisherOption to recursively invoke all array items of resolved form state values or nested finisher option configuration settings.

Parameters
string | array$subject
FormRuntime$formRuntime
string | array$optionValue
Returns
‪array|string

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 43 of file AbstractFinisherFixture.php.

Member Data Documentation

◆ $defaultOptions

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::$defaultOptions = array( )

Definition at line 30 of file AbstractFinisherFixture.php.

◆ $finisherContext

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::$finisherContext

Definition at line 31 of file AbstractFinisherFixture.php.

◆ $options

TYPO3\CMS\Form\Tests\Unit\Domain\Finishers\Fixtures\AbstractFinisherFixture::$options = array( )

Definition at line 29 of file AbstractFinisherFixture.php.