Docs For Class atkManyToOneRelation

Home

Documentation home

Atk index

Docs For Class atkManyToOneRelation [ package: atk ]

Class: atkManyToOneRelation

Source Location: /relations/class.atkmanytoonerelation.inc

Class atkManyToOneRelation

Class Overview

A N:1 relation between two classes.

For example, projects all have one coordinator, but one coordinator can have multiple projects. So in the project class, there's a ManyToOneRelation to a coordinator.

This relation essentially creates a dropdown box, from which you can select from a set of records.

Located in /relations/class.atkmanytoonerelation.inc [line 80]

Wiki documentation

atkAttribute
   |
   --atkRelation
      |
      --atkManyToOneRelation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkUpdatedByAttribute	This attribute can be used to automatically store the user that inserted or last modified a record.
atkMetaManyToOneRelation	Implementation of many-to-one relationships for meta nodes.
atkManyToOneTreeRelation	Extension of the atkManyToOneRelation, that is aware of the treestructure (parent/child relation) in the destination node, and renders items in the dropdown accordingly. You need to set the AF_PARENT flag to the parent column in the destination node in order to make the tree rendering work.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkRelation atkRelation::$m_descHandler atkRelation::$m_descTemplate atkRelation::$m_destination atkRelation::$m_destinationFilter atkRelation::$m_destInstance Inherited From atkAttribute atkAttribute::$m_column atkAttribute::$m_cssclasses atkAttribute::$m_dbfieldtype atkAttribute::$m_dependees atkAttribute::$m_disabledModes atkAttribute::$m_flags atkAttribute::$m_forceinsert atkAttribute::$m_forceupdate atkAttribute::$m_htmlid atkAttribute::$m_index atkAttribute::$m_initialValue atkAttribute::$m_initial_hidden atkAttribute::$m_label atkAttribute::$m_loadType atkAttribute::$m_manual_paint atkAttribute::$m_maxsize atkAttribute::$m_module atkAttribute::$m_name atkAttribute::$m_onchangecode atkAttribute::$m_order atkAttribute::$m_owner atkAttribute::$m_ownerInstance atkAttribute::$m_searchmode atkAttribute::$m_searchsize atkAttribute::$m_sections atkAttribute::$m_size atkAttribute::$m_storageType atkAttribute::$m_tabs	Inherited From atkRelation atkRelation::atkRelation() Constructor atkRelation::addDestinationFilter() Adds a filter value to the destination filter. atkRelation::createDestination() Create the instance of the destination. atkRelation::dbFieldType() Since most relations do not store anything in a field, the default fieldtype for relations is "". Exceptions (like the many2oone relation, which stores a foreign key) can implement their own dbFieldType(). atkRelation::descriptor() Descriptor handler. Forwards description handler calls to the real description handler. atkRelation::display() Return a displayable string for a record. atkRelation::getAddLabel() Attempts to get a translated label which can be used when composing an "add" link atkRelation::getChildSearchMode() Get the searchmode for nested/child attributes. atkRelation::getDescriptorHandler() Get descriptor handler. atkRelation::getDescriptorTemplate() Returns the descriptor template for the destination node. atkRelation::getDestination() Returns an instance of the node that the relation points to. atkRelation::getDestinationFilter() Returns the destination filter. atkRelation::getJoinCondition() Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node. atkRelation::getSearchModes() Retrieve the searchmodes supported by the relation. atkRelation::isEmpty() Check if the relation is empty atkRelation::parseFilter() Parses the destination filter atkRelation::setDescriptorHandler() Set descriptor handler. atkRelation::setDescriptorTemplate() Sets the descriptor template for the destination node. atkRelation::setDestinationFilter() Sets the destination filter. atkRelation::validate() Validation method. Empty implementation. Derived classes may override this function. atkRelation::_cleanupDestinationFilter() Remove redundant (more than 1 subsequently) spaces from the filter string. Inherited From atkAttribute atkAttribute::atkAttribute() Constructor atkAttribute::addCSSClass() Add a CSS class for this attribute on an HTML form. atkAttribute::addDependee() Indicate that another attribute depends on this attribute, and that if this attribute is updated, the dependent attribute needs to be updated as well. 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::getDependees() Retrieve the dependees for this attribute. atkAttribute::getEdit() Retrieve the HTML code for placing this attribute in an edit page. 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::getRefreshCall() Returns a JavaScript call for refreshing this attribute. 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::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::initialValue() Initial value. Returns the initial value for this attribute which will be used in the add form etc. atkAttribute::isDepending() Check whether this attribute depends on other attributes. atkAttribute::isEmpty() Check if a record has an empty value for this attribute. atkAttribute::isInitialHidden() check whether initially hidden or not atkAttribute::isManualPaint() Check wether this attribute should be manually painted (call the edit method) 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::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::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_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::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::setFlags() Sets the flags of the attribute atkAttribute::setForceInsert() Used to force an attribute to update with every addDb() call 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::setManualPaint() Set wether the edit() method of this attribute should be called by the framework, or if the edit method is called manually. atkAttribute::setOwnerInstance() Sets the owner instance. 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::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::_registerDependees() Register change handlers for dependees. atkAttribute::_renderChangeHandler() Renders the onchange code on the page. atkAttribute::__toString() String representation for this attribute (PHP5 only).

Inherited Properties

Inherited Methods

Inherited From atkRelation

atkRelation::$m_descHandler

atkRelation::$m_descTemplate

atkRelation::$m_destination

atkRelation::$m_destinationFilter

atkRelation::$m_destInstance

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependees

atkAttribute::$m_disabledModes

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_manual_paint

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

Inherited From atkRelation

atkRelation::atkRelation()

Constructor

atkRelation::addDestinationFilter()

Adds a filter value to the destination filter.

atkRelation::createDestination()

Create the instance of the destination.

atkRelation::dbFieldType()

Since most relations do not store anything in a field, the default fieldtype for relations is "". Exceptions (like the many2oone relation, which stores a foreign key) can implement their own dbFieldType().

atkRelation::descriptor()

Descriptor handler. Forwards description handler calls to the real description handler.

atkRelation::display()

Return a displayable string for a record.

atkRelation::getAddLabel()

Attempts to get a translated label which can be used when composing an "add" link

atkRelation::getChildSearchMode()

Get the searchmode for nested/child attributes.

atkRelation::getDescriptorHandler()

Get descriptor handler.

atkRelation::getDescriptorTemplate()

Returns the descriptor template for the destination node.

atkRelation::getDestination()

Returns an instance of the node that the relation points to.

atkRelation::getDestinationFilter()

Returns the destination filter.

atkRelation::getJoinCondition()

Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.

atkRelation::getSearchModes()

Retrieve the searchmodes supported by the relation.

atkRelation::isEmpty()

Check if the relation is empty

atkRelation::parseFilter()

Parses the destination filter

atkRelation::setDescriptorHandler()

Set descriptor handler.

atkRelation::setDescriptorTemplate()

Sets the descriptor template for the destination node.

atkRelation::setDestinationFilter()

Sets the destination filter.

atkRelation::validate()

Validation method. Empty implementation. Derived classes may override this function.

atkRelation::_cleanupDestinationFilter()

Remove redundant (more than 1 subsequently) spaces from the filter string.

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::addCSSClass()

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

atkAttribute::addDependee()

Indicate that another attribute depends on this attribute, and that if this attribute is updated, the dependent attribute needs to be updated as well.

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::getDependees()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

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

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::getRefreshCall()

Returns a JavaScript call for refreshing this attribute.

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::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::initialValue()

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

atkAttribute::isDepending()

Check whether this attribute depends on other attributes.

atkAttribute::isEmpty()

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

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isManualPaint()

Check wether this attribute should be manually painted (call the edit method) 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::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::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_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::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::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

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

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::setManualPaint()

Set wether the edit() method of this attribute should be called by the framework, or if the edit method is called manually.

atkAttribute::setOwnerInstance()

Sets the owner instance.

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::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::_registerDependees()

Register change handlers for dependees.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Constant Summary

SEARCH_MODE_CONTAINS
SEARCH_MODE_EXACT
SEARCH_MODE_STARTSWITH

[ Top ]

Property Summary

boolean	$m_alwaysShowListColumns	Always show list columns?
int	$m_autocomplete_minchars	Minimum number of character a user needs to enter before auto-completion kicks in.
integer	$m_autocomplete_minrecords	Set the minimal number of records for showing the automcomplete. If there are less records the normal dropdown is shown
boolean	$m_autocomplete_saveform	Value determines if select link for autocomplete should use atkSubmit or not (for use in admin screen for example)
array	$m_autocomplete_searchfields	An array with the fieldnames of the destination node in which the autocompletion must search for results.
String	$m_autocomplete_searchmode	The search mode of the autocomplete fields. Can be 'startswith', 'exact' or 'contains'.
boolean	$m_autocomplete_search_case_sensitive	Value determines wether the search of the autocompletion is case-sensitive.
string	$m_autolink_destination	Destination node for auto links (edit, new)
string	$m_concatDescriptorFunction	Set a function to use for determining the descriptor in the getConcatFilter function
boolean	$m_hidewhenempty	Hide the relation when there are no records to select.
String	$m_joinFilter	SQL statement with extra filter for the join that retrieves the selected record.
boolean	$m_leftjoin	By default, we do a left join. this means that records that don't have a record in this relation, will be displayed anyway. NOTE: set this to false only if you know what you're doing. When in doubt, 'true' is usually the best option.
Array	$m_listColumns	List columns.
String	$m_noneLabel	Label to use for the 'none' option.
mixed	$m_onchangehandler_init
array	$m_refKey	The array of referential key fields.
array	$m_selectableRecords	Variable for caching records
boolean	$m_useFilterForAddLink	Use destination filter for autolink add link?

[ Top ]

Method Summary

atkManyToOneRelation	atkManyToOneRelation()	Constructor.
atkManyToOneRelation	addFlag()	Adds a flag to the manyToOne relation Note that adding flags at any time after the constructor might not always work. There are flags that are processed only at constructor time.
atkManyToOneRelation	addListColumn()	Add list column. An attribute of the destination node that (only) will be displayed in the recordlist.
atkManyToOneRelation	addListColumns()	Add multiple list columns. Attributes of the destination node that (only) will be displayed in the recordlist.
void	addToEditArray()	Adds the attribute's edit / hide HTML code to the edit array.
void	addToListArrayHeader()	Adds the attribute / field to the list header. This includes the column name and search field.
void	addToListArrayRow()	Adds the attribute / field to the list row. And if the row is totalisable also to the total.
void	addToQuery()	Adds this attribute to database queries.
void	addToSearchformFields()	Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.
string	createFilter()	Create the destination filter for the given record.
String	createOnChangeCaller()	Creates and registers the on change handler caller function.
String	createSearchFilter()	Creates a search filter with the given search value on the given descriptor fields
string	createSelectAndAutoLinks()	Creates HTML for the selection and auto links.
decoded	db2value()	Converts DataBase value to normal value
int	dbFieldSize()	Return the size of the field in the database.
String	dbFieldType()	Return the database field type of the attribute.
a	display()	Returns a displayable string for this value.
void	drawAutoCompleteBox()	Draw the auto-complete box.
Piece	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
boolean	equal()	Check if two records have the same value for this attribute
decoded	fetchValue()	Fetch value out of record
array	filterToArray()	Converts a record filter to a record array.
void	fixDestinationRecord()	Support for destination "records" where only the id is set and the record itself isn't converted to a real record (array) yet
string	getAutoLinkDestination()	Get destination node for the Autolink links (new/edit)
string	getConcatDescriptorFunction()	Return the function for determining the descriptor in the getConcatFilter function
string\|boolean	getConcatFilter()	Get Concat filter
String	getEdit()	Retrieve the html code for placing this attribute in an edit page.
String	getJoinCondition()	Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.
String	getNoneLabel()	Get none label.
String	getOrderByStatement()	Retrieves the ORDER BY statement for the relation.
array	getRelationAutolink()	Creates and returns the auto edit/view links
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.
Array	getSelectableRecords()	Returns the selectable records.
Array	getSelectedRecord()	Returns the currently selected record.
String	hide()	Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
Boolean	isSelectableRecord()	Is selectable record?
String	listHeaderSortOrder()	Retrieve the sortorder for the listheader based on the atkColumnConfig
array	load()	Retrieve detail records from the database.
int	loadType()	Determine the load type of this attribute.
void	partial_autocomplete()	Auto-complete partial.
HTML	partial_autocomplete_search()	Auto-complete search partial.
void	populate()	Populate the record with the destination record data.
String	search()	Returns a piece of html code that can be used to get search terms input from the user.
atkManyToOneRelation	setAlwaysShowListColumns()	Always show list columns in list view, even if the attribute itself is hidden?
void	setAutoCompleteCaseSensitive()	Set the case-sensitivity for the autocompletion search (true or false).
void	setAutoCompleteMinChars()	Sets the minimum number of characters before auto-completion kicks in.
void	setAutoCompleteMinRecords()	Set the minimal number of records for the autocomplete to show If there are less records the normal dropdown is shown
void	setAutoCompleteSaveForm()	Set if the select link should save form (atkSubmit) or not (for use in admin screen for example)
void	setAutoCompleteSearchFields()	Set the searchfields for the autocompletion.
void	setAutoCompleteSearchMode()	Set the searchmode for the autocompletion: exact, startswith(default) or contains.
void	setAutoLinkDestination()	Set destination node for the Autolink links (new/edit)
void	setConcatDescriptorFunction()	Set the function for determining the descriptor in the getConcatFilter function This function should be implemented in the destination node
void	setHideWhenEmpty()	Make this relation hide itself from the form when there are no items to select
void	setJoinFilter()	Set join filter.
void	setNoneLabel()	Set none label.
void	setUseFilterForAddLink()	Use destination filter for auto add link?
void	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.
void	validate()	Validate if the record we are referring to really exists.
int	value2db()	Convert value to DataBase value
Array	_getDestRecord()	Get the destination record for the edit action
Array	_getSelectableRecords()	Returns the selectable records for this many-to-one relation. Uses the owner instance $this->fieldName()."_selection" method if it exists.
Array	_getSelectedRecord()	Returns the selected record for this many-to-one relation. Uses the owner instance $this->fieldName()."_selected" method if it exists.
String	_getSelectLink()	Get the select link to select the value using a select action on the destination node
Boolean	_isSelectableRecord()	Is selectable record? Uses the owner instance $this->fieldName()."_selectable" method if it exists.

[ Top ]

Properties

boolean $m_alwaysShowListColumns = false [line 135]

Always show list columns?

API Tags:

Access:

private

[ Top ]

int $m_autocomplete_minchars = 2 [line 151]

Minimum number of character a user needs to enter before auto-completion kicks in.

API Tags:

Access:

private

[ Top ]

integer $m_autocomplete_minrecords = -1 [line 191]

Set the minimal number of records for showing the automcomplete. If there are less records the normal dropdown is shown

API Tags:

Access:

private

[ Top ]

boolean $m_autocomplete_saveform = true [line 182]

Value determines if select link for autocomplete should use atkSubmit or not (for use in admin screen for example)

[ Top ]

array $m_autocomplete_searchfields = "" [line 160]

An array with the fieldnames of the destination node in which the autocompletion must search for results.

API Tags:

Access:

private

[ Top ]

String $m_autocomplete_searchmode = "contains" [line 168]

The search mode of the autocomplete fields. Can be 'startswith', 'exact' or 'contains'.

API Tags:

Access:

private

[ Top ]

boolean $m_autocomplete_search_case_sensitive = false [line 175]

Value determines wether the search of the autocompletion is case-sensitive.

[ Top ]

string $m_autolink_destination = "" [line 198]

Destination node for auto links (edit, new)

API Tags:

Access:

protected

[ Top ]

string $m_concatDescriptorFunction = '' [line 217]

Set a function to use for determining the descriptor in the getConcatFilter function

API Tags:

Access:

private

[ Top ]

boolean $m_hidewhenempty = false [line 114]

Hide the relation when there are no records to select.

API Tags:

Access:

private

[ Top ]

String $m_joinFilter = "" [line 107]

SQL statement with extra filter for the join that retrieves the selected record.

[ Top ]

boolean $m_leftjoin = true [line 93]

By default, we do a left join. this means that records that don't have a record in this relation, will be displayed anyway. NOTE: set this to false only if you know what you're doing. When in doubt, 'true' is usually the best option.

[ Top ]

Array $m_listColumns = array() [line 128]

List columns.

API Tags:

Access:

private

[ Top ]

String $m_noneLabel = NULL [line 143]

Label to use for the 'none' option.

API Tags:

Access:

private

[ Top ]

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

Redefinition of:

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

[ Top ]

array $m_refKey = array() [line 100]

The array of referential key fields.

API Tags:

Access:

private

[ Top ]

array $m_selectableRecords = array() [line 121]

Variable for caching records

API Tags:

Access:

private

[ Top ]

boolean $m_useFilterForAddLink = true [line 209]

Use destination filter for autolink add link?

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkManyToOneRelation [line 232]

atkManyToOneRelation atkManyToOneRelation(
String
$name, String
$destination, [int
$flags = 0] 
)

Constructor.

Parameters:

String	$name:	The name of the attribute. This is the name of the field that is the referential key to the destination. For relations with more than one field in the foreign key, you should pass an array of referential key fields. The order of the fields must match the order of the primary key attributes in the destination node.
String	$destination:	The node we have a relationship with.
int	$flags:	Flags for the relation

[ Top ]

addFlag [line 276]

atkManyToOneRelation addFlag(
int
$flag 
)

Adds a flag to the manyToOne relation Note that adding flags at any time after the constructor might not always work. There are flags that are processed only at constructor time.

Parameters:

int

$flag:

The flag to add to the attribute

API Tags:

Return:

The instance of this atkManyToOneRelation

Redefinition of:

atkAttribute::addFlag(): Adds a flag to the attribute.

[ Top ]

addListColumn [line 394]

atkManyToOneRelation addListColumn(
string
$attr 
)

Add list column. An attribute of the destination node that (only) will be displayed in the recordlist.

Parameters:

string

$attr:

The attribute to add to the listcolumn

API Tags:

Return:

The instance of this atkManyToOneRelation

[ Top ]

addListColumns [line 405]

atkManyToOneRelation addListColumns(
)

Add multiple list columns. Attributes of the destination node that (only) will be displayed in the recordlist.

API Tags:

Return:

The instance of this atkManyToOneRelation

[ Top ]

addToEditArray [line 1744]

void addToEditArray(
String
$mode, 
&$arr, 
&$defaults, 
&$error, String
$fieldprefix, array
$arr, array
$defaults, array
$error 
)

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

This method is called by the node if it wants the data needed to create an edit form.

This is a framework method, it should never be called directly.

Parameters:

String	$mode:	the edit mode ("add" or "edit")
array	$arr:	pointer to the edit array
array	$defaults:	pointer to the default values array
array	$error:	pointer to the error array
String	$fieldprefix:	the fieldprefix
	&$arr:
	&$defaults:
	&$error:

Redefinition of:

atkAttribute::addToEditArray(): Adds the attribute's edit / hide HTML code to the edit array.

[ Top ]

addToListArrayHeader [line 1862]

void addToListArrayHeader(
String
$action, 
&$arr, String
$fieldprefix, int
$flags, array
$atksearch, String
$atkorderby, [atkDataGrid
$grid = null], array
$arr 
)

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

Framework method. It should not be necessary to call this method directly.

Parameters:

String	$action:	the action that is being performed on the node
array	$arr:	reference to the the recordlist array
String	$fieldprefix:	the fieldprefix
int	$flags:	the recordlist flags
array	$atksearch:	the current ATK search list (if not empty)
String	$atkorderby:	the current ATK orderby string (if not empty)
atkDataGrid	$grid:	The datagrid
	&$arr:

API Tags:

See:

atkNode::listArray

Redefinition of:

atkAttribute::addToListArrayHeader(): Adds the attribute / field to the list header. This includes the column name and search field.

[ Top ]

addToListArrayRow [line 1918]

void addToListArrayRow(
String
$action, 
&$arr, int
$nr, String
$fieldprefix, int
$flags, [
$edit = false], array
$arr 
)

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

Framework method. It should not be necessary to call this method directly.

Parameters:

String	$action:	the action that is being performed on the node
array	$arr:	reference to the the recordlist array
int	$nr:	the current row number
String	$fieldprefix:	the fieldprefix
int	$flags:	the recordlist flags
	&$arr:
	$edit:

API Tags:

See:

atkNode::listArray

Redefinition of:

atkAttribute::addToListArrayRow(): Adds the attribute / field to the list row. And if the row is totalisable also to the total.

[ Top ]

addToQuery [line 1318]

void addToQuery(

&$query, [String
$tablename = ""], [String
$fieldaliasprefix = ""], [Array
$rec = ""], [int
$level = 0], [String
$mode = ""], atkQuery
$query 
)

Adds this attribute to database queries.

Database queries (select, insert and update) are passed to this method so the attribute can 'hook' itself into the query.

Parameters:

atkQuery	$query:	The SQL query object
String	$tablename:	The name of the table of this attribute
String	$fieldaliasprefix:	Prefix to use in front of the alias in the query.
Array	$rec:	The record that contains the value of this attribute.
int	$level:	Recursion level if relations point to eachother, an endless loop could occur if they keep loading eachothers data. The $level is used to detect this loop. If overriden in a derived class, any subcall to an addToQuery method should pass the $level+1.
String	$mode:	Indicates what kind of query is being processing: This can be any action performed on a node (edit, add, etc) Mind you that "add" and "update" are the actions that store something in the database, whereas the rest are probably select queries.
	&$query:

Redefinition of:

atkAttribute::addToQuery(): Adds this attribute to database queries.

Redefined in descendants as:

atkUpdatedByAttribute::addToQuery() : This method is overriden to make sure that upon each save, the current user is retrieved.

[ Top ]

addToSearchformFields [line 1959]

void addToSearchformFields(

&$fields, 
&$node, 
&$record, [array
$fieldprefix = ""], array
$fields, atkNode
$node, array
$record 
)

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

Overridden method; in the integrated version, we should let the destination attributes hook themselves into the fieldlist instead of hooking the relation in it.

Parameters:

array	$fields:	The array containing fields to use in the extended search
atkNode	$node:	The node where the field is in
array	$record:	A record containing default values to put into the search fields.
array	$fieldprefix:	search / mode field prefix
	&$fields:
	&$node:
	&$record:

Redefinition of:

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

[ Top ]

createFilter [line 1601]

string createFilter(
array
$record 
)

Create the destination filter for the given record.

Parameters:

array

$record:

API Tags:

Return:

filter

[ Top ]

createOnChangeCaller [line 2015]

String createOnChangeCaller(
string
$fieldId, string
$fieldPrefix, [string
$none = 'null'] 
)

Creates and registers the on change handler caller function.

This method will be used to message listeners for a change event as soon as a new value is selected.

Parameters:

string	$fieldId:
string	$fieldPrefix:
string	$none:

API Tags:

Return:

function name

[ Top ]

createSearchFilter [line 2180]

String createSearchFilter(
String
$searchvalue 
)

Creates a search filter with the given search value on the given descriptor fields

Parameters:

String

$searchvalue:

A searchstring

API Tags:

Return:

a search string (WHERE clause)

[ Top ]

createSelectAndAutoLinks [line 664]

string createSelectAndAutoLinks(
string
$id, array
$record 
)

Creates HTML for the selection and auto links.

Parameters:

string	$id:	attribute id
array	$record:	record

[ Top ]

db2value [line 521]

decoded db2value(
array
$rec 
)

Converts DataBase value to normal value

Parameters:

array

$rec:

Record

API Tags:

Return:

value

Redefinition of:

atkAttribute::db2value(): Converts a database value to an internal value.

[ Top ]

dbFieldSize [line 1501]

int dbFieldSize(
)

Return the size of the field in the database.

If 0 is returned, the size is unknown. In this case, the return value should not be used to create table columns.

Ofcourse, the size does not make sense for every field type. So only interpret the result if a size has meaning for the field type of this attribute. (For example, if the database field is of type 'date', the size has no meaning)

API Tags:

Return:

The database field size

Redefinition of:

atkAttribute::dbFieldSize(): Return the size of the field in the database.

[ Top ]

dbFieldType [line 1466]

String dbFieldType(
)

Return the database field type of the attribute.

Note that the type returned is a 'generic' type. Each database vendor might have his own types, therefor, the type should be converted to a database specific type using $db->fieldType().

If the type was read from the table metadata, that value will be used. Else, the attribute will analyze its flags to guess what type it should be. If AF_AUTO_INCREMENT is set, the field is probaly "number". If not, it's probably "string".

API Tags:

Return:

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

Redefinition of:

atkRelation::dbFieldType(): Since most relations do not store anything in a field, the default fieldtype for relations is "". Exceptions (like the many2oone relation, which stores a foreign key) can implement their own dbFieldType().

[ Top ]

display [line 600]

a display(
array
$record, [String
$mode = 'list'] 
)

Returns a displayable string for this value.

Parameters:

array	$record:	The record that holds the value for this attribute
String	$mode:	The display mode ("view" for viewpages, or "list" for displaying in recordlists, "edit" for displaying in editscreens, "add" for displaying in add screens. "csv" for csv files. Applications can use additional modes.

API Tags:

Return:

displayable string

Redefinition of:

atkRelation::display(): Return a displayable string for a record.

[ Top ]

drawAutoCompleteBox [line 2044]

void drawAutoCompleteBox(
array
$record, string
$fieldPrefix, string
$mode 
)

Draw the auto-complete box.

Parameters:

array	$record:	The record
string	$fieldPrefix:	The fieldprefix
string	$mode:	The mode we're in

[ Top ]

edit [line 725]

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

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

Parameters:

array	$record:	The record that holds the value for this attribute.
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 that can be used in a form to edit this

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:

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

[ Top ]

equal [line 1436]

boolean equal(
array
$recA, array
$recB 
)

Check if two records have the same value for this attribute

Parameters:

array	$recA:	Record A
array	$recB:	Record B

API Tags:

Return:

to indicate if the records are equal

Redefinition of:

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

[ Top ]

fetchValue [line 466]

decoded fetchValue(
array
$postvars 
)

Fetch value out of record

Parameters:

array

$postvars:

Postvars

API Tags:

Return:

value

Redefinition of:

atkAttribute::fetchValue(): Convert values from an HTML form posting to an internal value for this attribute.

[ Top ]

filterToArray [line 1018]

array filterToArray(
string
$filter 
)

Converts a record filter to a record array.

Parameters:

string

$filter:

filter string

API Tags:

Return:	record
Access:	protected

[ Top ]

fixDestinationRecord [line 976]

void fixDestinationRecord(

&$record, array
$record 
)

Support for destination "records" where only the id is set and the record itself isn't converted to a real record (array) yet

Parameters:

array	$record:	The record to fix
	&$record:

[ Top ]

getAutoLinkDestination [line 707]

string getAutoLinkDestination(
)

Get destination node for the Autolink links (new/edit)

[ Top ]

getConcatDescriptorFunction [line 382]

string getConcatDescriptorFunction(
)

Return the function for determining the descriptor in the getConcatFilter function

[ Top ]

getConcatFilter [line 2260]

string|boolean getConcatFilter(
string
$searchValue, [string
$fieldaliasprefix = ""] 
)

Get Concat filter

Parameters:

string	$searchValue:	Search value
string	$fieldaliasprefix:	Field alias prefix

[ Top ]

getEdit [line 1006]

String getEdit(
String
$mode, 
&$record, String
$fieldprefix, array
$record 
)

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

The difference with the edit() method is that the edit() method just generates the HTML code for editing the attribute, while the getEdit() method is 'smart', and implements a hide/readonly policy based on flags and/or custom override methodes in the node. (<attributename>_edit() and <attributename>_display() methods)

Framework method, it should not be necessary to call this method directly.

Parameters:

String	$mode:	The edit mode ("add" or "edit")
array	$record:	The record holding the values for this attribute
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.
	&$record:

API Tags:

Return:

the HTML code for this attribute that can be used in an editpage.

Redefinition of:

atkAttribute::getEdit(): Retrieve the HTML code for placing this attribute in an edit page.

[ Top ]

getJoinCondition [line 1695]

String getJoinCondition(

&$query, [String
$tablename = ""], [String
$fieldalias = ""], atkQuery
$query 
)

Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.

Parameters:

atkQuery	$query:	The query object
String	$tablename:	The tablename on which to join
String	$fieldalias:	The fieldalias
	&$query:

API Tags:

Return:

SQL string for joining the owner with the destination. Returns false when impossible (f.e. attrib is not a relation).

Redefinition of:

atkRelation::getJoinCondition(): Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.

[ Top ]

getNoneLabel [line 575]

String getNoneLabel(
)

Get none label.

API Tags:

Return:

The label for the "none" option

[ Top ]

getOrderByStatement [line 1768]

String getOrderByStatement(
[Array
$extra = ''], [String
$table = ''], [String
$direction = 'ASC'] 
)

Retrieves the ORDER BY statement for the relation.

Parameters:

Array	$extra:	A list of attribute names to add to the order by statement
String	$table:	The table name (if not given uses the owner node's table name)
String	$direction:	Sorting direction (ASC or DESC)

API Tags:

Return:

The ORDER BY statement for this attribute

Redefinition of:

atkAttribute::getOrderByStatement(): Retrieves the ORDER BY statement for this attribute's node.

[ Top ]

getRelationAutolink [line 919]

array getRelationAutolink(
String
$id, String
$filter 
)

Creates and returns the auto edit/view links

Parameters:

String	$id:	The field id
String	$filter:	Filter that we want to apply on the destination node

API Tags:

Return:

The HTML code for the autolink links

[ Top ]

getSearchCondition [line 1223]

String getSearchCondition(

&$query, String
$table, mixed
$value, String
$searchmode, [string
$fieldaliasprefix = ''], 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.
string	$fieldaliasprefix:	The prefix for the field
	&$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.

[ Top ]

getSearchModes [line 1159]

array getSearchModes(
)

Retrieve the list of searchmodes supported by the attribute.

Note that not all modes may be supported by the database driver. Compare this list to the one returned by the databasedriver, to determine which searchmodes may be used.

API Tags:

Return:

List of supported searchmodes

Redefinition of:

atkRelation::getSearchModes(): Retrieve the searchmodes supported by the relation.

[ Top ]

getSelectableRecords [line 1675]

Array getSelectableRecords(
[array
$record = array()], [string
$mode = "select"] 
)

Returns the selectable records.

Use this one from your selection override when needed.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

with the selectable records

[ Top ]

getSelectedRecord [line 1546]

Array getSelectedRecord(
[array
$record = array()], [string
$mode = "select"] 
)

Returns the currently selected record.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

with the selected record

[ Top ]

hide [line 951]

String hide(
[array
$record = ""], [String
$fieldprefix = ""] 
)

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

Parameters:

array	$record:	The record that holds the value for this attribute
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.

API Tags:

Return:

A piece of htmlcode with hidden form elements that post this attribute's value without showing it.

Redefinition of:

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

[ Top ]

isSelectableRecord [line 1624]

Boolean isSelectableRecord(
[array
$record = array()], [string
$mode = "select"] 
)

Is selectable record?

Use this one from your selectable override when needed.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

to indicate if the record is selectable

[ Top ]

listHeaderSortOrder [line 1991]

String listHeaderSortOrder(

&$columnConfig, atkColumnConfig
$columnConfig 
)

Retrieve the sortorder for the listheader based on the atkColumnConfig

Parameters:

atkColumnConfig	$columnConfig:	The config that contains options for extended sorting and grouping to a recordlist.
	&$columnConfig:

API Tags:

Return:

Returns sort order ASC or DESC

Redefinition of:

atkAttribute::listHeaderSortOrder(): Retrieve the sortorder for the listheader based on the atkColumnConfig

[ Top ]

load [line 1377]

array load(

&$db, array
$record, String
$mode, atkDb
$db 
)

Retrieve detail records from the database.

Called by the framework to load the detail records.

Parameters:

atkDb	$db:	The database used by the node.
array	$record:	The master record
String	$mode:	The mode for loading (admin, select, copy, etc)
	&$db:

API Tags:

Return:

Recordset containing detailrecords, or NULL if no detail records are present. Note: when $mode is edit, this method will always return NULL. This is a framework optimization because in edit pages, the records are loaded on the fly.

[ Top ]

loadType [line 1400]

int loadType(
String
$mode 
)

Determine the load type of this attribute.

With this method, the attribute tells the framework whether it wants to be loaded in the main query (addToQuery) or whether the attribute has its own load() implementation. For the atkOneToOneRelation, this depends on the presence of the AF_ONETOONE_LAZY flag.

Framework method. It should not be necesary to call this method directly.

Parameters:

String

$mode:

The type of load (view,admin,edit etc)

API Tags:

Return:

Bitmask containing information about load requirements. POSTLOAD|ADDTOQUERY when AF_ONETOONE_LAZY is set. ADDTOQUERY when AF_ONETOONE_LAZY is not set.

Redefinition of:

atkAttribute::loadType(): Determine the load type of this attribute.

[ Top ]

partial_autocomplete [line 2098]

void partial_autocomplete(
string
$mode 
)

Auto-complete partial.

Parameters:

string

$mode:

add/edit mode?

[ Top ]

partial_autocomplete_search [line 2149]

HTML partial_autocomplete_search(
)

Auto-complete search partial.

API Tags:

Return:

code with autocomplete result

[ Top ]

populate [line 637]

void populate(

&$record, [mixed
$fullOrFields = false], array
$record 
)

Populate the record with the destination record data.

Parameters:

array	$record:	record
mixed	$fullOrFields:	load all data, only the given fields or only the descriptor fields?
	&$record:

[ Top ]

search [line 1056]

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

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

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.
atkDataGrid	$grid:	The datagrid

API Tags:

Return:

A piece of html-code

Redefinition of:

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

Redefined in descendants as:

atkManyToOneTreeRelation::search() : Returns a piece of html code that can be used in a form to search

[ Top ]

setAlwaysShowListColumns [line 421]

atkManyToOneRelation setAlwaysShowListColumns(
bool
$value 
)

Always show list columns in list view, even if the attribute itself is hidden?

Parameters:

bool

$value:

always show list columns?

API Tags:

Return:

The instance of this atkManyToOneRelation

[ Top ]

setAutoCompleteCaseSensitive [line 320]

void setAutoCompleteCaseSensitive(
array
$case_sensitive 
)

Set the case-sensitivity for the autocompletion search (true or false).

Parameters:

array

$case_sensitive:

[ Top ]

setAutoCompleteMinChars [line 330]

void setAutoCompleteMinChars(
int
$chars 
)

Sets the minimum number of characters before auto-completion kicks in.

Parameters:

int

$chars:

[ Top ]

setAutoCompleteMinRecords [line 351]

void setAutoCompleteMinRecords(
integer
$minrecords 
)

Set the minimal number of records for the autocomplete to show If there are less records the normal dropdown is shown

Parameters:

integer

$minrecords:

[ Top ]

setAutoCompleteSaveForm [line 340]

void setAutoCompleteSaveForm(
[boolean
$saveform = true] 
)

Set if the select link should save form (atkSubmit) or not (for use in admin screen for example)

Parameters:

boolean

$saveform:

[ Top ]

setAutoCompleteSearchFields [line 299]

void setAutoCompleteSearchFields(
array
$searchfields 
)

Set the searchfields for the autocompletion.

Parameters:

array

$searchfields:

[ Top ]

setAutoCompleteSearchMode [line 310]

void setAutoCompleteSearchMode(
array
$mode 
)

Set the searchmode for the autocompletion: exact, startswith(default) or contains.

Parameters:

array

$mode:

[ Top ]

setAutoLinkDestination [line 697]

void setAutoLinkDestination(
string
$node 
)

Set destination node for the Autolink links (new/edit)

Parameters:

string

$node:

[ Top ]

setConcatDescriptorFunction [line 372]

void setConcatDescriptorFunction(
string
$function 
)

Set the function for determining the descriptor in the getConcatFilter function This function should be implemented in the destination node

Parameters:

string

$function:

[ Top ]

setHideWhenEmpty [line 1725]

void setHideWhenEmpty(
boolean
$hidewhenempty 
)

Make this relation hide itself from the form when there are no items to select

Parameters:

boolean

$hidewhenempty:

true - hide when empty, false - always show

[ Top ]

setJoinFilter [line 289]

void setJoinFilter(
string
$filter 
)

Set join filter.

Parameters:

string

$filter:

join filter

[ Top ]

setNoneLabel [line 565]

void setNoneLabel(
string
$label 
)

Set none label.

Parameters:

string

$label:

The label to use for the "none" option

[ Top ]

setUseFilterForAddLink [line 361]

void setUseFilterForAddLink(
boolean
$useFilter 
)

Use destination filter for auto add link?

Parameters:

boolean

$useFilter:

use destnation filter for add link?

[ Top ]

smartSearchCondition [line 1180]

void smartSearchCondition(
Integer
$id, Integer
$nr, Array
$path, 
&$query, String
$ownerAlias, Mixed
$value, String
$mode, atkQuery
$query 
)

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.

Parameters:

Integer	$id:	The unique smart search criterium identifier.
Integer	$nr:	The element number in the path.
Array	$path:	The remaining attribute path.
atkQuery	$query:	The query to which the condition will be added.
String	$ownerAlias:	The owner table alias to use.
Mixed	$value:	The value the user has entered in the searchbox.
String	$mode:	The searchmode to use.
	&$query:

Redefinition of:

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.

[ Top ]

validate [line 1419]

void validate(

&$record, string
$mode, array
$record 
)

Validate if the record we are referring to really exists.

Parameters:

array	$record:
string	$mode:
	&$record:

Redefinition of:

atkRelation::validate(): Validation method. Empty implementation. Derived classes may override this function.

[ Top ]

value2db [line 434]

int value2db(
array
$rec 
)

Convert value to DataBase value

Parameters:

array

$rec:

Record to convert

API Tags:

Return:

Database safe value

Redefinition of:

atkAttribute::value2db(): Converts the internal attribute value to one that is understood by the database.

Redefined in descendants as:

atkUpdatedByAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.

[ Top ]

_getDestRecord [line 880]

Array _getDestRecord(
String
$selname, String
$newlyadded, 
&$record, 
&$editflag, Array
$record, bool
$editflag 
)

Get the destination record for the edit action

Parameters:

String	$selname:	The name that the selected variable uses in the URL
String	$newlyadded:	The name that the selected variable uses in the postvars
Array	$record:	The original record
bool	$editflag:	The edit flag (?)
	&$record:
	&$editflag:

API Tags:

Return:

The destination record

[ Top ]

_getSelectableRecords [line 1571]

Array _getSelectableRecords(
[array
$record = array()], [string
$mode = "select"] 
)

Returns the selectable records for this many-to-one relation. Uses the owner instance $this->fieldName()."_selection" method if it exists.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

with the selectable records

[ Top ]

_getSelectedRecord [line 1531]

Array _getSelectedRecord(
[array
$record = array()], [string
$mode = "select"] 
)

Returns the selected record for this many-to-one relation. Uses the owner instance $this->fieldName()."_selected" method if it exists.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

with the selected record

[ Top ]

_getSelectLink [line 845]

String _getSelectLink(
string
$selname, string
$filter 
)

Get the select link to select the value using a select action on the destination node

Parameters:

string	$selname:
string	$filter:

API Tags:

Return:

HTML-code with the select link

[ Top ]

_isSelectableRecord [line 1587]

Boolean _isSelectableRecord(
[array
$record = array()], [string
$mode = "select"] 
)

Is selectable record? Uses the owner instance $this->fieldName()."_selectable" method if it exists.

Parameters:

array	$record:	The record
string	$mode:	The mode we're in

API Tags:

Return:

to indicate if the record is selectable

[ Top ]

Constants

SEARCH_MODE_CONTAINS = "contains" [line 84]

[ Top ]

SEARCH_MODE_EXACT = "exact" [line 82]

[ Top ]

SEARCH_MODE_STARTSWITH = "startswith" [line 83]

[ Top ]