PHP Class fieldSubsectionmanager, subsectionmanager

Inheritance: extends Field
Show file Open project: symphonists/subsectionmanager Class Usage Examples

Public Properties

Property Type Description
$sortOrder

Public Methods

Method Description
__construct ( )
allowDatasourceOutputGrouping ( )
allowDatasourceParamOutput ( )
appendFormattedElement ( &$wrapper, $data, $encode = false, $mode = null ) Subsection entries are pre-processed in the extension driver and stored in extension_subsectionmanager::$storage with other helpful data. If you are building custom data sources, please use extension_subsectionmanager::storeSubsectionFields() to store subsection fields and extension_subsectionmanager::preloadSubsectionEntries() to preload subsection entries.
buildDSRetrievalSQL ( $data, &$joins, &$where, $andOperation = false )
buildDSRetrivalSQL ( $data, &$joins, &$where, $andOperation = false ) Keep compatibility with Symphony pre 2.2.1 for a little longer.
canFilter ( )
checkFields ( &$errors, $checkForDuplicates = true )
checkPostFieldData ( $data, &$message, $entry_id = null )
commit ( )
createSectionAssociation ( $parent_section_id = null, $child_section_id = null, $child_field_id = null, $parent_field_id = null, $show_association = false )
createTable ( )
displayDatasourceFilterPanel ( &$wrapper, $data = null, $errors = null, $fieldnamePrefix = null, $fieldnamePostfix = null )
displayPublishPanel ( &$wrapper, $data = null, $flagWithError = null, $fieldnamePrefix = null, $fieldnamePostfix = null, $entry_id = null ) If you need to fetch the pure data this field returns, please use getDefaultPublishContent()
displaySettingsPanel ( &$wrapper, $errors = null )
fetchAssociatedEntryCount ( $value )
fetchAssociatedEntrySearchValue ( $data, $field_id = null, $parent_entry_id = null )
fetchIncludableElements ( $break = false )
getDefaultPublishContent ( &$wrapper, $data = null ) Get default publish content
getExampleFormMarkup ( )
getParameterPoolValue ( $data )
groupRecords ( $records ) *------------------------------------------------------------------------- Grouping: -------------------------------------------------------------------------
isSortable ( )
prepareImportValue ( mixed $value, integer $entry_id = null ) : array Used by the XML Importer when importing
prepareTableValue ( $data, XMLElement $link = null )
processRawFieldData ( $data, &$status, &$message = null, $simulate = false, $entry_id = null )
requiresSQLGrouping ( ) Test whether this field requires grouping. If this function returns true SQL statements generated in the EntryManager will include the DISTINCT keyword to only return a single row for an entry regardless of how many 'matches' it might have. This default implementation returns false.

Private Methods

Method Description
__groupContentGenerator ( $name, $title, $sections, $errors ) Create caption and droptext settings

Method Details

__construct() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#__construct
public __construct ( )

allowDatasourceOutputGrouping() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#allowDatasourceOutputGrouping

allowDatasourceParamOutput() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#allowDatasourceParamOutput

appendFormattedElement() public method

Subsection entries are pre-processed in the extension driver and stored in extension_subsectionmanager::$storage with other helpful data. If you are building custom data sources, please use extension_subsectionmanager::storeSubsectionFields() to store subsection fields and extension_subsectionmanager::preloadSubsectionEntries() to preload subsection entries.
See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#appendFormattedElement
public appendFormattedElement ( &$wrapper, $data, $encode = false, $mode = null )

buildDSRetrievalSQL() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#buildDSRetrievalSQL
public buildDSRetrievalSQL ( $data, &$joins, &$where, $andOperation = false )

buildDSRetrivalSQL() public method

Keep compatibility with Symphony pre 2.2.1 for a little longer.
See also: http://symphony-cms.com/learn/api/2.2.1/toolkit/field/#buildDSRetrivalSQL
public buildDSRetrivalSQL ( $data, &$joins, &$where, $andOperation = false )

canFilter() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#canFilter
public canFilter ( )

checkFields() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#checkFields
public checkFields ( &$errors, $checkForDuplicates = true )

checkPostFieldData() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#checkPostFieldData
public checkPostFieldData ( $data, &$message, $entry_id = null )

commit() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#commit
public commit ( )

createSectionAssociation() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#createSectionAssociation
public createSectionAssociation ( $parent_section_id = null, $child_section_id = null, $child_field_id = null, $parent_field_id = null, $show_association = false )

createTable() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#createTable
public createTable ( )

displayDatasourceFilterPanel() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#displayDatasourceFilterPanel
public displayDatasourceFilterPanel ( &$wrapper, $data = null, $errors = null, $fieldnamePrefix = null, $fieldnamePostfix = null )

displayPublishPanel() public method

If you need to fetch the pure data this field returns, please use getDefaultPublishContent()
See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#displayPublishPanel
public displayPublishPanel ( &$wrapper, $data = null, $flagWithError = null, $fieldnamePrefix = null, $fieldnamePostfix = null, $entry_id = null )

displaySettingsPanel() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#displaySettingsPanel
public displaySettingsPanel ( &$wrapper, $errors = null )

fetchAssociatedEntryCount() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#fetchAssociatedEntryCount
public fetchAssociatedEntryCount ( $value )

fetchAssociatedEntrySearchValue() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#fetchAssociatedEntrySearchValue `$data` would contain the related entries, but is usually `null` when called from the frontend (when the field is not included in the DS, and only then "associated entry count" makes sense)
public fetchAssociatedEntrySearchValue ( $data, $field_id = null, $parent_entry_id = null )

fetchIncludableElements() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#fetchIncludableElements
public fetchIncludableElements ( $break = false )

getDefaultPublishContent() public method

Get default publish content
public getDefaultPublishContent ( &$wrapper, $data = null )

getExampleFormMarkup() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#getExampleFormMarkup

getParameterPoolValue() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#getParameterPoolValue
public getParameterPoolValue ( $data )

groupRecords() public method

*------------------------------------------------------------------------- Grouping: -------------------------------------------------------------------------
public groupRecords ( $records )

isSortable() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#isSortable
public isSortable ( )

prepareImportValue() public method

Used by the XML Importer when importing
public prepareImportValue ( mixed $value, integer $entry_id = null ) : array
$value mixed
$entry_id integer
return array

prepareTableValue() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#prepareTableValue
public prepareTableValue ( $data, XMLElement $link = null )
$link XMLElement

processRawFieldData() public method

See also: http://symphony-cms.com/learn/api/2.3/toolkit/field/#processRawFieldData
public processRawFieldData ( $data, &$status, &$message = null, $simulate = false, $entry_id = null )

requiresSQLGrouping() public method

Test whether this field requires grouping. If this function returns true SQL statements generated in the EntryManager will include the DISTINCT keyword to only return a single row for an entry regardless of how many 'matches' it might have. This default implementation returns false.
public requiresSQLGrouping ( )

Property Details

$sortOrder static public property

static public $sortOrder