Docs For Class atkListAttribute

Child Class	Description
atkCountryAttribute	The atkCountry class represents an attribute to handle ISO Countries in a listbox.
atkMultiSelectAttribute	The atkMultiboolAttribute class represents an attribute of a node that has a field with checkboxes, and stores the input seperated by a '\|'
atkRadioAttribute	The atkRadioAttribute class represents an attribute of a node that has a field with radio button to select from predefined values.
atkStateAttribute	The atkStateAttribute class represents an attribute to handle United States in a listbox.
atkTimeZoneAttribute	The atkTimeZone class represents an attribute to handle timezones in a listbox.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkAttribute atkAttribute::$m_column atkAttribute::$m_cssclasses atkAttribute::$m_dbfieldtype atkAttribute::$m_dependencies atkAttribute::$m_disabledModes atkAttribute::$m_editCallback atkAttribute::$m_flags atkAttribute::$m_forceinsert atkAttribute::$m_forcereload atkAttribute::$m_forceupdate atkAttribute::$m_htmlid atkAttribute::$m_index atkAttribute::$m_initialValue atkAttribute::$m_initial_hidden atkAttribute::$m_jsObservers atkAttribute::$m_label atkAttribute::$m_loadType atkAttribute::$m_maxsize atkAttribute::$m_module atkAttribute::$m_name atkAttribute::$m_onchangecode atkAttribute::$m_order atkAttribute::$m_owner atkAttribute::$m_ownerInstance atkAttribute::$m_postfixlabel atkAttribute::$m_searchmode atkAttribute::$m_searchsize atkAttribute::$m_sections atkAttribute::$m_size atkAttribute::$m_storageType atkAttribute::$m_tabs atkAttribute::$m_viewCallback	Inherited From atkAttribute atkAttribute::atkAttribute() Constructor atkAttribute::addCSSClass() Add a CSS class for this attribute on an HTML form. atkAttribute::addDependee() Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes. atkAttribute::addDependency() Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly. atkAttribute::addDisabledMode() Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::addFlag() Adds a flag to the attribute. atkAttribute::addOnChangeHandler() Add a javascript onchange event handler. atkAttribute::addToEditArray() Adds the attribute's edit / hide HTML code to the edit array. atkAttribute::addToListArrayHeader() Adds the attribute / field to the list header. This includes the column name and search field. atkAttribute::addToListArrayRow() Adds the attribute / field to the list row. And if the row is totalisable also to the total. atkAttribute::addToQuery() Adds this attribute to database queries. atkAttribute::addToSearchformFields() Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler. atkAttribute::addToViewArray() Adds the attribute's view / hide HTML code to the view array. atkAttribute::db2value() Converts a database value to an internal value. atkAttribute::dbFieldSize() Return the size of the field in the database. atkAttribute::dbFieldType() Return the database field type of the attribute. atkAttribute::delete() The delete method is called by the framework to inform the attribute that a record is deleted. atkAttribute::deleteAllowed() Check if delete of the record is allowed. atkAttribute::display() Returns a displayable string for this value, to be used in HTML pages. atkAttribute::edit() Returns a piece of html code that can be used in a form to edit this attribute's value. atkAttribute::equal() This function is called to compare if two records are considered equal by this attribute. atkAttribute::escapeSQL() Escape string for use in a query. atkAttribute::extendedSort() Retrieves the sort options and sort order. atkAttribute::fetchMeta() Fetch the metadata about this attrib from the table metadata, and process it. atkAttribute::fetchValue() Convert values from an HTML form posting to an internal value for this attribute. atkAttribute::fieldName() Returns the name of the attribute. atkAttribute::formName() Retrieve the name of the attribute in HTML forms. atkAttribute::getAdditionalTabs() Get list of additional tabs. atkAttribute::getAttributeHtmlId() Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it. atkAttribute::getColumn() Get column. atkAttribute::getCSSClassAttribute() Retrieve the attribute for the HTML-tag for this atkAttribute. atkAttribute::getCSSClasses() Retrieve the CSS classes that were registered for this attribute atkAttribute::getDb() Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned. atkAttribute::getDependencies() Retrieve the dependees for this attribute. atkAttribute::getEdit() Retrieve the HTML code for placing this attribute in an edit page. atkAttribute::getEditCallback() Returns the edit callback (if set). atkAttribute::getError() Check if this attribute has errors in the specified error list. atkAttribute::getFlags() Returns the full set of flags of the attribute. atkAttribute::getForceInsert() Getter for wether or not an attribute is forced to insert atkAttribute::getForceUpdate() Getter for wether or not an attribute is forced to update atkAttribute::getHtmlId() Return the html identifier (id="") of the attribute. (unique within a atkAttribute::getLabel() Get the HTML label of the attribute. atkAttribute::getModule() Get the module that this attribute originated from. atkAttribute::getOrderByStatement() Retrieves the ORDER BY statement for this attribute's node. atkAttribute::getOwnerInstance() Returns the owner instance. atkAttribute::getSearchCondition() Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition. atkAttribute::getSearchFieldName() Retrieve the fieldname of the attribute in an atksearch form. atkAttribute::getSearchMode() Retrieve the current set or default searchmode of this attribute atkAttribute::getSearchModeFieldname() Retrieve the searchmode name of the attribute in an atksearch form. atkAttribute::getSearchModes() Retrieve the list of searchmodes supported by the attribute. atkAttribute::getSections() retrieve the tabs and/or sections for this attribute. atkAttribute::getTabs() retrieve the tabs for this attribute. atkAttribute::getToolTip() Retrieve the html/javascript code for showing the tooltip for this attribute. atkAttribute::getView() Retrieve the html code for placing this attribute in a view page. atkAttribute::getViewCallback() Returns the view callback (if set). atkAttribute::hasDisabledMode() Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::hasFlag() Check if the attribute has a certain flag. atkAttribute::hasStore() This function is used to check whether a attribute has a store function or not. atkAttribute::hide() Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">) atkAttribute::init() This function is called right after the attribute is added to the node. atkAttribute::initDependencies() Initialize and calls the dependencies. atkAttribute::initialValue() Initial value. Returns the initial value for this attribute which will be used in the add form etc. atkAttribute::isEmpty() Check if a record has an empty value for this attribute. atkAttribute::isInitialHidden() check whether initially hidden or not atkAttribute::isNotNullInDb() Checks if this attribute is really not null in the database. atkAttribute::isPosted() Is there a value posted for this attribute? atkAttribute::label() Return the label of the attribute. atkAttribute::listHeaderSortOrder() Retrieve the sortorder for the listheader based on the atkColumnConfig atkAttribute::loadType() Determine the load type of this attribute. atkAttribute::maxInputSize() Determine the maximum length an input field may be. atkAttribute::needsInsert() This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call. atkAttribute::needsReload() This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session atkAttribute::needsUpdate() This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call. atkAttribute::observeJS() Observe the given JavaScript event and execute the given JavaScript statements when the event occurs. atkAttribute::parseStringValue() Convert a String representation into an internal value. atkAttribute::partial() Handle a partial request for this attribute, different attributes support different partials. atkAttribute::partial_dependencies() Call dependencies for this attribute and output JavaScript. atkAttribute::partial_refresh() Partial method to refresh the add/edit field for this attribute. atkAttribute::postInit() This function is called at the end of the node's init method. atkAttribute::preAddToEditArray() Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::preAddToViewArray() Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::registerJavaScriptObservers() Register JavaScript event handlers. atkAttribute::registerKeyListener() Register keyboard navigation for this attribute. atkAttribute::removeDisabledMode() Removes a disabled mode from the attribute. atkAttribute::removeFlag() Removes a flag from the attribute. atkAttribute::search() Returns a piece of html code that can be used to get search terms input from the user. atkAttribute::searchCondition() Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::searchMode() Returns piece of html which is used for setting/selecting the search mode for this attribute. atkAttribute::setAttribSize() Set the size(s) of the attribute atkAttribute::setAttributeSearchmode() Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode. atkAttribute::setColumn() Set column. atkAttribute::setDisabledModes() Sets the disabled mode flag of the attribute atkAttribute::setEditCallback() Sets the edit callback. atkAttribute::setFlags() Sets the flags of the attribute atkAttribute::setForceInsert() Used to force an attribute to update with every addDb() call atkAttribute::setForceReload() Used to force an attribute to update from the db regardless of the atkAttribute::setForceUpdate() Used to force an attribute to update with every updateDb() call atkAttribute::setInitialHidden() Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden. atkAttribute::setInitialValue() Set initial value for this attribute. atkAttribute::setLabel() Set the label of the attribute atkAttribute::setLoadType() Sets the load type. atkAttribute::setOwnerInstance() Sets the owner instance. atkAttribute::setPostFixLabel() Set the label of the attribute atkAttribute::setSections() Put the attribute on one or more tabs and/or sections. atkAttribute::setStorageType() Sets the storage type. atkAttribute::setTabs() Put the attribute on one or more tabs. atkAttribute::setViewCallback() Sets the view callback. atkAttribute::showOnTab() Check if the attribute wants to be shown on a certain tab. atkAttribute::smartSearchCondition() Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::sortOptions() Retrieves the sort options for this attribute which is used in recordlists and search actions. atkAttribute::sortOrder() Sets the sortorder options for this attribute which is used in recordlists and search actions. atkAttribute::storageType() Determine the storage type of this attribute. atkAttribute::sum() Calculate the sum of 2 records. atkAttribute::text() Translate using the owner instance's module and type. atkAttribute::validate() Checks if a value is valid. atkAttribute::value2db() Converts the internal attribute value to one that is understood by the database. atkAttribute::_callDependencies() Calls the dependency callbacks for this attribute. atkAttribute::_renderChangeHandler() Renders the onchange code on the page. atkAttribute::__toString() String representation for this attribute (PHP5 only).

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_postfixlabel

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

atkAttribute::$m_viewCallback

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::addCSSClass()

Add a CSS class for this attribute on an HTML form.

atkAttribute::addDependee()

Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes.

atkAttribute::addDependency()

Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly.

atkAttribute::addDisabledMode()

Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

Adds the attribute's edit / hide HTML code to the edit array.

atkAttribute::addToListArrayHeader()

Adds the attribute / field to the list header. This includes the column name and search field.

atkAttribute::addToListArrayRow()

Adds the attribute / field to the list row. And if the row is totalisable also to the total.

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.

atkAttribute::addToViewArray()

Adds the attribute's view / hide HTML code to the view array.

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

The delete method is called by the framework to inform the attribute that a record is deleted.

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

Returns a displayable string for this value, to be used in HTML pages.

atkAttribute::edit()

Returns a piece of html code that can be used in a form to edit this attribute's value.

atkAttribute::equal()

This function is called to compare if two records are considered equal by this attribute.

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

Fetch the metadata about this attrib from the table metadata, and process it.

atkAttribute::fetchValue()

Convert values from an HTML form posting to an internal value for this attribute.

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it.

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

Retrieve the attribute for the HTML-tag for this atkAttribute.

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned.

atkAttribute::getDependencies()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

Retrieve the HTML code for placing this attribute in an edit page.

atkAttribute::getEditCallback()

Returns the edit callback (if set).

atkAttribute::getError()

Check if this attribute has errors in the specified error list.

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

Return the html identifier (id="") of the attribute. (unique within a

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

Retrieves the ORDER BY statement for this attribute's node.

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getSearchCondition()

Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

Retrieve the searchmode name of the attribute in an atksearch form.

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

Retrieve the html/javascript code for showing the tooltip for this attribute.

atkAttribute::getView()

Retrieve the html code for placing this attribute in a view page.

atkAttribute::getViewCallback()

Returns the view callback (if set).

atkAttribute::hasDisabledMode()

Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

This function is used to check whether a attribute has a store function or not.

atkAttribute::hide()

Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)

atkAttribute::init()

This function is called right after the attribute is added to the node.

atkAttribute::initDependencies()

Initialize and calls the dependencies.

atkAttribute::initialValue()

Initial value. Returns the initial value for this attribute which will be used in the add form etc.

atkAttribute::isEmpty()

Check if a record has an empty value for this attribute.

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isNotNullInDb()

Checks if this attribute is really not null in the database.

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call.

atkAttribute::needsReload()

This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session

atkAttribute::needsUpdate()

This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.

atkAttribute::observeJS()

Observe the given JavaScript event and execute the given JavaScript statements when the event occurs.

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

Handle a partial request for this attribute, different attributes support different partials.

atkAttribute::partial_dependencies()

Call dependencies for this attribute and output JavaScript.

atkAttribute::partial_refresh()

Partial method to refresh the add/edit field for this attribute.

atkAttribute::postInit()

This function is called at the end of the node's init method.

atkAttribute::preAddToEditArray()

Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::preAddToViewArray()

Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::registerJavaScriptObservers()

Register JavaScript event handlers.

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

Returns a piece of html code that can be used to get search terms input from the user.

atkAttribute::searchCondition()

Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::searchMode()

Returns piece of html which is used for setting/selecting the search mode for this attribute.

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode.

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::setEditCallback()

Sets the edit callback.

atkAttribute::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

Used to force an attribute to update with every addDb() call

atkAttribute::setForceReload()

Used to force an attribute to update from the db regardless of the

atkAttribute::setForceUpdate()

Used to force an attribute to update with every updateDb() call

atkAttribute::setInitialHidden()

Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden.

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setPostFixLabel()

Set the label of the attribute

atkAttribute::setSections()

Put the attribute on one or more tabs and/or sections.

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::setViewCallback()

Sets the view callback.

atkAttribute::showOnTab()

Check if the attribute wants to be shown on a certain tab.

atkAttribute::smartSearchCondition()

Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::sortOptions()

Retrieves the sort options for this attribute which is used in recordlists and search actions.

atkAttribute::sortOrder()

Sets the sortorder options for this attribute which is used in recordlists and search actions.

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

Converts the internal attribute value to one that is understood by the database.

atkAttribute::_callDependencies()

Calls the dependency callbacks for this attribute.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

boolean	$m_autoSearch	When autosearch is set to true, this attribute will automatically submit the search form onchange. This will only happen in the admin action.
mixed	$m_emptyvalue	Value that is used when list is empty, normally empty
mixed	$m_lookup	Array for fast lookup of what value belongs to what option.
mixed	$m_onchangehandler_init
mixed	$m_options	Array with options for Listbox
mixed	$m_selected	Attribute that is to be selected
mixed	$m_types	Array which holds the options,values and lookup array in cache
mixed	$m_values	Array with values for Listbox
int	$m_width	The width of the dropdown list in pixels

[ Top ]

Method Summary

atkListAttribute	atkListAttribute()	Constructor.
void	addOption()	Add option/value to dropdown
void	createLookupArray()	Creates a lookup array to speedup translations
String	dbFieldType()	Return the database field type of the attribute.
text	display()	Display's text version of Record
piece	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
string	getEmptyValue()	Gets the value for the empty entry in the list attribute
void	getLookup()	Get functions to access the member variable for lookup.
void	getOptions()	Get function to access the member variable for options.
String	getSearchCondition()	Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
array	getSearchModes()	Retrieve the list of searchmodes supported by the attribute.
string	getSelected()	Gets the selected listattribute
void	getValues()	Get functions to access the member variable for values For backwards compatibility we also check the old member variable m_values
int	getWidth()	Gets the width of the dropdown list in pixels
Internal	parseStringValue()	Convert a String representation into an internal value.
void	removeOption()	Remove option from dropdown
void	removeValue()	Remove value from dropdown
String	search()	Returns a piece of html code that can be used to get search terms input from the user.
void	setAutoHide()	Set autohide for the given attribute
void	setAutoSearch()	When autosearch is set to true, this attribute will automatically submit the search form onchange. This will only happen in the admin action.
void	setEmptyValue()	Sets the value for the empty entry in the list attribute In normal cases you would just leave this empty, but certain cases might demand you set a value.
object reference	setOptions()	Set the option and value array
void	setSelected()	Sets the selected listitem
void	setWidth()	Set the width of the dropdown list in pixels
The	_addEmptyListOption()	If this attribute is NOT obligatory
array	_get()	Returns one of the following arrays
true	_set()	Set's one of the following arrays
string	_translateValue()	Translates the database value

[ Top ]

Properties

boolean $m_autoSearch = false [line 97]

When autosearch is set to true, this attribute will automatically submit the search form onchange. This will only happen in the admin action.

API Tags:

Access:

protected

[ Top ]

mixed $m_emptyvalue [line 81]

Value that is used when list is empty, normally empty

[ Top ]

mixed $m_lookup = array() [line 66]

Array for fast lookup of what value belongs to what option.

[ Top ]

mixed $m_onchangehandler_init = "newvalue = el.options[el.selectedIndex].value;\n" [line 89]

Redefinition of:

atkAttribute::$m_onchangehandler_init: Variable to store initialisation javascript code in for the changehandler.

Redefined in descendants as:

atkRadioAttribute::$m_onchangehandler_init

[ Top ]

mixed $m_options = array() [line 56]

Array with options for Listbox

[ Top ]

mixed $m_selected [line 76]

Attribute that is to be selected

[ Top ]

mixed $m_types = array() [line 71]

Array which holds the options,values and lookup array in cache

[ Top ]

mixed $m_values = array() [line 61]

Array with values for Listbox

[ Top ]

int $m_width [line 87]

The width of the dropdown list in pixels

[ Top ]

Methods

Constructor atkListAttribute [line 115]

atkListAttribute atkListAttribute(
string
$name, array
$optionArray, [array
$valueArray = ""], [int
$flags = 0], [int
$size = 0] 
)

Constructor.

Warning: very old versions of this attribute supported passing the parameters in a different order: $name, $flags, $optionArray. This order used to be supported even when the new order was implemented, but it has now been removed. Keep this in mind when upgrading from a very old ATK version (pre ATK4).

Parameters:

string	$name:	Name of the attribute
array	$optionArray:	Array with options
array	$valueArray:	Array with values. If you don't use this parameter, values are assumed to be the same as the options.
int	$flags:	Flags for this attribute
int	$size:	Size of the attribute.

[ Top ]

addOption [line 590]

void addOption(
string
$option, [string
$value = ""] 
)

Add option/value to dropdown

Parameters:

string	$option:
string	$value:

[ Top ]

createLookupArray [line 154]

void createLookupArray(
array
$optionArray, array
$valueArray 
)

Creates a lookup array to speedup translations

Parameters:

array	$optionArray:
array	$valueArray:

[ Top ]

dbFieldType [line 455]

String dbFieldType(
)

Return the database field type of the attribute.

API Tags:

Return:

The 'generic' type of the database field for this attribute.

Redefinition of:

atkAttribute::dbFieldType(): Return the database field type of the attribute.

Redefined in descendants as:

atkMultiSelectAttribute::dbFieldType() : Return the database field type of the attribute.
atkFlagAttribute::dbFieldType() : Return the database field type of the attribute.

[ Top ]

display [line 239]

text display(
array
$record 
)

Display's text version of Record

Parameters:

array

$record:

API Tags:

Return:

string of $record

Redefinition of:

atkAttribute::display(): Returns a displayable string for this value, to be used in HTML pages.

Redefined in descendants as:

atkMultiSelectAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.

[ Top ]

edit [line 272]

piece edit(
[array
$record = ""], [String
$fieldprefix = ""], [String
$mode = ""] 
)

Returns a piece of html code that can be used in a form to edit this attribute's value.

Parameters:

array	$record:	Array with fields
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.
String	$mode:	The mode we're in ('add' or 'edit')

API Tags:

Return:

of html code with a checkbox

Redefinition of:

atkAttribute::edit(): Returns a piece of html code that can be used in a form to edit this attribute's value.

Redefined in descendants as:

atkCountryAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMultiSelectAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkRadioAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkStateAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.

[ Top ]

getEmptyValue [line 530]

string getEmptyValue(
)

Gets the value for the empty entry in the list attribute

[ Top ]

getLookup [line 196]

void getLookup(
[array
$rec = null] 
)

Get functions to access the member variable for lookup.

For backwards compatibility we also check the old member variable m_lookup

Parameters:

array

$rec:

The record

[ Top ]

getOptions [line 170]

void getOptions(
[array
$rec = null] 
)

Get function to access the member variable for options.

For backwards compatibility we also check the old member variable m_options

Parameters:

array

$rec:

The record

[ Top ]

getSearchCondition [line 414]

String getSearchCondition(

&$query, String
$table, mixed
$value, String
$searchmode, atkQuery
$query 
)

Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

Parameters:

atkQuery	$query:	The query object where the search condition should be placed on
String	$table:	The name of the table in which this attribute is stored
mixed	$value:	The value the user has entered in the searchbox
String	$searchmode:	The searchmode to use. This can be any one of the supported modes, as returned by this attribute's getSearchModes() method.
	&$query:

API Tags:

Return:

The searchcondition to use.

Redefinition of:

atkAttribute::getSearchCondition(): Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

Redefined in descendants as:

atkMultiSelectAttribute::getSearchCondition()
atkFlagAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

[ Top ]

getSearchModes [line 439]

array getSearchModes(
)

Retrieve the list of searchmodes supported by the attribute.

API Tags:

Return:

List of supported searchmodes

Redefinition of:

atkAttribute::getSearchModes(): Retrieve the list of searchmodes supported by the attribute.

Redefined in descendants as:

atkMultiSelectAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkFlagAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.

[ Top ]

getSelected [line 510]

string getSelected(
)

Gets the selected listattribute

API Tags:

Return:	the selected listitem
See:	atkNode::initial_values
Deprecated:

[ Top ]

getValues [line 183]

void getValues(
[array
$rec = null] 
)

Get functions to access the member variable for values For backwards compatibility we also check the old member variable m_values

Parameters:

array

$rec:

The record

[ Top ]

getWidth [line 579]

int getWidth(
)

Gets the width of the dropdown list in pixels

API Tags:

Return:

The width of the dropdown list in pixels

[ Top ]

parseStringValue [line 544]

Internal parseStringValue(
String
$stringvalue 
)

Convert a String representation into an internal value.

This implementation search for the value first in the valueArray, then in the optionArray All other values are converted to the first of the valueArray

Parameters:

String

$stringvalue:

The value to parse.

API Tags:

Return:

value (from valueArray)

Redefinition of:

atkAttribute::parseStringValue(): Convert a String representation into an internal value.

[ Top ]

removeOption [line 610]

void removeOption(
string
$option 
)

Remove option from dropdown

Parameters:

string

$option:

[ Top ]

removeValue [line 650]

void removeValue(
string
$value 
)

Remove value from dropdown

Parameters:

string

$value:

[ Top ]

search [line 359]

String search(
[array
$record = ""], [boolean
$extended = false], [string
$fieldprefix = ""], [
$grid = null] 
)

Returns a piece of html code that can be used to get search terms input from the user.

The framework calls this method to display the searchbox in the search bar of the recordlist, and to display a more extensive search in the 'extended' search screen.

Parameters:

array	$record:	Array with values
boolean	$extended:	if set to false, a simple search input is returned for use in the searchbar of the recordlist. If set to true, a more extended search may be returned for the 'extended' search page. The atkAttribute does not make a difference for $extended is true, but derived attributes may reimplement this.
string	$fieldprefix:	The fieldprefix of this attribute's HTML element.
	$grid:

API Tags:

Return:

A piece of html-code with a checkbox

Information Tags:

Todo:

Configurable rows

Redefinition of:

atkAttribute::search(): Returns a piece of html code that can be used to get search terms input from the user.

[ Top ]

setAutoHide [line 467]

void setAutoHide(
string
$attrib, array
$valuearr 
)

Set autohide for the given attribute

Parameters:

string	$attrib:
array	$valuearr:

[ Top ]

setAutoSearch [line 496]

void setAutoSearch(
[bool
$auto = false] 
)

When autosearch is set to true, this attribute will automatically submit the search form onchange. This will only happen in the admin action.

Parameters:

bool

$auto:

API Tags:

Access:

public

[ Top ]

setEmptyValue [line 521]

void setEmptyValue(
string
$value 
)

Sets the value for the empty entry in the list attribute In normal cases you would just leave this empty, but certain cases might demand you set a value.

Parameters:

string

$value:

the value we set for empty value

[ Top ]

setOptions [line 633]

object reference setOptions(
array
$optionArray, array
$valueArray 
)

Set the option and value array

Parameters:

array	$optionArray:	array with options
array	$valueArray:	array with values

API Tags:

Return:

to this attribute

[ Top ]

setSelected [line 485]

void setSelected(
string
$selected 
)

Sets the selected listitem

Parameters:

string

$selected:

the listitem you want to have selected

API Tags:

See:	atkNode::initial_values
Deprecated:

[ Top ]

setWidth [line 570]

void setWidth(
int
$width 
)

Set the width of the dropdown list in pixels

Parameters:

int

$width:

The width of the dropdown list in pixels

[ Top ]

_addEmptyListOption [line 320]

The _addEmptyListOption(
)

If this attribute is NOT obligatory

Or if the attribute is obligatory and we set a config saying all obligatory lists should have a null item and we didn't add the flag AF_LIST_NO_OBLIGATORY_NULL_ITEM Or if the AF_LIST_OBLIGATORY_NULL_ITEM is set ... we add an empty list option

API Tags:

Return:

empty list option or an empty string

[ Top ]

_get [line 213]

array _get(
string
$type, [array
$rec = null] 
)

Returns one of the following arrays

options => optionarray values => valuearray lookup => lookuparray

Parameters:

string	$type:	("options", "values" or "lookup")
array	$rec:	The record

API Tags:

Return:

with options, values or lookup

[ Top ]

_set [line 228]

true _set(
string
$type, array
$value 
)

Set's one of the following arrays

options => optionarray values => valuearray lookup => lookuparray

Parameters:

string	$type:	("options", "values" or "lookup)
array	$value:

[ Top ]

_translateValue [line 251]

string _translateValue(
string
$value, [array
$rec = null] 
)

Translates the database value

Parameters:

string	$value:
array	$rec:	The record

[ Top ]