TYPO3\CMS\Form\Mvc\Configuration\YamlSource Class Reference

Public Member Functions
	injectFilePersistenceSlot (FilePersistenceSlot $filePersistenceSlot)
	load (array $filesToLoad)
	save ($fileToSave, array $configuration)

Protected Member Functions
	loadFromFilePath (string $filePath)
	loadFromFile (File $file)
string	getHeaderFromFile ($file)
	buildCombinedIdentifier (FolderInterface $folder, string $fileName)

Protected Attributes
FilePersistenceSlot	$filePersistenceSlot

Detailed Description

Configuration source based on YAML files

Scope: frontend / backend

Definition at line 43 of file YamlSource.php.

Member Function Documentation

buildCombinedIdentifier()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::buildCombinedIdentifier ( FolderInterface  $folder, string  $fileName  )

protected

Definition at line 211 of file YamlSource.php.

References TYPO3\CMS\Core\Resource\ResourceInterface\getIdentifier(), and TYPO3\CMS\Core\Resource\ResourceInterface\getStorage().

Referenced by TYPO3\CMS\Form\Mvc\Configuration\YamlSource\save().

getHeaderFromFile()

string TYPO3\CMS\Form\Mvc\Configuration\YamlSource::getHeaderFromFile (   $file )

protected

Read the header part from the given file. That means, every line until the first non comment line is found.

Parameters

File | string

$file

Returns

‪string The header of the given YAML file

Definition at line 190 of file YamlSource.php.

Referenced by TYPO3\CMS\Form\Mvc\Configuration\YamlSource\save().

injectFilePersistenceSlot()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::injectFilePersistenceSlot

(

FilePersistenceSlot

$filePersistenceSlot

)

Definition at line 49 of file YamlSource.php.

References TYPO3\CMS\Form\Mvc\Configuration\YamlSource\$filePersistenceSlot.

load()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::load

(

array

$filesToLoad

)

Loads the specified configuration files and returns its merged content as an array.

Definition at line 60 of file YamlSource.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\convertBooleanStringsToBooleanRecursive(), TYPO3\CMS\Form\Mvc\Configuration\YamlSource\loadFromFile(), and TYPO3\CMS\Form\Mvc\Configuration\YamlSource\loadFromFilePath().

loadFromFile()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::loadFromFile ( File  $file )

protected

Load YAML configuration from a FAL file

Exceptions

ParseErrorException
NoSuchFileException

Definition at line 158 of file YamlSource.php.

References TYPO3\CMS\Core\Resource\File\getContents(), and TYPO3\CMS\Core\Resource\AbstractFile\getIdentifier().

Referenced by TYPO3\CMS\Form\Mvc\Configuration\YamlSource\load().

loadFromFilePath()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::loadFromFilePath ( string  $filePath )

protected

Load YAML configuration from a local file path

Exceptions

ParseErrorException

Definition at line 135 of file YamlSource.php.

Referenced by TYPO3\CMS\Form\Mvc\Configuration\YamlSource\load().

save()

TYPO3\CMS\Form\Mvc\Configuration\YamlSource::save	(		$fileToSave,
		array	$configuration
	)

Save the specified configuration array to the given file in YAML format.

Parameters

File | string	$fileToSave	‪The file to write to.
array	$configuration	‪The configuration to save

Exceptions

FileWriteException

‪if the file could not be written

Definition at line 94 of file YamlSource.php.

References TYPO3\CMS\Form\Mvc\Configuration\YamlSource\buildCombinedIdentifier(), TYPO3\CMS\Form\Slot\FilePersistenceSlot\COMMAND_FILE_SET_CONTENTS, and TYPO3\CMS\Form\Mvc\Configuration\YamlSource\getHeaderFromFile().

Member Data Documentation

$filePersistenceSlot

FilePersistenceSlot TYPO3\CMS\Form\Mvc\Configuration\YamlSource::$filePersistenceSlot

protected

Definition at line 47 of file YamlSource.php.

Referenced by TYPO3\CMS\Form\Mvc\Configuration\YamlSource\injectFilePersistenceSlot().