Docs For Class atkRelation
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: skel- » atkAppSuite utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkmlsplitter » atkNavigator » atkRootFrameset » atkSelector » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo » listenerTest » simplevisitor » testNode » test_atkactionlistener » test_atkclassloader » test_atkcolumnconfig » test_atkDirectoryTraverser » test_atklistattribute » test_atkStringParser » test_atkTextMarker general » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkSessionStore » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree » triggerNode fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler » DateAttributeWrapper » dummyTagAttribute » Stub_atkNew » test_atkattributeedithandler » test_atkBoolAttribute » test_atkCalculatorAttribute » test_atkcolorpickerattribute » test_atkDataGrid » test_atkdatanode » test_atkDateAttribute » test_atkFileAttribute » test_atkfrontcontroller » test_atkiputils » test_atkManyToOneRelation » test_atknode » test_atkRelation » test_atktagattribute » test_atkwizard » test_tabs » uriPartsFrontControllerMock 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 » test_atkimporthandler 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 » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » 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 » test_atkattribute » test_atkmultiselectattribute » test_atktextattribute 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_server » auth_sspi » test_atkMockSecurityManager » test_atkUrlVault cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm » test_atkcache_apc » test_atkcache_eaccelerator » test_atkcache_file » test_atkcache_memcache » test_atkcache_var » test_atkcache_xcache » test_atkcache_zp_disk » test_atkcache_zp_output » test_atkcache_zp_shm test » ArrayHtmlReporter » ArrayTextReporter » atkCacheTestCase » atkPHPUnitTestCaseCollector » atkPluginTestCase » atkSimpleTestTestCaseCollector » atkTestCase » atkTestCaseCollector » atkTestReporter » atkTestSuite » atkTestTraverser » test_atkMockNode » test_atktestcase » test_atktools » Test_DbConfigs » test_sql_whereclause_blacklist_checker » test_tabsecurity » test_triggers db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkDDL » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery » test_atkdb recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer 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 » atkOneToManyRelationSessionGridHandler » atkOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation modules » atkModule » mod_test interface » atkServer » atkSoapServer session » atkSessionManager » atkState wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel attribute » test_atkcurrencyattribute » test_atknumberattribute
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atknode.inc » class.atknodevalidator.inc » class.atksessionstore.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 » class.test_triggers.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 » upload.php » util.php » version.inc attribute » class.test_atkcurrencyattribute.inc » class.test_atknumberattribute.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.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.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 » class.test_atkattribute.inc » class.test_atkmultiselectattribute.inc » class.test_atktextattribute.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 » class.test_atkcache_apc.inc » class.test_atkcache_eaccelerator.inc » class.test_atkcache_file.inc » class.test_atkcache_memcache.inc » class.test_atkcache_var.inc » class.test_atkcache_xcache.inc » class.test_atkcache_zp_disk.inc » class.test_atkcache_zp_output.inc » class.test_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.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 » class.test_atkdb.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 » class.test_atkimporthandler.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 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.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_server.inc » class.auth_sspi.inc » class.test_atkmocksecuritymanager.inc » class.test_atkurlvault.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 » test.php » top.php » welcome.php skel- » atkappsuite.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkphpunittestcasecollector.inc » class.atkplugintestcase.inc » class.atksimpletesttestcasecollector.inc » class.atktestcase.inc » class.atktestcasecollector.inc » class.atktestreporter.inc » class.atktestsuite.inc » class.atktesttraverser.inc » class.test_atkmocknode.inc » class.test_atktestcase.inc » class.test_atktools.inc » class.test_dbconfigs.inc » class.test_tabsecurity.inc testcases » class.atkabstractsearchhandler.inc » class.stub_atknew.inc » class.test_atkattributeedithandler.inc » class.test_atkboolattribute.inc » class.test_atkcalculatorattribute.inc » class.test_atkcolorpickerattribute.inc » class.test_atkdatagrid.inc » class.test_atkdatanode.inc » class.test_atkdateattribute.inc » class.test_atkfileattribute.inc » class.test_atkfrontcontroller.inc » class.test_atkiputils.inc » class.test_atkmanytoonerelation.inc » class.test_atknode.inc » class.test_atkrelation.inc » class.test_atktagattribute.inc » class.test_atkwizard.inc » class.test_tabs.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.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.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.atkmlsplitter.inc » class.atknavigator.inc » class.atkselector.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 » class.test_atkactionlistener.inc » class.test_atkclassloader.inc » class.test_atkcolumnconfig.inc » class.test_atkdirectorytraverser.inc » class.test_atklistattribute.inc » class.test_atkstringparser.inc » class.test_atktextmarker.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkRelation [ package: atk ]

Class: atkRelation

Source Location: /relations/class.atkrelation.inc

Class atkRelation

Descendants

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_dependees
atkAttribute::$m_disabledModes
atkAttribute::$m_flags
atkAttribute::$m_forceinsert
atkAttribute::$m_forceupdate
atkAttribute::$m_htmlid
atkAttribute::$m_index
atkAttribute::$m_initialValue
atkAttribute::$m_initial_hidden
atkAttribute::$m_label
atkAttribute::$m_loadType
atkAttribute::$m_manual_paint
atkAttribute::$m_maxsize
atkAttribute::$m_module
atkAttribute::$m_name
atkAttribute::$m_onchangecode
atkAttribute::$m_onchangehandler_init
atkAttribute::$m_order
atkAttribute::$m_owner
atkAttribute::$m_ownerInstance
atkAttribute::$m_searchmode
atkAttribute::$m_searchsize
atkAttribute::$m_sections
atkAttribute::$m_size
atkAttribute::$m_storageType
atkAttribute::$m_tabs

Inherited From atkAttribute

atkAttribute::atkAttribute()
Constructor
atkAttribute::addCSSClass()
Add a CSS class for this attribute on an HTML form.
atkAttribute::addDependee()
Indicate that another attribute depends on this attribute, and that if this attribute is updated, the dependent attribute needs to be updated as well.
atkAttribute::addDisabledMode()
Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags).
atkAttribute::addFlag()
Adds a flag to the attribute.
atkAttribute::addOnChangeHandler()
Add a javascript onchange event handler.
atkAttribute::addToEditArray()
Adds the attribute's edit / hide HTML code to the edit array.
atkAttribute::addToListArrayHeader()
Adds the attribute / field to the list header. This includes the column name and search field.
atkAttribute::addToListArrayRow()
Adds the attribute / field to the list row. And if the row is totalisable also to the total.
atkAttribute::addToQuery()
Adds this attribute to database queries.
atkAttribute::addToSearchformFields()
Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.
atkAttribute::addToViewArray()
Adds the attribute's view / hide HTML code to the view array.
atkAttribute::db2value()
Converts a database value to an internal value.
atkAttribute::dbFieldSize()
Return the size of the field in the database.
atkAttribute::dbFieldType()
Return the database field type of the attribute.
atkAttribute::delete()
The delete method is called by the framework to inform the attribute that a record is deleted.
atkAttribute::deleteAllowed()
Check if delete of the record is allowed.
atkAttribute::display()
Returns a displayable string for this value, to be used in HTML pages.
atkAttribute::edit()
Returns a piece of html code that can be used in a form to edit this attribute's value.
atkAttribute::equal()
This function is called to compare if two records are considered equal by this attribute.
atkAttribute::escapeSQL()
Escape string for use in a query.
atkAttribute::extendedSort()
Retrieves the sort options and sort order.
atkAttribute::fetchMeta()
Fetch the metadata about this attrib from the table metadata, and process it.
atkAttribute::fetchValue()
Convert values from an HTML form posting to an internal value for this attribute.
atkAttribute::fieldName()
Returns the name of the attribute.
atkAttribute::formName()
Retrieve the name of the attribute in HTML forms.
atkAttribute::getAdditionalTabs()
Get list of additional tabs.
atkAttribute::getAttributeHtmlId()
Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it.
atkAttribute::getColumn()
Get column.
atkAttribute::getCSSClassAttribute()
Retrieve the attribute for the HTML-tag for this atkAttribute.
atkAttribute::getCSSClasses()
Retrieve the CSS classes that were registered for this attribute
atkAttribute::getDb()
Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned.
atkAttribute::getDependees()
Retrieve the dependees for this attribute.
atkAttribute::getEdit()
Retrieve the HTML code for placing this attribute in an edit page.
atkAttribute::getError()
Check if this attribute has errors in the specified error list.
atkAttribute::getFlags()
Returns the full set of flags of the attribute.
atkAttribute::getForceInsert()
Getter for wether or not an attribute is forced to insert
atkAttribute::getForceUpdate()
Getter for wether or not an attribute is forced to update
atkAttribute::getHtmlId()
Return the html identifier (id="") of the attribute. (unique within a
atkAttribute::getLabel()
Get the HTML label of the attribute.
atkAttribute::getModule()
Get the module that this attribute originated from.
atkAttribute::getOrderByStatement()
Retrieves the ORDER BY statement for this attribute's node.
atkAttribute::getOwnerInstance()
Returns the owner instance.
atkAttribute::getRefreshCall()
Returns a JavaScript call for refreshing this attribute.
atkAttribute::getSearchCondition()
Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkAttribute::getSearchFieldName()
Retrieve the fieldname of the attribute in an atksearch form.
atkAttribute::getSearchMode()
Retrieve the current set or default searchmode of this attribute
atkAttribute::getSearchModeFieldname()
Retrieve the searchmode name of the attribute in an atksearch form.
atkAttribute::getSearchModes()
Retrieve the list of searchmodes supported by the attribute.
atkAttribute::getSections()
retrieve the tabs and/or sections for this attribute.
atkAttribute::getTabs()
retrieve the tabs for this attribute.
atkAttribute::getToolTip()
Retrieve the html/javascript code for showing the tooltip for this attribute.
atkAttribute::getView()
Retrieve the html code for placing this attribute in a view page.
atkAttribute::hasDisabledMode()
Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags).
atkAttribute::hasFlag()
Check if the attribute has a certain flag.
atkAttribute::hasStore()
This function is used to check whether a attribute has a store function or not.
atkAttribute::hide()
Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkAttribute::init()
This function is called right after the attribute is added to the node.
atkAttribute::initialValue()
Initial value. Returns the initial value for this attribute which will be used in the add form etc.
atkAttribute::isDepending()
Check whether this attribute depends on other attributes.
atkAttribute::isEmpty()
Check if a record has an empty value for this attribute.
atkAttribute::isInitialHidden()
check whether initially hidden or not
atkAttribute::isManualPaint()
Check wether this attribute should be manually painted (call the edit method) or not.
atkAttribute::isNotNullInDb()
Checks if this attribute is really not null in the database.
atkAttribute::isPosted()
Is there a value posted for this attribute?
atkAttribute::label()
Return the label of the attribute.
atkAttribute::listHeaderSortOrder()
Retrieve the sortorder for the listheader based on the atkColumnConfig
atkAttribute::loadType()
Determine the load type of this attribute.
atkAttribute::maxInputSize()
Determine the maximum length an input field may be.
atkAttribute::needsInsert()
This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call.
atkAttribute::needsUpdate()
This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.
atkAttribute::parseStringValue()
Convert a String representation into an internal value.
atkAttribute::partial()
Handle a partial request for this attribute, different attributes support different partials.
atkAttribute::partial_refresh()
Partial method to refresh the add/edit field for this attribute.
atkAttribute::postInit()
This function is called at the end of the node's init method.
atkAttribute::registerKeyListener()
Register keyboard navigation for this attribute.
atkAttribute::removeDisabledMode()
Removes a disabled mode from the attribute.
atkAttribute::removeFlag()
Removes a flag from the attribute.
atkAttribute::search()
Returns a piece of html code that can be used to get search terms input from the user.
atkAttribute::searchCondition()
Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search.
atkAttribute::searchMode()
Returns piece of html which is used for setting/selecting the search mode for this attribute.
atkAttribute::setAttribSize()
Set the size(s) of the attribute
atkAttribute::setAttributeSearchmode()
Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode.
atkAttribute::setColumn()
Set column.
atkAttribute::setDisabledModes()
Sets the disabled mode flag of the attribute
atkAttribute::setFlags()
Sets the flags of the attribute
atkAttribute::setForceInsert()
Used to force an attribute to update with every addDb() call
atkAttribute::setForceUpdate()
Used to force an attribute to update with every updateDb() call
atkAttribute::setInitialHidden()
Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden.
atkAttribute::setInitialValue()
Set initial value for this attribute.
atkAttribute::setLabel()
Set the label of the attribute
atkAttribute::setLoadType()
Sets the load type.
atkAttribute::setManualPaint()
Set wether the edit() method of this attribute should be called by the framework, or if the edit method is called manually.
atkAttribute::setOwnerInstance()
Sets the owner instance.
atkAttribute::setSections()
Put the attribute on one or more tabs and/or sections.
atkAttribute::setStorageType()
Sets the storage type.
atkAttribute::setTabs()
Put the attribute on one or more tabs.
atkAttribute::showOnTab()
Check if the attribute wants to be shown on a certain tab.
atkAttribute::smartSearchCondition()
Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search.
atkAttribute::sortOptions()
Retrieves the sort options for this attribute which is used in recordlists and search actions.
atkAttribute::sortOrder()
Sets the sortorder options for this attribute which is used in recordlists and search actions.
atkAttribute::storageType()
Determine the storage type of this attribute.
atkAttribute::sum()
Calculate the sum of 2 records.
atkAttribute::text()
Translate using the owner instance's module and type.
atkAttribute::validate()
Checks if a value is valid.
atkAttribute::value2db()
Converts the internal attribute value to one that is understood by the database.
atkAttribute::_registerDependees()
Register change handlers for dependees.
atkAttribute::_renderChangeHandler()
Renders the onchange code on the page.
atkAttribute::__toString()
String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

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:

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

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

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

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

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

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

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

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

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

[ 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 ]
Home | About | Contact