메소드 | 설명 | |
---|---|---|
destroyAUX ( ) : void | Delete all auxiliary data like a column in the MetaModel table or references in another table etc. | |
filterGreaterThan ( mixed $varValue, boolean $blnInclusive = false ) : string[] | null | Filter all values greater than the passed value. | |
filterLessThan ( mixed $varValue, boolean $blnInclusive = false ) : string[] | null | Filter all values less than the passed value. | |
filterNotEqual ( mixed $varValue ) : string[] | null | Filter all values not having the passed value. | |
get ( string $strKey ) : mixed | Retrieve a meta information setting. | |
getAttributeSettingNames ( ) : string[] | Returns all valid settings for the attribute type. | |
getColName ( ) : string | Queries the attribute for it's column name within it's MetaModel. | |
getDefaultRenderSettings ( ) : MetaModels\Render\Setting\Simple | Retrieve an instance containing the default render settings for an attribute of this type. | |
getFieldDefinition ( array $arrOverrides = [] ) : array | This generates the field definition for use in a DCA. | |
getFilterOptions ( string[] | null $idList, boolean $usedOnly, array | null &$arrCount = null ) : array | Retrieve the filter options of this attribute. | |
getFilterUrlValue ( mixed $varValue ) : string | Convert a native attribute value into a value to be used in a filter Url. | |
getItemDCA ( array $arrOverrides = [] ) : array | This generates the field definition for use in a DCA. | |
getMetaModel ( ) : MetaModels\IMetaModel | Queries the attribute for it's parent MetaModel instance. | |
getName ( ) : string | Retrieve the human readable name (or title) from the attribute. | |
handleMetaChange ( string $strMetaName, mixed $varNewValue ) : MetaModels\Attribute\IAttribute | Updates the meta information of the attribute. | |
initializeAUX ( ) : void | Create auxiliary data like a column in the MetaModel table or references in another table etc. | |
modelSaved ( MetaModels\IItem $objItem ) : void | Called by the MetaModel after an item has been saved. | |
parseValue ( array $arrRowData, string $strOutputFormat = 'text', MetaModels\Render\Setting\ISimple | null $objSettings = null ) : array | Transform a value into real data. | |
searchFor ( string $strPattern ) : string[] | null | Search all items that match the given expression. | |
set ( string $strKey, mixed $varValue ) : MetaModels\Attribute\IAttribute | Override a meta information setting. | |
setDataFor ( mixed[] $arrValues ) : void | This method is called to store the data for certain items to the database. | |
sortIds ( string[] $idList, string $strDirection ) : string[] | Sorts the given array list by field value in the given direction. | |
valueToWidget ( mixed $varValue ) : mixed | Convert native attribute value to widget value. | |
widgetToValue ( mixed $varValue, string $itemId ) : mixed | Convert a value obtained from a widget to a native value of this attribute. |
public destroyAUX ( ) : void | ||
리턴 | void |
public filterGreaterThan ( mixed $varValue, boolean $blnInclusive = false ) : string[] | null | ||
$varValue | mixed | The value to use as lower end. |
$blnInclusive | boolean | If true, the passed value will be included, if false, it will be excluded. |
리턴 | string[] | null | The list of item ids of all items matching the condition or null if all match. |
public filterLessThan ( mixed $varValue, boolean $blnInclusive = false ) : string[] | null | ||
$varValue | mixed | The value to use as upper end. |
$blnInclusive | boolean | If true, the passed value will be included, if false, it will be excluded. |
리턴 | string[] | null | The list of item ids of all items matching the condition or null if all match. |
public filterNotEqual ( mixed $varValue ) : string[] | null | ||
$varValue | mixed | The value to use as upper end. |
리턴 | string[] | null | The list of item ids of all items matching the condition or null if all match. |
public getAttributeSettingNames ( ) : string[] | ||
리턴 | string[] | All valid setting names, this re-ensembles the columns in tl_metamodel_attribute this attribute class understands. |
public getColName ( ) : string | ||
리턴 | string | the attributes column name. |
public getDefaultRenderSettings ( ) : MetaModels\Render\Setting\Simple | ||
리턴 | MetaModels\Render\Setting\Simple |
public getFieldDefinition ( array $arrOverrides = [] ) : array | ||
$arrOverrides | array | The values to override, for a list of valid parameters, call getAttributeSettingNames(). |
리턴 | array | The DCA array to use as $GLOBALS['TL_DCA']['tablename']['fields']['attribute-name] |
public getFilterOptions ( string[] | null $idList, boolean $usedOnly, array | null &$arrCount = null ) : array | ||
$idList | string[] | null | The ids of items that the values shall be fetched from (If empty or null, all items). |
$usedOnly | boolean | Determines if only "used" values shall be returned. |
$arrCount | array | null | Array for the counted values. |
리턴 | array | All options matching the given conditions as name => value. |
public getFilterUrlValue ( mixed $varValue ) : string | ||
$varValue | mixed | The source value. |
리턴 | string |
public getItemDCA ( array $arrOverrides = [] ) : array | ||
$arrOverrides | array | See documentation in getFieldDefinition() method. |
리턴 | array | The DCA array to use as $GLOBALS['tablename'] |
public getMetaModel ( ) : MetaModels\IMetaModel | ||
리턴 | MetaModels\IMetaModel | the MetaModel instance. |
public handleMetaChange ( string $strMetaName, mixed $varNewValue ) : MetaModels\Attribute\IAttribute | ||
$strMetaName | string | Name of the meta information that shall be updated. |
$varNewValue | mixed | The new value for this meta information. |
리턴 | MetaModels\Attribute\IAttribute | The instance of this attribute, to support chaining. |
public initializeAUX ( ) : void | ||
리턴 | void |
public modelSaved ( MetaModels\IItem $objItem ) : void | ||
$objItem | MetaModels\IItem | The item that has just been saved. |
리턴 | void |
public parseValue ( array $arrRowData, string $strOutputFormat = 'text', MetaModels\Render\Setting\ISimple | null $objSettings = null ) : array | ||
$arrRowData | array | The (native) row data from the MetaModel table. |
$strOutputFormat | string | The desired output format. |
$objSettings | MetaModels\Render\Setting\ISimple | null | Custom settings to be passed to the renderer. |
리턴 | array | An array with all the converted data. |
public setDataFor ( mixed[] $arrValues ) : void | ||
$arrValues | mixed[] | The values to be stored into database. Mapping is item id=>value. |
리턴 | void |
public valueToWidget ( mixed $varValue ) : mixed | ||
$varValue | mixed | The value to be transformed. |
리턴 | mixed | The resulting widget compatible value |