Docs For Class atkManyToManyRelation
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: general » AllTests » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkOneToManyRelationSessionGridHandler » atkPHPView » atkSessionStore » atkStatementIterator » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkCompatSelector » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkMLSelector » atkmlsplitter » atkRootFrameset » atkSelector » atkSelectorIterator » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHiddenAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlFckAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_saml » auth_server » auth_sspi cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm test » atkCacheTestCase » atkPluginTestCase » atkTestCase » test_sql_whereclause_blacklist_checker db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkdb2db » atkDb2DDL » atkDb2Query » atkDDL » atki5db » atki5DDL » atki5query » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer db-statement » atkCompatStatement » atkMySQLiStatement » atkStatement » atkStatementException » atkStatementParser console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToOneRelation » atkPolymorphicOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation session » atkMockSessionManager » atkSessionManager » atkState modules » atkModule » mod_test listeners » atkRecycleBin interface » atkServer » atkSoapServer wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » AllTests.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » bootstrap.inc » bootstrap.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atki5db.inc » class.atki5ddl.inc » class.atki5query.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atkmocksessionmanager.inc » class.atknode.inc » class.atknodevalidator.inc » class.atkonetomanyrelationsessiongridhandler.inc » class.atkphpview.inc » class.atkpolymorphiconetoonerelation.inc » class.atksessionstore.inc » class.atkstatementiterator.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » tooltip.tpl.php » upload.php » util.php » version.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhiddenattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlfckattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkdb2db.inc » class.atkdb2ddl.inc » class.atkdb2query.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc db-statement » class.atkcompatstatement.inc » class.atkmysqlistatement.inc » class.atkstatement.inc » class.atkstatementexception.inc » class.atkstatementparser.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc listeners » class.atkrecyclebin.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_saml.inc » class.auth_server.inc » class.auth_sspi.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » top.php » welcome.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkplugintestcase.inc » class.atktestcase.inc testcases » class.atkabstractsearchhandler.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconf.php » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkcompatselector.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlselector.inc » class.atkmlsplitter.inc » class.atkselector.inc » class.atkselectoriterator.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
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): 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_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

mixed   $m_limit  
mixed   $m_link  
mixed   $m_linkInstance  
mixed   $m_localFilter  
mixed   $m_localKey  
mixed   $m_ownerFields  
mixed   $m_remoteKey  
mixed   $m_selectableRecordCountCache  
mixed   $m_selectableRecordsCache  
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
void   clearSelectableCache()   Clears the selectable record count and records cache.
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.
atkNode   getLink()   Returns the link instance.
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.
int   getSelectableRecordCount()   Returns the selectable record count. The count is cached unless the $force parameter is set to true
array   getSelectableRecords()   Returns the selectable records for this relation. The records are cached unless the $force parameter is set to true.
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
void   _addRecord()   Add new link record to the database.
array   _createRecord()   Create new link record.
void   _deleteRecord()   Delete existing link record.
void   _extractSelectedRecordsByKey()   Extracts the selected records from the owner instance record for this relation and index them by their primary key selector string.
void   _getExistingRecordsByKey()   Returns an array with the existing records indexed by their primary key selector string.
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.
void   _updateRecord()   Update existing link record.

[ Top ]

Properties

mixed   $m_limit [line 50]
API Tags:
Access:  protected


Redefined in descendants as:

[ Top ]
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_selectableRecordCountCache = array() [line 53]
API Tags:
Access:  private


[ Top ]
mixed   $m_selectableRecordsCache = array() [line 52]
API Tags:
Access:  private


[ Top ]
mixed   $m_store_deletion_filter = "" [line 46]

[ Top ]

Methods

Constructor atkManyToManyRelation  [line 72]

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

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

  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 ]
clearSelectableCache  [line 198]

  void clearSelectableCache( )

Clears the selectable record count and records cache.


API Tags:
Access:  public


[ Top ]
createLink  [line 243]

  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:

[ Top ]
delete  [line 510]

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

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

  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:

[ Top ]
edit  [line 432]

  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:

[ Top ]
fetchValue  [line 852]

  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:

[ Top ]
getLink  [line 268]

  atkNode getLink( )

Returns the link instance.

The link has to be created first for this method to work.


API Tags:
Return:  link instance
Access:  public


[ Top ]
getLocalKey  [line 279]

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

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

  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 ]
getSelectableRecordCount  [line 141]

  int getSelectableRecordCount( [array $record = array()], [string $mode = ''], [boolean $force = false]  )

Returns the selectable record count. The count is cached unless the $force parameter is set to true

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

API Tags:
Access:  public


[ Top ]
getSelectableRecords  [line 172]

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

Returns the selectable records for this relation. The records are cached unless the $force parameter is set to true.

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

API Tags:
Return:  selectable records
Access:  public


[ Top ]
getSelectedRecords  [line 212]

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

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

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

  void load( atkDb $notused, array $record  )

load function

Parameters:
atkDb   $notused: 
array   $record: 


Redefined in descendants as:

[ Top ]
parseDestinationFilter  [line 103]

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

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

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

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

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

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

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

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

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

Stores the values in the database

Parameters:
atkDb   $db:  database instance
array   $record:  owner instance record
string   $mode:  storage mode


Redefined in descendants as:

[ Top ]
_addRecord  [line 646]

  void _addRecord( array $record, int $index, string $mode  )

Add new link record to the database.

Parameters:
array   $record:  link record
int   $index:  (new) index (0-based)
string   $mode:  storage mode

API Tags:
Access:  protected


[ Top ]
_createRecord  [line 614]

  array _createRecord( string $selectedKey, array $selectedRecord, array $ownerRecord, int $index  )

Create new link record.

Parameters:
string   $selectedKey:  primary key selector string of destination record
array   $selectedRecord:  selected destination record (might only contain the key attributes)
array   $ownerRecord:  owner instance record
int   $index:  (new) index (0-based)

API Tags:
Return:  new link record (not saved yet!)
Access:  protected


Redefined in descendants as:

[ Top ]
_deleteRecord  [line 579]

  void _deleteRecord( array $record  )

Delete existing link record.

Parameters:
array   $record:  link record

API Tags:
Access:  protected


[ Top ]
_extractSelectedRecordsByKey  [line 553]

  void _extractSelectedRecordsByKey( array $record  )

Extracts the selected records from the owner instance record for this relation and index them by their primary key selector string.

Parameters:
array   $record:  record

API Tags:
Access:  protected


[ Top ]
_getExistingRecordsByKey  [line 530]

  void _getExistingRecordsByKey( atkDb $db, array $record, string $mode  )

Returns an array with the existing records indexed by their primary key selector string.

Parameters:
atkDb   $db:  database instance
array   $record:  record
string   $mode:  mode

API Tags:
Access:  protected


[ Top ]
_getLoadWhereClause  [line 481]

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

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

Returns the selectable record count.

Parameters:
array   $record: 
string   $mode: 

API Tags:
Access:  protected


[ Top ]
_getSelectableRecords  [line 88]

  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 ]
_updateRecord  [line 598]

  void _updateRecord( array $record, int $index  )

Update existing link record.

Parameters:
array   $record:  link record
int   $index:  (new) index (0-based)

API Tags:
Access:  protected


Redefined in descendants as:

[ Top ]
Home | About | Contact