Docs For Class atkRelation

Child Class	Description
atkManyToManyRelation	Many to many relation. Should not be used directly.
atkManyToOneRelation	A N:1 relation between two classes.
atkMatrixRelation	Many2Many relation that is represented by a clickable matrix.
atkOneToManyRelation	Implementation of one-to-many relationships.
atkOneToOneRelation	Implementation of one-to-one relationships.

[ Top ]

Inherited from parent

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

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_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 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

Object	$m_descHandler	Descriptor handler.
String	$m_descTemplate	Descriptor template for destination node.
String	$m_destination
String	$m_destinationFilter
atkNode	$m_destInstance

[ Top ]

Method Summary

atkRelation	atkRelation()	Constructor
void	addDestinationFilter()	Adds a filter value to the destination filter.
boolean	createDestination()	Create the instance of the destination.
String	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().
String	descriptor()	Descriptor handler. Forwards description handler calls to the real description handler.
String	display()	Return a displayable string for a record.
String	getAddLabel()	Attempts to get a translated label which can be used when composing an "add" link
string\|array	getChildSearchMode()	Get the searchmode for nested/child attributes.
Object	&getDescriptorHandler()	Get descriptor handler.
String	getDescriptorTemplate()	Returns the descriptor template for the destination node.
atkNode	&getDestination()	Returns an instance of the node that the relation points to.
String	getDestinationFilter()	Returns the destination filter.
String	getJoinCondition()	Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.
array	getSearchModes()	Retrieve the searchmodes supported by the relation.
boolean	isEmpty()	Check if the relation is empty
$filter	parseFilter()	Parses the destination filter
void	setDescriptorHandler()	Set descriptor handler.
void	setDescriptorTemplate()	Sets the descriptor template for the destination node.
void	setDestinationFilter()	Sets the destination filter.
void	validate()	Validation method. Empty implementation. Derived classes may override this function.
string	_cleanupDestinationFilter()	Remove redundant (more than 1 subsequently) spaces from the filter string.

[ Top ]

Properties

Object $m_descHandler = NULL [line 54]

Descriptor handler.

[ Top ]

String $m_descTemplate = NULL [line 48]

Descriptor template for destination node.

[ Top ]

String $m_destination [line 32]

[ Top ]

String $m_destinationFilter = "" [line 42]

[ Top ]

atkNode $m_destInstance = "" [line 37]

[ Top ]

Methods

Constructor atkRelation [line 62]

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

Constructor

Parameters:

String	$name:	The name of the relation.
String	$destination:	The destination node (in module.name notation)
int	$flags:	Flags for the relation

[ Top ]

addDestinationFilter [line 133]

void addDestinationFilter(
String
$filter 
)

Adds a filter value to the destination filter.

Parameters:

String

$filter:

Filter to be added to the destination filter.

Redefined in descendants as:

atkManyToManySelectRelation::addDestinationFilter() : Adds a filter value to the destination filter.

[ Top ]

createDestination [line 202]

boolean createDestination(
)

Create the instance of the destination.

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

API Tags:

Return:

true if succesful, false if something went wrong.

Redefined in descendants as:

atkManyToManySelectRelation::createDestination() : Create the instance of the destination and copy the destination to the the many to one relation
atkMetaOneToManyRelation::createDestination() : Create the instance of the destination.
atkMetaOneToOneRelation::createDestination() : Create the instance of the destination.

[ Top ]

dbFieldType [line 322]

String 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().

API Tags:

Abstract:

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

descriptor [line 187]

String descriptor(
array
$record, 
&$node, atkNode
$node 
)

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

Parameters:

array	$record:	The record
atkNode	$node:	The atknode object
	&$node:

API Tags:

Return:

with the descriptor

[ Top ]

display [line 249]

String display(
array
$record 
)

Return a displayable string for a record.

Parameters:

array

$record:

The record that contains the information to display.

API Tags:

Return:

a displayable string for this value.

Redefinition of:

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

Redefined in descendants as:

atkManyToManyRelation::display() : Returns a displayable string for this value.
atkExtendableShuttleRelation::display() : Display the value of this relation
atkManyToOneRelation::display() : Returns a displayable string for this value.
atkMatrixRelation::display() : Empty display function
atkOneToManyRelation::display() : Returns a displayable string for this value, to be used in HTML pages.
atkOneToOneRelation::display() : Returns a displayable string for this value, to be used in HTML pages.

[ Top ]

getAddLabel [line 361]

String getAddLabel(
)

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

API Tags:

Return:

Localised "add" label

Redefined in descendants as:

atkOneToManyRelation::getAddLabel() : Attempts to get a translated label which can be used when composing an "add" link

[ Top ]

getChildSearchMode [line 308]

string|array getChildSearchMode(
string|array
$searchmode, string
$childname 
)

Get the searchmode for nested/child attributes.

Parameters:

string\|array	$searchmode:	searchmode
string	$childname:	the child attribute's name

API Tags:

Return:	the child searchmode
Access:	protected

[ Top ]

getDescriptorHandler [line 147]

Object &getDescriptorHandler(
)

Get descriptor handler.

API Tags:

Return:

descriptor handler

[ Top ]

getDescriptorTemplate [line 165]

String getDescriptorTemplate(
)

Returns the descriptor template for the destination node.

API Tags:

Return:

The descriptor Template

[ Top ]

getDestination [line 347]

atkNode &getDestination(
)

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

API Tags:

Return:

The node that this relation points to, or NULL if the destination is not valid.

[ Top ]

getDestinationFilter [line 73]

String getDestinationFilter(
)

Returns the destination filter.

API Tags:

Return:

The destination filter.

[ Top ]

getJoinCondition [line 337]

String getJoinCondition(

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

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

Parameters:

atkQuery	$query:	The query object
string	$tablename:	The tablename
string	$fieldalias:
	&$query:

API Tags:

Return:

SQL string for joining the owner with the destination. Defaults to false.

Redefined in descendants as:

atkManyToOneRelation::getJoinCondition() : Returns the condition (SQL) that should be used when we want to join a relation's owner node with the parent node.
atkOneToManyRelation::getJoinCondition() : Returns the condition (SQL) that should be used when we want to join an owner node with the destination node of the atkOneToManyRelation.
atkOneToOneRelation::getJoinCondition() : Returns the condition which can be used when calling atkQuery's addJoin() method Joins the relation's owner with the destination

[ Top ]

getSearchModes [line 291]

array getSearchModes(
)

Retrieve the searchmodes supported by the relation.

API Tags:

Return:

A list of supported searchmodes.

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

isEmpty [line 274]

boolean isEmpty(
array
$record 
)

Check if the relation is empty

Parameters:

array

$record:

The record to check

API Tags:

Return:

true if a destination record is present. False if not.

Redefinition of:

atkAttribute::isEmpty(): Check if a record has an empty value for this attribute.

Redefined in descendants as:

atkManyToManyRelation::isEmpty() : Check if the attribute is empty
atkMatrixRelation::isEmpty() : Check if the relation is empty
atkOneToManyRelation::isEmpty() : Override isEmpty function - in a oneToMany relation we should check if the relation contains any records. When there aren't any, the relation is empty, otherwise it isn't
atkOneToOneRelation::isEmpty() : Check if a record has an empty value for this attribute.

[ Top ]

parseFilter [line 382]

$filter parseFilter(
string
$destFilter, array
$record 
)

Parses the destination filter

Parameters:

string	$destFilter:	filter to parse
array	$record:	the current record

API Tags:

Return:

string filter.

[ Top ]

setDescriptorHandler [line 156]

void setDescriptorHandler(

&$handler, Object
$handler 
)

Set descriptor handler.

Parameters:

Object	$handler:	The descriptor handler.
	&$handler:

[ Top ]

setDescriptorTemplate [line 174]

void setDescriptorTemplate(
String
$template 
)

Sets the descriptor template for the destination node.

Parameters:

String

$template:

The descriptor template.

[ Top ]

setDestinationFilter [line 82]

void setDestinationFilter(
String
$filter 
)

Sets the destination filter.

Parameters:

String

$filter:

The destination filter.

Redefined in descendants as:

atkManyToManySelectRelation::setDestinationFilter() : Sets the destination filter.

[ Top ]

validate [line 265]

void validate(

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

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

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:

API Tags:

Abstract:

Redefinition of:

atkAttribute::validate(): Checks if a value is valid.

Redefined in descendants as:

atkManyToOneRelation::validate() : Validate if the record we are referring to really exists.
atkMatrixRelation::validate() : Validate this relation
atkOneToOneRelation::validate() : Checks if a value is valid.

[ Top ]

_cleanupDestinationFilter [line 96]

string _cleanupDestinationFilter(
string
$filter 
)

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

This prevents the filter from rapidly becoming too long to be passed in the URL if enters are used in code to make the filter readable.

Parameters:

string

$filter:

[ Top ]