Docs For Class atkOneToOneRelation

Home

Documentation home

Atk index

Docs For Class atkOneToOneRelation [ package: atk ]

Class: atkOneToOneRelation

Source Location: /relations/class.atkonetoonerelation.inc

Class atkOneToOneRelation

Class Overview

Implementation of one-to-one relationships.

An atkOneToOneRelation defines a relation between two tables where there is one record in the first table that belongs to one record in the second table.

When editing a one-to-one relation, the form for the destination record is embedded in the form of the master record. When using the flag AF_ONETOONE_INTEGRATE, this is done transparantly so the user does not even notice that the data he's editing comes from 2 separate tables.

Located in /relations/class.atkonetoonerelation.inc [line 74]

Wiki documentation

atkAttribute
   |
   --atkRelation
      |
      --atkOneToOneRelation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

$m_refKey

Methods

[ Top ]

Descendants

Child Class	Description
atkMetaOneToOneRelation	Implementation of one-to-one relationships for meta nodes.
atkPolymorphicOneToOneRelation	Implementation of one-to-one relationships.
atkSecureRelation	Relationship that can link 2 tables based on a secure link that can not be decrypted when not logged in through an atk application.

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

Inherited Properties

Inherited Methods

Inherited From 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_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_onchangehandler_init

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_postfixlabel

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

atkAttribute::$m_viewCallback

Inherited From 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()

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

atkAttribute::addDependency()

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

atkAttribute::addDisabledMode()

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

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

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

atkAttribute::addToListArrayHeader()

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

atkAttribute::addToListArrayRow()

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

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

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

atkAttribute::addToViewArray()

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

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

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

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

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

atkAttribute::edit()

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

atkAttribute::equal()

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

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

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

atkAttribute::fetchValue()

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

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

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

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

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

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

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

atkAttribute::getDependencies()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

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

atkAttribute::getEditCallback()

Returns the edit callback (if set).

atkAttribute::getError()

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

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

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

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

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

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getSearchCondition()

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

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

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

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

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

atkAttribute::getView()

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

atkAttribute::getViewCallback()

Returns the view callback (if set).

atkAttribute::hasDisabledMode()

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

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

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

atkAttribute::hide()

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

atkAttribute::init()

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

atkAttribute::initDependencies()

Initialize and calls the dependencies.

atkAttribute::initialValue()

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

atkAttribute::isEmpty()

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

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isNotNullInDb()

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

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

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

atkAttribute::needsReload()

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

atkAttribute::needsUpdate()

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

atkAttribute::observeJS()

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

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

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

atkAttribute::partial_dependencies()

Call dependencies for this attribute and output JavaScript.

atkAttribute::partial_refresh()

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

atkAttribute::postInit()

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

atkAttribute::preAddToEditArray()

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

atkAttribute::preAddToViewArray()

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

atkAttribute::registerJavaScriptObservers()

Register JavaScript event handlers.

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

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

atkAttribute::searchCondition()

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

atkAttribute::searchMode()

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

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

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

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::setEditCallback()

Sets the edit callback.

atkAttribute::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

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

atkAttribute::setForceReload()

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

atkAttribute::setForceUpdate()

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

atkAttribute::setInitialHidden()

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

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setPostFixLabel()

Set the label of the attribute

atkAttribute::setSections()

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

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::setViewCallback()

Sets the view callback.

atkAttribute::showOnTab()

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

atkAttribute::smartSearchCondition()

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

atkAttribute::sortOptions()

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

atkAttribute::sortOrder()

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

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

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

atkAttribute::_callDependencies()

Calls the dependency callbacks for this attribute.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

String

$m_refKey

The name of the referential key attribute in the target node.

[ Top ]

Method Summary

atkOneToOneRelation	atkOneToOneRelation()	Default Constructor
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()	Overridden method; in the integrated version, we should let the destination attributes hook themselves into the fieldlist instead of hooking the relation in it.
void	addToViewArray()	Adds the attribute's view / hide HTML code to the view array.
String	db2value()	Converts the internal attribute value to one that is understood by the database.
boolean	delete()	The delete method is called by the framework to inform the attribute that the master record is deleted.
boolean	destinationHasRelation()	Determine the type of the attribute on the other side.
String	display()	Returns a displayable string for this value, to be used in HTML pages.
void	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
void	fetchMeta()	Initialize this destinations attribute sizes.
String	fetchValue()	Convert values from an HTML form posting to an internal value for this attribute.
array	getAdditionalTabs()	Get list of additional tabs.
String	getDestinationFilterCondition()	Construct the filter statement for filters that are set for the destination node (m_destinationFilter).
void	getFilter()
string	getJoinCondition()	Returns the condition which can be used when calling atkQuery's addJoin() method Joins the relation's owner with the destination
String	getSearchCondition()	Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
String	hide()	Returns a piece of html code for hiding this attribute in an HTML form, while still posting its values. (<input type="hidden">)
array	initialValue()	Set the initial values of this attribute
boolean	isEmpty()	Check if a record has an empty value for this attribute.
array	load()	Retrieve detail records from the database.
int	loadType()	Determine the load type of this attribute.
boolean	needsUpdate()	Needs update?
boolean	showOnTab()	Check if the attribute wants to be shown on a certain tab.
int	storageType()	Determine the storage type of this attribute.
boolean	store()	Store detail record in the database.
void	validate()	Checks if a value is valid.
mixed	value2db()	Convert the internal value to the database value
mixed	&_getStoreValue()	Gets the value to store for the onetoonerelation

[ Top ]

Properties

String $m_refKey = "" [line 81]

The name of the referential key attribute in the target node.

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkOneToOneRelation [line 114]

atkOneToOneRelation atkOneToOneRelation(
String
$name, String
$destination, [String
$refKey = ""], [int
$flags = 0] 
)

Default Constructor

The atkOneToOneRelation supports two configurations:

Master mode: The current node is considered the master, and the referential key pointing to the master record is in the destination node.
Slave mode: The current node is considered the child, and the referential key pointing to the master record is in the current node.

The mode to use is detected automatically based on the value of the $refKey parameter.

Example:

$this->add(new atkOneToOneRelation("child", "mymod.childnode", "parent_id"));

Parameters:

String	$name:	The unique name of the attribute. In slave mode, this corresponds to the foreign key field in the database table. (The name is also used as the section heading.)
String	$destination:	the destination node (in module.nodename notation)
String	$refKey:	In master mode, this specifies the foreign key field from the destination node that points to the master record. In slave mode, this parameter should be empty.
int	$flags:	Attribute flags that influence this attributes' behavior.

[ Top ]

addToEditArray [line 714]

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. The method is an override of atkAttribute's method, because in the atkOneToOneRelation, we need to implement the AF_ONETOONE_INTEGRATE feature.

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 1044]

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

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)
	&$arr:
	$columnConfig:
atkDataGrid	$grid:
	$column:

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.

Redefined in descendants as:

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

[ Top ]

addToListArrayRow [line 1088]

void addToListArrayRow(
String
$action, 
&$arr, int
$nr, String
$fieldprefix, int
$flags, [
$edit = false], [atkDataGrid
$grid = null], [
$column = '*'], 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:
atkDataGrid	$grid:
	$column:

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 211]

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.

Framework method. It should not be necessary to call this method directly. This implementation performs a join to retrieve the target records' data, unless AF_ONETOONE_LAZY is set, in which case loading is delayed and performed later using the load() method. For update and insert queries, this method does nothing. These are handled by the store() method.

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:

atkSecureRelation::addToQuery() : This function in the atkOneToOneRelation store the record of the parentnode in the DB with the reference key of the other table.

[ Top ]

addToSearchformFields [line 1253]

void addToSearchformFields(

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

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

For original documentation for this method, please see the atkAttribute class

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
array	$currentSearchMode:	current search mode
	&$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 ]

addToViewArray [line 855]

void addToViewArray(
String
$mode, 
&$arr, 
&$defaults, array
$arr, array
$defaults 
)

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

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

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

Parameters:

String	$mode:	the mode ("view")
array	$arr:	pointer to the view array
array	$defaults:	pointer to the default values array
	&$arr:
	&$defaults:

Redefinition of:

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

[ Top ]

db2value [line 367]

String db2value(
array
$rec 
)

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

For the regular atkAttribute, this means escaping things like quotes and slashes. Derived attributes may reimplement this for their own conversion. This is the exact opposite of the db2value method.

Parameters:

array

$rec:

The record that holds this attribute's value.

API Tags:

Return:

The database compatible value

Redefinition of:

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

[ Top ]

delete [line 333]

boolean delete(
array
$record 
)

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

Note that the framework only calls the method when the AF_CASCADE_DELETE flag is set. When calling this method, the detail record belonging to the master record is deleted.

Parameters:

array

$record:

The record that is deleted.

API Tags:

Return:

true if cleanup was successful, false otherwise.

Redefinition of:

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

[ Top ]

destinationHasRelation [line 635]

boolean destinationHasRelation(
)

Determine the type of the attribute on the other side.

On the other side of a oneToOneRelation (in the destination node), there may be a regular atkAttribute for the referential key, or an atkOneToOneRelation pointing back at the source. This method discovers which of the 2 cases we are dealing with.

API Tags:

Return:

True if the attribute on the other side is a relation, false if not.

[ Top ]

display [line 133]

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

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

The atkOneToOneRelation displays all values from the destination records in "view" mode. In "list" mode, the record descriptor of the target record is displayed.

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)

API Tags:

Return:

HTML String

Redefinition of:

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

[ Top ]

edit [line 161]

void edit(
)

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

Because of the AF_INTEGRATE feature, the edit() method has a void implementation. The actual edit code is handled by addToEditArray().

Redefinition of:

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

[ Top ]

fetchMeta [line 399]

void fetchMeta(
)

Initialize this destinations attribute sizes.

Redefinition of:

atkAttribute::fetchMeta(): Fetch the metadata about this attrib from the table metadata, and process it.

[ Top ]

fetchValue [line 419]

String fetchValue(
array
$postvars 
)

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

This implementation uses the destination node to fetch any field that belongs to the other side of the relation.

Parameters:

array

$postvars:

The array with html posted values ($_POST, for example) that holds this attribute's value.

API Tags:

Return:

The internal value

Redefinition of:

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

[ Top ]

getAdditionalTabs [line 992]

array getAdditionalTabs(
String
$action 
)

Get list of additional tabs.

Attributes can add new tabs to tabbed screens. This method will be called to retrieve the tabs. When AF_ONETOONE_INTEGRATE is set, the atkOneToOneRelation adds tabs from the destination node to the tab screen, so the attributes are seamlessly integrated but still on their own tabs.

Parameters:

String

$action:

The action for which additional tabs should be loaded.

API Tags:

Return:

The list of tabs to add to the screen.

Redefinition of:

atkAttribute::getAdditionalTabs(): Get list of additional tabs.

[ Top ]

getDestinationFilterCondition [line 305]

String getDestinationFilterCondition(
[string
$fieldaliasprefix = ""] 
)

Construct the filter statement for filters that are set for the destination node (m_destinationFilter).

Parameters:

string

$fieldaliasprefix:

API Tags:

Return:	A where clause condition.
Access:	private

[ Top ]

getFilter [line 960]

void getFilter(
)

API Tags:

Deprecated:

Use getDestinationFilterCondition() instead.

[ Top ]

getJoinCondition [line 1231]

string getJoinCondition(

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

Returns the condition which can be used when calling atkQuery's addJoin() method Joins the relation's owner with the destination

Parameters:

atkQuery	$query:	The query object
string	$tablename:	The name of the table
string	$fieldalias:	The field alias
	&$query:

API Tags:

Return:

condition the condition that can be pasted into the query

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 ]

getSearchCondition [line 1142]

String getSearchCondition(

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

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

Parameters:

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

API Tags:

Return:

The searchcondition to use.

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

hide [line 665]

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

Returns a piece of html code for hiding this attribute in an HTML form, while still posting its values. (<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 ]

initialValue [line 170]

array initialValue(
)

Set the initial values of this attribute

API Tags:

Return:

Array with initial values

Redefinition of:

atkAttribute::initialValue(): Initial value. Returns the initial value for this attribute which will be used in the add form etc.

[ Top ]

isEmpty [line 917]

boolean isEmpty(
array
$record 
)

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

Parameters:

array

$record:

The record that holds this attribute's value.

Information Tags:

Todo:

This method is not currently implemented properly and returns false in all cases.

Redefinition of:

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

[ Top ]

load [line 270]

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.

Redefined in descendants as:

atkPolymorphicOneToOneRelation::load() : Retrieve detail records from the database.
atkSecureRelation::load() : This function in the atkOneToOneRelation loads the record of the childnode from the DB with the the id from de reference key in childnode.

[ Top ]

loadType [line 499]

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.

Redefined in descendants as:

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

[ Top ]

needsUpdate [line 571]

boolean needsUpdate(
array
$record 
)

Needs update?

Parameters:

array

$record:

the record

API Tags:

Return:

needs update

Redefinition of:

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.

[ Top ]

showOnTab [line 1014]

boolean showOnTab(
String
$tab 
)

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

Parameters:

String

$tab:

The name of the tab to check.

Redefinition of:

atkAttribute::showOnTab(): Check if the attribute wants to be shown on a certain tab.

[ Top ]

storageType [line 455]

int storageType(
String
$mode 
)

Determine the storage type of this attribute.

With this method, the attribute tells the framework whether it wants to be stored in the main query (addToQuery) or whether the attribute has its own store() implementation. For the atkOneToOneRelation, the results depends on whether the relation is used in master or slave mode.

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

Parameters:

String

$mode:

The type of storage ("add" or "update")

API Tags:

Return:

Bitmask containing information about storage requirements. POSTSTORE when in master mode. PRESTORE|ADDTOQUERY when in slave mode.

Redefinition of:

atkAttribute::storageType(): Determine the storage type of this attribute.

[ Top ]

store [line 520]

boolean store(

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

Store detail record in the database.

Parameters:

atkDb	$db:	The database used by the node.
array	$record:	The master record which has the detail records embedded.
string	$mode:	The mode we're in ("add", "edit", "copy")
	&$db:
	&$record:

API Tags:

Return:

true if store was successful, false otherwise.

[ Top ]

validate [line 934]

void validate(

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

Checks if a value is valid.

For the atkOneToOneRelation, this method delegates the actual validation of values to the destination node.

Parameters:

array	$record:	The record that holds the value for this attribute. If an error occurs, the error will be stored in the 'atkerror' field of the record.
String	$mode:	The mode for which should be validated ("add" or "update")
	&$record:

Redefinition of:

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

[ Top ]

value2db [line 1283]

mixed value2db(
array
$rec 
)

Convert the internal value to the database value

Parameters:

array

$rec:

The record that holds the value for this attribute

API Tags:

Return:

The database value

Redefinition of:

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

[ Top ]

_getStoreValue [line 585]

mixed &_getStoreValue(
Array
&$record 
)

Gets the value to store for the onetoonerelation

Parameters:

Array

&$record:

The record to get the value from

API Tags:

Return:

The value to store

[ Top ]