Docs For Class atkManyToManyRelation

Home

Documentation home

Atk index

Docs For Class atkManyToManyRelation [ package: atk ]

Class: atkManyToManyRelation

Source Location: /relations/class.atkmanytomanyrelation.inc

Class atkManyToManyRelation

Class Overview

Many to many relation. Should not be used directly.

This class is used as base class for special kinds of manytomany relations, like the manyboolrelation. Note that most many-to-many relationships can be normalized to a combination of one-to-many and many-to-one relations.

Located in /relations/class.atkmanytomanyrelation.inc [line 40]

Wiki documentation

atkAttribute
   |
   --atkRelation
      |
      --atkManyToManyRelation

Author(s):

Ivo Jansch <ivo@achievo.org>

API Tags:

Abstract:

Information Tags:

Todo:

Improve multi-field support. For example setOwnerFields with multiple fields doesn't work properly at the moment. But it seems more code does not take multi-field support into account.

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkExtendableShuttleRelation	Shuttle relation with widget extensions.
atkManyBoolRelation	Many-to-many relation.
atkManyToManyListRelation	Many-to-many list relation.
atkManyToManySelectRelation	Many-to-many select relation.
atkShuttleRelation	Many-to-many relation.

[ 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_onchangehandler_init 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_onchangehandler_init

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 ]

Property Summary

mixed	$m_link
mixed	$m_linkInstance
mixed	$m_localFilter
mixed	$m_localKey
mixed	$m_ownerFields
mixed	$m_remoteKey
mixed	$m_store_deletion_filter

[ Top ]

Method Summary

atkManyToManyRelation	atkManyToManyRelation()	Constructor
void	addToQuery()	Dummy function (we don't add ourselves to the query)
value	checkKeyDimension()	Checks if a key is not an array
boolean	createLink()	Create instance of the intermediairy link node.
void	delete()	delete relational records..
the	determineKeyName()	Determine the name of the foreign key based on the name of the relation.
a	display()	Returns a displayable string for this value.
String	edit()	Dummy function
void	fetchValue()	Fetch value. If nothing selected, return empty array instead of nothing.
String	getLocalKey()	Get the name of the attribute of the intermediairy node that points to the master node.
array	getOwnerFields()	Returns the owner fields. The owners fields are the attribute(s) of the owner instance which map to the local key of the link node.
String	getRemoteKey()	Get the name of the attribute of the intermediairy node that points to the node on the other side of the relation.
array	getSelectableRecords()	Returns the selectable records for this relation.
array	getSelectedRecords()	Returns the primary keys of the currently selected records retrieved from the given 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">)
true	isEmpty()	Check if the attribute is empty
void	load()	load function
string	parseDestinationFilter()	Parse destination filter and return the result.
string	search()	Returns a piece of html code that can be used in a form to search
void	searchCondition()	Creates an search condition for a given search value
void	setLocalFilter()	Local filter is used to only show values that are once selected that comply with the local filter. A local filter is also automatically set as store deletion filter.
void	setLocalKey()	Change the name of the attribute of the intermediairy node that points to the master node.
void	setOwnerFields()	Sets the owner fields in the owner instance. The owner fields are the attribute(s) of the owner instance which map to the local key of the link node.
void	setRemoteKey()	Change the name of the attribute of the intermediairy node that points to the node on the other side of the relation.
none	setStoreDeletionFilter()	Function adds a custom filter that is used when deleting items during the store() function.
void	store()	Stores the values in the database
string	_getLoadWhereClause()	Get where clause for loading the record
int	_getSelectableRecordCount()	Returns the selectable record count.
array	_getSelectableRecords()	Returns the selectable records. Checks for an override in the owner instance with name <attribname>_selection.

[ Top ]

Properties

mixed $m_link = "" [line 44]

[ Top ]

mixed $m_linkInstance = NULL [line 45]

[ Top ]

mixed $m_localFilter = NULL [line 47]

[ Top ]

mixed $m_localKey = "" [line 42]

[ Top ]

mixed $m_ownerFields = null [line 49]

API Tags:

Access:

protected

[ Top ]

mixed $m_remoteKey = "" [line 43]

[ Top ]

mixed $m_store_deletion_filter = "" [line 46]

[ Top ]

Methods

Constructor atkManyToManyRelation [line 68]

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

Constructor

Parameters:

String	$name:	The name of the relation
String	$link:	The full name of the node that is used as intermediairy node. The intermediairy node is assumed to have 2 attributes that are named after the nodes at both ends of the relation. For example, if node 'project' has a M2M relation with 'activity', then the intermediairy node 'project_activity' is assumed to have an attribute named 'project' and one that is named 'activity'. You can set your own keys by calling setLocalKey() and setRemoteKey()
String	$destination:	The full name of the node that is the other end of the relation.
int	$flags:	Flags for the relation.

[ Top ]

addToQuery [line 409]

void addToQuery(

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

Dummy function (we don't add ourselves to 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.

[ Top ]

checkKeyDimension [line 703]

value checkKeyDimension(
string
$key, [string
$field = "id"] 
)

Checks if a key is not an array

Parameters:

string	$key:	field containing the key values
string	$field:	field to return if an array

API Tags:

Return:

of $field

[ Top ]

createLink [line 211]

boolean createLink(
)

Create instance of the intermediairy link node.

If succesful, the instance is stored in the m_linkInstance member variable.

API Tags:

Return:

True if successful, false if not.

Redefined in descendants as:

atkMetaExtendableShuttleRelation::createLink() : Create the instance of the intermedinary link node.
atkMetaManyBoolRelation::createLink() : Create the instance of the intermedinary link node.
atkMetaManyToManyListRelation::createLink() : Create the instance of the intermedinary link node.
atkMetaManyToManySelectRelation::createLink() : Create the instance of the intermedinary link node.
atkMetaShuttleRelation::createLink() : Create the instance of the intermedinary link node.

[ Top ]

delete [line 465]

void delete(
array
$record 
)

delete relational records..

Parameters:

array

$record:

The record

Redefinition of:

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

[ Top ]

determineKeyName [line 304]

the determineKeyName(
String
$name 
)

Determine the name of the foreign key based on the name of the relation.

Parameters:

String

$name:

the name of the relation

API Tags:

Return:

probable name of the foreign key

[ Top ]

display [line 346]

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

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 for this value

Redefinition of:

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

Redefined in descendants as:

atkExtendableShuttleRelation::display() : Display the value of this relation

[ Top ]

edit [line 387]

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

Dummy function

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:

A piece of htmlcode for editing this attribute

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:

atkExtendableShuttleRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkManyBoolRelation::edit() : Return a piece of html code to edit the attribute
atkManyToManyListRelation::edit() : Return a piece of html code to edit the attribute.
atkManyToManySelectRelation::edit() : Return a piece of html code to edit the attribute.
atkShuttleRelation::edit() : Return a piece of html code to edit the attribute

[ Top ]

fetchValue [line 718]

void fetchValue(
array
$postvars 
)

Fetch value. If nothing selected, return empty array instead of nothing.

Parameters:

array

$postvars:

Redefinition of:

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

Redefined in descendants as:

atkExtendableShuttleRelation::fetchValue() : Fetch value for this relation based on the postvars

[ Top ]

getLocalKey [line 234]

String getLocalKey(
)

Get the name of the attribute of the intermediairy node that points to the master node.

API Tags:

Return:

The name of the attribute.

[ Top ]

getOwnerFields [line 288]

array getOwnerFields(
)

Returns the owner fields. The owners fields are the attribute(s) of the owner instance which map to the local key of the link node.

API Tags:

Return:	owner fields
Access:	public

[ Top ]

getRemoteKey [line 258]

String getRemoteKey(
)

Get the name of the attribute of the intermediairy node that points to the node on the other side of the relation.

API Tags:

Return:

The name of the attribute.

[ Top ]

getSelectableRecords [line 152]

array getSelectableRecords(
[array
$record = array()], [string
$mode = ""], [boolean
$force = false] 
)

Returns the selectable records for this relation.

Parameters:

array	$record:
string	$mode:
boolean	$force:

API Tags:

Return:	selectable records
Access:	public

[ Top ]

getSelectedRecords [line 180]

array getSelectedRecords(
array
$record 
)

Returns the primary keys of the currently selected records retrieved from the given record.

Parameters:

array

$record:

current record

API Tags:

Return:

list of selected record keys

[ Top ]

hide [line 594]

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 ]

isEmpty [line 579]

true isEmpty(
array
$postvars 
)

Check if the attribute is empty

Parameters:

array

$postvars:

API Tags:

Return:

if it's empty

Redefinition of:

atkRelation::isEmpty(): Check if the relation is empty

[ Top ]

load [line 419]

void load(
atkDb
$notused, array
$record 
)

load function

Parameters:

atkDb	$notused:
array	$record:

Redefined in descendants as:

atkExtendableShuttleRelation::load() : Load the records for this relation

[ Top ]

parseDestinationFilter [line 99]

string parseDestinationFilter(
array
$record 
)

Parse destination filter and return the result.

Parameters:

array

$record:

record

API Tags:

Return:	parsed filter
Access:	private

[ Top ]

search [line 633]

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

Returns a piece of html code that can be used in a form to search

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.

API Tags:

Return:

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.

[ Top ]

searchCondition [line 673]

void searchCondition(

&$query, String
$table, mixed
$value, String
$searchmode, [string
$fieldaliasprefix = ''], atkQuery
$query 
)

Creates an search condition for a given search value

Parameters:

atkQuery	$query:	The query to which the condition will be added.
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:	optional prefix for the fieldalias in the table
	&$query:

Redefinition of:

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.

[ Top ]

setLocalFilter [line 750]

void setLocalFilter(
string
$filter 
)

Local filter is used to only show values that are once selected that comply with the local filter. A local filter is also automatically set as store deletion filter.

Parameters:

string

$filter:

filter

[ Top ]

setLocalKey [line 248]

void setLocalKey(
String
$attributename 
)

Change the name of the attribute of the intermediairy node that points to the master node.

Parameters:

String

$attributename:

The name of the attribute.

[ Top ]

setOwnerFields [line 277]

void setOwnerFields(
array
$ownerfields 
)

Sets the owner fields in the owner instance. The owner fields are the attribute(s) of the owner instance which map to the local key of the link node.

Parameters:

array

$ownerfields:

API Tags:

Access:

public

[ Top ]

setRemoteKey [line 330]

void setRemoteKey(
String
$attributename 
)

Change the name of the attribute of the intermediairy node that points to the node on the other side of the relation.

Parameters:

String

$attributename:

The name of the attribute.

[ Top ]

setStoreDeletionFilter [line 738]

none setStoreDeletionFilter(
String
$filter 
)

Function adds a custom filter that is used when deleting items during the store() function.

Example: Normally the delete function would do something like this:

DELETE FROM phase WHERE phase.template NOT IN (1,2,3)

If the template field is NULL, although it is not specified in the NOT IN (1,2,3), it will not be deleted. An extra check can be added just in case the template value is not NULL but 0 or '' (which would delete the phase).

Parameters:

String

$filter:

The filter that is used when deleting records in the store function.

[ Top ]

store [line 483]

void store(
atkDb
$notused, array
$record, string
$mode 
)

Stores the values in the database

Parameters:

atkDb	$notused:	Not used
array	$record:	Current record
string	$mode:

Redefined in descendants as:

atkExtendableShuttleRelation::store() : Store the value of this relation

[ Top ]

_getLoadWhereClause [line 436]

string _getLoadWhereClause(
array
$record 
)

Get where clause for loading the record

Parameters:

array

$record:

The record

API Tags:

Return:

The where clause

[ Top ]

_getSelectableRecordCount [line 119]

int _getSelectableRecordCount(
[array
$record = array()], [string
$mode = ""] 
)

Returns the selectable record count.

Parameters:

array	$record:
string	$mode:

API Tags:

Access:

protected

[ Top ]

_getSelectableRecords [line 84]

array _getSelectableRecords(
[array
$record = array()], [string
$mode = ""], [bool
$force = false] 
)

Returns the selectable records. Checks for an override in the owner instance with name <attribname>_selection.

Parameters:

array	$record:
string	$mode:
bool	$force:

[ Top ]