PHP Class FluidTYPO3\Flux\Core

Quick-access API methods to easily integrate with Flux
Show file Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Property Type Description
$outlets array
$pipes array

Public Methods

Method Description
addStaticTypoScript ( mixed $locationOrLocations ) : void
getOutlets ( ) : array
getPipes ( ) : array
getRegisteredFlexFormProviders ( ) : array Gets the defined FlexForms configuration providers based on parameters
getRegisteredFormForModelObjectClass ( string $class ) : Form | null
getRegisteredFormForTable ( string $table ) : Form | null
getRegisteredFormsForModelObjectClasses ( ) : Form[]
getRegisteredFormsForTables ( ) : Form[]
getRegisteredPackagesForAutoForms ( ) : Form[]
getRegisteredProviderExtensionKeys ( string $forControllerName ) : array
getStaticTypoScript ( ) : array
registerAutoFormForModelObjectClassName ( string $className ) : void Registers automatic Form instance building and use as TCA for a model object class/table.
registerConfigurationProvider ( string | object $classNameOrInstance ) : void Registers a class implementing one of the Flux ConfigurationProvider interfaces.
registerFluidFlexFormContentObject ( mixed $extensionKey, mixed $contentObjectType, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL, string $fieldName = 'pi_flexform' ) : void Same as registerFluidFlexFormPlugin, but uses a content object type for resolution - use this if you registered your Extbase plugin as a content object in your localconf.
registerFluidFlexFormPlugin ( mixed $extensionKey, mixed $pluginSignature, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL, string $fieldName = 'pi_flexform' ) : void Registers a Fluid template for use as a Dynamic Flex Form template in the style of Flux's Fluid Content Element and Fluid Page configurations. See documentation web site for more detailed information about how to configure such a FlexForm template.
registerFluidFlexFormTable ( mixed $table, mixed $fieldName, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL ) : void Same as registerFluidFlexFormPlugin, but enables registering FlexForms for any TCA field (type "flex") or field whose TCA you have overridden to display as a FlexForm.
registerFluxDomainFormPackage ( string $packageName ) : void Registers a package key (Vendor.ExtensionName) which is expected to contain Domain/Form/{$modelName}Form classes.
registerFormForModelObjectClassName ( string $className, Form $form = NULL ) : void Registers a Form instance to use when TCA for a model object class/table is requested.
registerFormForTable ( string $table, Form $form ) : void
registerOutlet ( string $typeOrClassName, string $insteadOfNativeType = NULL ) : void
registerPipe ( string $typeOrClassName, string $insteadOfNativeType = NULL ) : void
registerProviderExtensionKey ( string $extensionKey, string $providesControllerName = self::CONTROLLER_ALL ) : void
unregisterConfigurationProvider ( string $providerClassName ) : void
unregisterFluxDomainFormPackage ( string $packageName ) : void
unregisterFormForModelObjectClassName ( string $className ) : void
unregisterOutlet ( string $typeOrClassName )
unregisterPipe ( string $typeOrClassName )

Method Details

addStaticTypoScript() public static method

public static addStaticTypoScript ( mixed $locationOrLocations ) : void
$locationOrLocations mixed
return void

getOutlets() public static method

public static getOutlets ( ) : array
return array

getPipes() public static method

public static getPipes ( ) : array
return array

getRegisteredFlexFormProviders() public static method

Gets the defined FlexForms configuration providers based on parameters
public static getRegisteredFlexFormProviders ( ) : array
return array

getRegisteredFormForModelObjectClass() public static method

public static getRegisteredFormForModelObjectClass ( string $class ) : Form | null
$class string
return Form | null

getRegisteredFormForTable() public static method

public static getRegisteredFormForTable ( string $table ) : Form | null
$table string
return Form | null

getRegisteredFormsForModelObjectClasses() public static method

public static getRegisteredFormsForModelObjectClasses ( ) : Form[]
return Form[]

getRegisteredFormsForTables() public static method

public static getRegisteredFormsForTables ( ) : Form[]
return Form[]

getRegisteredPackagesForAutoForms() public static method

public static getRegisteredPackagesForAutoForms ( ) : Form[]
return Form[]

getRegisteredProviderExtensionKeys() public static method

public static getRegisteredProviderExtensionKeys ( string $forControllerName ) : array
$forControllerName string
return array

getStaticTypoScript() public static method

public static getStaticTypoScript ( ) : array
return array

registerAutoFormForModelObjectClassName() public static method

Registers automatic Form instance building and use as TCA for a model object class/table.
public static registerAutoFormForModelObjectClassName ( string $className ) : void
$className string
return void

registerConfigurationProvider() public static method

Registers a class implementing one of the Flux ConfigurationProvider interfaces.
public static registerConfigurationProvider ( string | object $classNameOrInstance ) : void
$classNameOrInstance string | object
return void

registerFluidFlexFormContentObject() public static method

Same as registerFluidFlexFormPlugin, but uses a content object type for resolution - use this if you registered your Extbase plugin as a content object in your localconf.
public static registerFluidFlexFormContentObject ( mixed $extensionKey, mixed $contentObjectType, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL, string $fieldName = 'pi_flexform' ) : void
$extensionKey mixed The extension key which registered this FlexForm
$contentObjectType mixed The cType of the object you registered
$templateFilename mixed Location of the Fluid template containing field definitions
$variables mixed Optional array of variables to pass to Fluid template
$fieldName string Optional fieldname if not from pi_flexform
return void

registerFluidFlexFormPlugin() public static method

Note: you can point to your Model Object templates and place the configuration in these templates - and get automatically transformed values from your FlexForms, i.e. a Domain Object instance from a "group" type select box or an ObjectStorage from a list of records. Usual output is completely ignored, only the "Configuration" section is considered.
public static registerFluidFlexFormPlugin ( mixed $extensionKey, mixed $pluginSignature, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL, string $fieldName = 'pi_flexform' ) : void
$extensionKey mixed The extension key which registered this FlexForm
$pluginSignature mixed The plugin signature this FlexForm belongs to
$templateFilename mixed Location of the Fluid template containing field definitions
$variables mixed Optional array of variables to pass to Fluid template
$fieldName string Optional fieldname if not from pi_flexform
return void

registerFluidFlexFormTable() public static method

Same as registerFluidFlexFormPlugin, but enables registering FlexForms for any TCA field (type "flex") or field whose TCA you have overridden to display as a FlexForm.
public static registerFluidFlexFormTable ( mixed $table, mixed $fieldName, mixed $templateFilename, mixed $variables = [], $section = NULL, $paths = NULL ) : void
$table mixed The SQL table this FlexForm is bound to
$fieldName mixed The SQL field this FlexForm is bound to
$templateFilename mixed Location of the Fluid template containing field definitions
$variables mixed Optional array of variables to pass to Fluid template
return void

registerFluxDomainFormPackage() public static method

Registers a package key (Vendor.ExtensionName) which is expected to contain Domain/Form/{$modelName}Form classes.
public static registerFluxDomainFormPackage ( string $packageName ) : void
$packageName string
return void

registerFormForModelObjectClassName() public static method

Registers a Form instance to use when TCA for a model object class/table is requested.
public static registerFormForModelObjectClassName ( string $className, Form $form = NULL ) : void
$className string
$form Form
return void

registerFormForTable() public static method

public static registerFormForTable ( string $table, Form $form ) : void
$table string
$form Form
return void

registerOutlet() public static method

public static registerOutlet ( string $typeOrClassName, string $insteadOfNativeType = NULL ) : void
$typeOrClassName string
$insteadOfNativeType string
return void

registerPipe() public static method

public static registerPipe ( string $typeOrClassName, string $insteadOfNativeType = NULL ) : void
$typeOrClassName string
$insteadOfNativeType string
return void

registerProviderExtensionKey() public static method

public static registerProviderExtensionKey ( string $extensionKey, string $providesControllerName = self::CONTROLLER_ALL ) : void
$extensionKey string
$providesControllerName string
return void

unregisterConfigurationProvider() public static method

public static unregisterConfigurationProvider ( string $providerClassName ) : void
$providerClassName string
return void

unregisterFluxDomainFormPackage() public static method

public static unregisterFluxDomainFormPackage ( string $packageName ) : void
$packageName string
return void

unregisterFormForModelObjectClassName() public static method

public static unregisterFormForModelObjectClassName ( string $className ) : void
$className string
return void

unregisterOutlet() public static method

public static unregisterOutlet ( string $typeOrClassName )
$typeOrClassName string

unregisterPipe() public static method

public static unregisterPipe ( string $typeOrClassName )
$typeOrClassName string

Property Details

$outlets protected static property

protected static array $outlets
return array

$pipes protected static property

protected static array $pipes
return array