PHP 클래스 FluidTYPO3\Flux\Provider\AbstractProvider

상속: implements FluidTYPO3\Flux\Provider\ProviderInterface
파일 보기 프로젝트 열기: fluidtypo3/flux 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$configurationSectionName string | null
$configurationService FluidTYPO3\Flux\Service\FluxService
$contentObjectType string Fill with the "CType" value that should trigger this Provider.
$dataStructArray array
$extensionKey string | null
$fieldName string Fill with the table column name which should trigger this Provider.
$form FluidTYPO3\Flux\Form
$grid FluidTYPO3\Flux\Form\Container\Grid
$listType string Fill with the "list_type" value that should trigger this Provider.
$name string
$parentFieldName string
$priority integer
$recordService FluidTYPO3\Flux\Service\WorkspacesAwareRecordService
$row array | null
$tableName string Fill with the name of the DB table which should trigger this Provider.
$templatePathAndFilename string | null
$templatePaths array | null
$templateVariables array
$viewContext FluidTYPO3\Flux\View\ViewContext

공개 메소드들

메소드 설명
clearCacheCommand ( array $command = [] ) : void Perform various cleanup operations upon clearing cache
getConfigurationSectionName ( array $row ) : string | null
getContentObjectType ( ) : string
getControllerActionFromRecord ( array $row ) : string Stub: Get the name of the controller action associated with $row
getControllerActionReferenceFromRecord ( array $row ) : string Stub: Get a compacted controller name + action name string
getControllerExtensionKeyFromRecord ( array $row ) : string Stub: Get the extension key of the controller associated with $row
getControllerNameFromRecord ( array $row ) : string Stub: override this to return a controller action name associated with $row.
getControllerPackageNameFromRecord ( array $row ) : string Stub: Get the package name of the controller associated with $row
getExtensionKey ( array $row ) : string | null
getFieldName ( array $row ) : string | null
getFlexFormValues ( array $row ) : array Converts the contents of the provided row's Flux-enabled field, at the same time running through the inheritance tree generated by getInheritanceTree() in order to apply inherited values.
getForm ( array $row ) : Form | null
getGrid ( array $row ) : FluidTYPO3\Flux\Form\Container\Grid
getListType ( ) : string
getName ( ) : string
getParentFieldName ( array $row ) : string
getPreview ( array $row ) : array Get preview chunks - header and content - as array(string $headerContent, string $previewContent, boolean $continueRendering)
getPriority ( array $row ) : integer
getTableName ( array $row ) : string | null
getTemplatePathAndFilename ( array $row ) : string | null
getTemplatePaths ( array $row ) : array
getTemplateVariables ( array $row ) : array | null
getViewContext ( array $row, TYPO3\CMS\Extbase\Mvc\RequestInterface $request = NULL ) : FluidTYPO3\Flux\View\ViewContext
injectConfigurationService ( FluxService $configurationService ) : void
injectRecordService ( FluidTYPO3\Flux\Service\WorkspacesAwareRecordService $recordService ) : void
loadSettings ( array $settings ) : void
postProcessCommand ( string $command, integer $id, array &$row, integer &$relativeTo, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void Post-process a command executed on a record form the table this ConfigurationProvider is attached to.
postProcessDataStructure ( array &$row, mixed &$dataStructure, array $conf ) : void Post-process the TCEforms DataStructure for a record associated with this ConfigurationProvider
postProcessDatabaseOperation ( string $status, integer $id, array &$row, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void Post-process database operation for the table that this ConfigurationProvider is attached to.
postProcessRecord ( string $operation, integer $id, array &$row, TYPO3\CMS\Core\DataHandling\DataHandler $reference, array $removals = [] ) : void Post-process record data for the table that this ConfigurationProvider is attached to.
preProcessCommand ( string $command, integer $id, array &$row, integer &$relativeTo, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void Pre-process a command executed on a record form the table this ConfigurationProvider is attached to.
preProcessRecord ( array &$row, integer $id, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void Pre-process record data for the table that this ConfigurationProvider is attached to.
processTableConfiguration ( array $row, array $configuration ) : array Processes the table configuration (TCA) for the table associated with this Provider, as determined by the trigger() method. Gets passed an instance of the record being edited/created along with the current configuration array - and must return a complete copy of the configuration array manipulated to the Provider's needs.
reset ( ) : void
setConfigurationSectionName ( string | null $configurationSectionName ) : void
setContentObjectType ( string $contentObjectType )
setExtensionKey ( string $extensionKey ) : void
setFieldName ( string $fieldName ) : void
setForm ( Form $form )
setGrid ( FluidTYPO3\Flux\Form\Container\Grid $grid )
setListType ( string $listType )
setName ( string $name )
setTableName ( string $tableName ) : void
setTemplatePathAndFilename ( string $templatePathAndFilename ) : void
setTemplatePaths ( array | null $templatePaths ) : void
setTemplateVariables ( array | null $templateVariables ) : void
setViewContext ( FluidTYPO3\Flux\View\ViewContext $viewContext ) : void
shouldCall ( string $methodName, mixed $id, string $command = '' ) : boolean Use by TceMain to track method calls to providers for a certain $id.
trackMethodCall ( string $methodName, mixed $id, $command = '' ) : void Use by TceMain to track method calls to providers for a certain $id.
trigger ( array $row, string $table, string $field, string $extensionKey = NULL ) : boolean

보호된 메소드들

메소드 설명
getCacheKeyForStoredVariable ( array $row, string $variable ) : string
getCurrentLanguageName ( ) : string | null Gets the current language name as string, in a format that is compatible with language pointers in a flexform. Usually this implies values like "en", "de" etc.
getCurrentValuePointerName ( ) : string | null Gets the pointer name to use whne retrieving values from a flexform source. Return NULL when pointer is default.
getPageValues ( ) : array Returns the page record with localisation applied, if any exists in database. Maintains uid and pid of the original page if localisation is applied.
getPreviewView ( ) : PreviewView
getViewVariables ( array $row ) : array
loadRecordFromDatabase ( integer $uid ) : array | null
resolveFormClassName ( array $row ) : string If not-NULL is returned, the value is used as object class name when creating a Form implementation instance which can be returned as form instead of reading from template or overriding the getForm() method.
shouldCallWithClassName ( string $className, string $methodName, mixed $id, string $command = '' ) : boolean Internal method. See shouldCall.
trackMethodCallWithClassName ( string $className, string $methodName, mixed $id, string $command = '' ) : void Internal method. See trackMethodCall.

메소드 상세

clearCacheCommand() 공개 메소드

Perform various cleanup operations upon clearing cache
public clearCacheCommand ( array $command = [] ) : void
$command array
리턴 void

getCacheKeyForStoredVariable() 보호된 메소드

protected getCacheKeyForStoredVariable ( array $row, string $variable ) : string
$row array
$variable string
리턴 string

getConfigurationSectionName() 공개 메소드

public getConfigurationSectionName ( array $row ) : string | null
$row array
리턴 string | null

getContentObjectType() 공개 메소드

public getContentObjectType ( ) : string
리턴 string

getControllerActionFromRecord() 공개 메소드

Stub: Get the name of the controller action associated with $row
public getControllerActionFromRecord ( array $row ) : string
$row array
리턴 string

getControllerActionReferenceFromRecord() 공개 메소드

Stub: Get a compacted controller name + action name string

getControllerExtensionKeyFromRecord() 공개 메소드

Stub: Get the extension key of the controller associated with $row

getControllerNameFromRecord() 공개 메소드

Default strategy: return base name of Provider class minus the "Provider" suffix.
public getControllerNameFromRecord ( array $row ) : string
$row array
리턴 string

getControllerPackageNameFromRecord() 공개 메소드

Stub: Get the package name of the controller associated with $row

getCurrentLanguageName() 보호된 메소드

Return NULL when language is site default language.
protected getCurrentLanguageName ( ) : string | null
리턴 string | null

getCurrentValuePointerName() 보호된 메소드

Gets the pointer name to use whne retrieving values from a flexform source. Return NULL when pointer is default.
protected getCurrentValuePointerName ( ) : string | null
리턴 string | null

getExtensionKey() 공개 메소드

public getExtensionKey ( array $row ) : string | null
$row array
리턴 string | null

getFieldName() 공개 메소드

public getFieldName ( array $row ) : string | null
$row array The record row which triggered processing
리턴 string | null

getFlexFormValues() 공개 메소드

Converts the contents of the provided row's Flux-enabled field, at the same time running through the inheritance tree generated by getInheritanceTree() in order to apply inherited values.
public getFlexFormValues ( array $row ) : array
$row array
리턴 array

getForm() 공개 메소드

public getForm ( array $row ) : Form | null
$row array
리턴 FluidTYPO3\Flux\Form | null

getGrid() 공개 메소드

public getGrid ( array $row ) : FluidTYPO3\Flux\Form\Container\Grid
$row array
리턴 FluidTYPO3\Flux\Form\Container\Grid

getListType() 공개 메소드

public getListType ( ) : string
리턴 string

getName() 공개 메소드

public getName ( ) : string
리턴 string

getPageValues() 보호된 메소드

Returns the page record with localisation applied, if any exists in database. Maintains uid and pid of the original page if localisation is applied.
protected getPageValues ( ) : array
리턴 array

getParentFieldName() 공개 메소드

public getParentFieldName ( array $row ) : string
$row array
리턴 string

getPreview() 공개 메소드

Default implementation renders the Preview section from the template file that the actual Provider returns for $row, using paths also determined by $row. Example: fluidcontent's Provider returns files and paths based on selected "Fluid Content type" and inherits and uses this method to render a Preview from the template file in the specific path. This default implementation expects the TYPO3 core to render the default header, so it returns NULL as $headerContent.
public getPreview ( array $row ) : array
$row array The record data to be analysed for variables to use in a rendered preview
리턴 array

getPreviewView() 보호된 메소드

protected getPreviewView ( ) : PreviewView
리턴 FluidTYPO3\Flux\View\PreviewView

getPriority() 공개 메소드

public getPriority ( array $row ) : integer
$row array
리턴 integer

getTableName() 공개 메소드

public getTableName ( array $row ) : string | null
$row array The record row which triggered processing
리턴 string | null

getTemplatePathAndFilename() 공개 메소드

public getTemplatePathAndFilename ( array $row ) : string | null
$row array
리턴 string | null

getTemplatePaths() 공개 메소드

public getTemplatePaths ( array $row ) : array
$row array
리턴 array

getTemplateVariables() 공개 메소드

public getTemplateVariables ( array $row ) : array | null
$row array
리턴 array | null

getViewContext() 공개 메소드

public getViewContext ( array $row, TYPO3\CMS\Extbase\Mvc\RequestInterface $request = NULL ) : FluidTYPO3\Flux\View\ViewContext
$row array
$request TYPO3\CMS\Extbase\Mvc\RequestInterface
리턴 FluidTYPO3\Flux\View\ViewContext

getViewVariables() 보호된 메소드

protected getViewVariables ( array $row ) : array
$row array
리턴 array

injectConfigurationService() 공개 메소드

public injectConfigurationService ( FluxService $configurationService ) : void
$configurationService FluidTYPO3\Flux\Service\FluxService
리턴 void

injectRecordService() 공개 메소드

public injectRecordService ( FluidTYPO3\Flux\Service\WorkspacesAwareRecordService $recordService ) : void
$recordService FluidTYPO3\Flux\Service\WorkspacesAwareRecordService
리턴 void

loadRecordFromDatabase() 보호된 메소드

protected loadRecordFromDatabase ( integer $uid ) : array | null
$uid integer
리턴 array | null

loadSettings() 공개 메소드

public loadSettings ( array $settings ) : void
$settings array
리턴 void

postProcessCommand() 공개 메소드

Post-process a command executed on a record form the table this ConfigurationProvider is attached to.
public postProcessCommand ( string $command, integer $id, array &$row, integer &$relativeTo, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void
$command string
$id integer
$row array
$relativeTo integer
$reference TYPO3\CMS\Core\DataHandling\DataHandler
리턴 void

postProcessDataStructure() 공개 메소드

Post-process the TCEforms DataStructure for a record associated with this ConfigurationProvider
public postProcessDataStructure ( array &$row, mixed &$dataStructure, array $conf ) : void
$row array
$dataStructure mixed
$conf array
리턴 void

postProcessDatabaseOperation() 공개 메소드

Post-process database operation for the table that this ConfigurationProvider is attached to.
public postProcessDatabaseOperation ( string $status, integer $id, array &$row, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void
$status string TYPO3 operation identifier, i.e. "new" etc.
$id integer The ID of the current record (which is sometimes now included in $row
$row array The record's data, by reference. Changing fields' values changes the record's values just before saving after operation
$reference TYPO3\CMS\Core\DataHandling\DataHandler A reference to the \TYPO3\CMS\Core\DataHandling\DataHandler object that is currently performing the database operation
리턴 void

postProcessRecord() 공개 메소드

Post-process record data for the table that this ConfigurationProvider is attached to.
public postProcessRecord ( string $operation, integer $id, array &$row, TYPO3\CMS\Core\DataHandling\DataHandler $reference, array $removals = [] ) : void
$operation string TYPO3 operation identifier, i.e. "update", "new" etc.
$id integer The ID of the current record (which is sometimes now included in $row
$row array the record data, by reference. Changing fields' values changes the record's values just before saving
$reference TYPO3\CMS\Core\DataHandling\DataHandler A reference to the \TYPO3\CMS\Core\DataHandling\DataHandler object that is currently saving the record
$removals array Allows overridden methods to pass an additional array of field names to remove from the stored Flux value
리턴 void

preProcessCommand() 공개 메소드

Pre-process a command executed on a record form the table this ConfigurationProvider is attached to.
public preProcessCommand ( string $command, integer $id, array &$row, integer &$relativeTo, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void
$command string
$id integer
$row array
$relativeTo integer
$reference TYPO3\CMS\Core\DataHandling\DataHandler
리턴 void

preProcessRecord() 공개 메소드

Pre-process record data for the table that this ConfigurationProvider is attached to.
public preProcessRecord ( array &$row, integer $id, TYPO3\CMS\Core\DataHandling\DataHandler $reference ) : void
$row array The record data, by reference. Changing fields' values changes the record's values before display
$id integer The ID of the current record (which is sometimes now included in $row
$reference TYPO3\CMS\Core\DataHandling\DataHandler A reference to the \TYPO3\CMS\Core\DataHandling\DataHandler object that is currently displaying the record
리턴 void

processTableConfiguration() 공개 메소드

Processes the table configuration (TCA) for the table associated with this Provider, as determined by the trigger() method. Gets passed an instance of the record being edited/created along with the current configuration array - and must return a complete copy of the configuration array manipulated to the Provider's needs.
public processTableConfiguration ( array $row, array $configuration ) : array
$row array The record being edited/created
$configuration array
리턴 array The large FormEngine configuration array - see FormEngine documentation!

reset() 공개 메소드

public reset ( ) : void
리턴 void

resolveFormClassName() 보호된 메소드

If not-NULL is returned, the value is used as object class name when creating a Form implementation instance which can be returned as form instead of reading from template or overriding the getForm() method.
protected resolveFormClassName ( array $row ) : string
$row array
리턴 string

setConfigurationSectionName() 공개 메소드

public setConfigurationSectionName ( string | null $configurationSectionName ) : void
$configurationSectionName string | null
리턴 void

setContentObjectType() 공개 메소드

public setContentObjectType ( string $contentObjectType )
$contentObjectType string

setExtensionKey() 공개 메소드

public setExtensionKey ( string $extensionKey ) : void
$extensionKey string
리턴 void

setFieldName() 공개 메소드

public setFieldName ( string $fieldName ) : void
$fieldName string
리턴 void

setForm() 공개 메소드

public setForm ( Form $form )
$form FluidTYPO3\Flux\Form

setGrid() 공개 메소드

public setGrid ( FluidTYPO3\Flux\Form\Container\Grid $grid )
$grid FluidTYPO3\Flux\Form\Container\Grid

setListType() 공개 메소드

public setListType ( string $listType )
$listType string

setName() 공개 메소드

public setName ( string $name )
$name string

setTableName() 공개 메소드

public setTableName ( string $tableName ) : void
$tableName string
리턴 void

setTemplatePathAndFilename() 공개 메소드

public setTemplatePathAndFilename ( string $templatePathAndFilename ) : void
$templatePathAndFilename string
리턴 void

setTemplatePaths() 공개 메소드

public setTemplatePaths ( array | null $templatePaths ) : void
$templatePaths array | null
리턴 void

setTemplateVariables() 공개 메소드

public setTemplateVariables ( array | null $templateVariables ) : void
$templateVariables array | null
리턴 void

setViewContext() 공개 메소드

public setViewContext ( FluidTYPO3\Flux\View\ViewContext $viewContext ) : void
$viewContext FluidTYPO3\Flux\View\ViewContext
리턴 void

shouldCall() 공개 메소드

Every provider should only be called once per method / $id. Before calling a provider, TceMain will call this method. If the provider hasn't been called for that method / $id before, it is.
public shouldCall ( string $methodName, mixed $id, string $command = '' ) : boolean
$methodName string
$id mixed
$command string
리턴 boolean

shouldCallWithClassName() 보호된 메소드

This is used by flux own provider to make sure on inheritance they are still only executed once.
protected shouldCallWithClassName ( string $className, string $methodName, mixed $id, string $command = '' ) : boolean
$className string
$methodName string
$id mixed
$command string
리턴 boolean

trackMethodCall() 공개 메소드

Every provider should only be called once per method / $id / command. When TceMain has called the provider it will call this method afterwards.
public trackMethodCall ( string $methodName, mixed $id, $command = '' ) : void
$methodName string
$id mixed
리턴 void

trackMethodCallWithClassName() 보호된 메소드

This is used by flux own provider to make sure on inheritance they are still only executed once.
protected trackMethodCallWithClassName ( string $className, string $methodName, mixed $id, string $command = '' ) : void
$className string
$methodName string
$id mixed
$command string
리턴 void

trigger() 공개 메소드

public trigger ( array $row, string $table, string $field, string $extensionKey = NULL ) : boolean
$row array
$table string
$field string
$extensionKey string
리턴 boolean

프로퍼티 상세

$configurationSectionName 보호되어 있는 프로퍼티

protected string|NULL $configurationSectionName
리턴 string | null

$configurationService 보호되어 있는 프로퍼티

protected FluxService,FluidTYPO3\Flux\Service $configurationService
리턴 FluidTYPO3\Flux\Service\FluxService

$contentObjectType 보호되어 있는 프로퍼티

Fill with the "CType" value that should trigger this Provider.
protected string $contentObjectType
리턴 string

$dataStructArray 보호되어 있는 프로퍼티

protected array $dataStructArray
리턴 array

$extensionKey 보호되어 있는 프로퍼티

protected string|NULL $extensionKey
리턴 string | null

$fieldName 보호되어 있는 프로퍼티

Fill with the table column name which should trigger this Provider.
protected string $fieldName
리턴 string

$form 보호되어 있는 프로퍼티

protected Form,FluidTYPO3\Flux $form
리턴 FluidTYPO3\Flux\Form

$grid 보호되어 있는 프로퍼티

protected Grid,FluidTYPO3\Flux\Form\Container $grid
리턴 FluidTYPO3\Flux\Form\Container\Grid

$listType 보호되어 있는 프로퍼티

Fill with the "list_type" value that should trigger this Provider.
protected string $listType
리턴 string

$name 보호되어 있는 프로퍼티

protected string $name
리턴 string

$parentFieldName 보호되어 있는 프로퍼티

protected string $parentFieldName
리턴 string

$priority 보호되어 있는 프로퍼티

protected int $priority
리턴 integer

$recordService 보호되어 있는 프로퍼티

protected WorkspacesAwareRecordService,FluidTYPO3\Flux\Service $recordService
리턴 FluidTYPO3\Flux\Service\WorkspacesAwareRecordService

$row 보호되어 있는 프로퍼티

protected array|NULL $row
리턴 array | null

$tableName 보호되어 있는 프로퍼티

Fill with the name of the DB table which should trigger this Provider.
protected string $tableName
리턴 string

$templatePathAndFilename 보호되어 있는 프로퍼티

protected string|NULL $templatePathAndFilename
리턴 string | null

$templatePaths 보호되어 있는 프로퍼티

protected array|NULL $templatePaths
리턴 array | null

$templateVariables 보호되어 있는 프로퍼티

protected array $templateVariables
리턴 array

$viewContext 보호되어 있는 프로퍼티

protected ViewContext,FluidTYPO3\Flux\View $viewContext
리턴 FluidTYPO3\Flux\View\ViewContext