Docs For Class atkSecureRelation
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 atkSecureRelation [ package: atk ]

Class: atkSecureRelation

Source Location: /relations/class.atksecurerelation.inc

Class atkSecureRelation

Class Overview

Relationship that can link 2 tables based on a secure link that can not be decrypted when not logged in through an atk application.

This effectively secures the database so that data in two tables can not be correlated by mischievous access to the database.

Located in /relations/class.atksecurerelation.inc [line 31]

Wiki documentation

atkAttribute
   |
   --atkRelation
      |
      --atkOneToOneRelation
         |
         --atkSecureRelation
Author(s): Information Tags:

Properties

Methods

[ Top ]

Inherited from parent

Inherited Properties Inherited Methods

Inherited From atkOneToOneRelation

atkOneToOneRelation::$m_refKey

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 atkOneToOneRelation

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

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_cachefield  
mixed   $m_crypt  
mixed   $m_destsearch  
mixed   $m_keylength  
mixed   $m_keylookup  
mixed   $m_linkbackfield  
mixed   $m_linkfield  
mixed   $m_linkpass  
mixed   $m_linktable  
mixed   $m_linkuserfield  
mixed   $m_ownersearch  
mixed   $m_records  
mixed   $m_searcharray  
mixed   $m_searching  

[ Top ]

Method Summary

atkSecureRelation   atkSecureRelation()   Creates an atkSecureRelation, similar to an atkOneToOne relation only encrypted
void   addToListArrayHeader()   Adds the attribute / field to the list header. This includes the column name and search field.
void   addToQuery()   This function in the atkOneToOneRelation store the record of the parentnode in the DB with the reference key of the other table.
string   decrypt()   Decrypt the field
string   getLinkPassword()   Gets the password for the link for more security the administrator gets a random password. You have to capture in your application that the administrator is only able to insert the first record in this relation and make also a useracount with it.
String   getSearchCondition()   Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
array   load()   This function in the atkOneToOneRelation loads the record of the childnode from the DB with the the id from de reference key in childnode.
int   loadType()   Determine the load type of this attribute.
void   newUser()   For creating a new user put the linkpassword in the db
void   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.
void   setCacheField()   Set the name of the cache field
void   _getJoinCondition()   Returns the condition which can be used when calling atkQuery's addJoin() method

[ Top ]

Properties

mixed   $m_cachefield [line 46]

[ Top ]
mixed   $m_crypt = NULL [line 33]

[ Top ]
mixed   $m_destsearch [line 45]

[ Top ]
mixed   $m_keylength [line 37]

[ Top ]
mixed   $m_keylookup = array() [line 39]

[ Top ]
mixed   $m_linkbackfield [line 43]

[ Top ]
mixed   $m_linkfield [line 35]

[ Top ]
mixed   $m_linkpass [line 42]

[ Top ]
mixed   $m_linktable [line 34]

[ Top ]
mixed   $m_linkuserfield = "username" [line 36]

[ Top ]
mixed   $m_ownersearch [line 44]

[ Top ]
mixed   $m_records = array() [line 40]

[ Top ]
mixed   $m_searcharray = array() [line 41]

[ Top ]
mixed   $m_searching = false [line 38]

[ Top ]

Methods

Constructor atkSecureRelation  [line 69]

  atkSecureRelation atkSecureRelation( string $name, string $destination, string $linktable, string $linkfield, string $linkbackfield, int $keylength, [ $refKey = ""], string $encryption, [int $flags = 0], string $refKey=""  )

Creates an atkSecureRelation, similar to an atkOneToOne relation only encrypted

Parameters:
string   $name:  The unique name of the attribute. In slave mode, this corresponds to the foreign key field in the database table.
string   $destination:  The destination node (in module.nodename notation)
string   $linktable:  The table we link to
string   $linkfield:  The field we link to
string   $linkbackfield: 
int   $keylength:  The length of the encryption key
string   $refKey="":  In master mode, this specifies the foreign key field from the destination node that points to the master record. In slave mode, this parameter should be empty.
string   $encryption:  The encryption to use
int   $flags:  Attribute flags that influence this attributes' behavior.
   $refKey: 


[ Top ]
addToListArrayHeader  [line 103]

  void addToListArrayHeader( String $action, &$arr, String $fieldprefix, int $flags, array $atksearch, String $atkorderby, array $arr  )

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

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

Parameters:
String   $action:  the action that is being performed on the node
array   $arr:  reference to the the recordlist array
String   $fieldprefix:  the fieldprefix
int   $flags:  the recordlist flags
array   $atksearch:  the current ATK search list (if not empty)
String   $atkorderby:  the current ATK orderby string (if not empty)
   &$arr: 


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

[ Top ]
addToQuery  [line 191]

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

This function in the atkOneToOneRelation store the record of the parentnode in the DB with the reference key of the other table.

So we encrypt the reference key before we call the method. For more documentation see the atkOneToOneRelation

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:
atkOneToOneRelation::addToQuery()
Adds this attribute to database queries.

[ Top ]
decrypt  [line 339]

  string decrypt( array $record, array $field  )

Decrypt the field

Parameters:
array   $record: 
array   $field: 

API Tags:
Return:  The decrypted value


[ Top ]
getLinkPassword  [line 129]

  string getLinkPassword( string $linktable, string $linkfield, [string $encryption = ""]  )

Gets the password for the link for more security the administrator gets a random password. You have to capture in your application that the administrator is only able to insert the first record in this relation and make also a useracount with it.

Parameters:
string   $linktable:  the table where we find the linkpass
string   $linkfield:  the field where we find the encrypted linkpass
string   $encryption:  The encryption to use

API Tags:
Return:  the password for the link


[ Top ]
getSearchCondition  [line 477]

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

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

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

API Tags:
Return:  The searchcondition to use.


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

[ Top ]
load  [line 231]

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

This function in the atkOneToOneRelation loads the record of the childnode from the DB with the the id from de reference key in childnode.

So we decrypt the reference key before we call the method. For more documentation see the atkOneToOneRelation

Parameters:
atkDb   $db:  The database object
array   $record:  The record
string   $mode:  The mode we're in ("add", "edit", "copy")
   &$db: 

API Tags:
Return:  The loaded records


Redefinition of:
atkOneToOneRelation::load()
Retrieve detail records from the database.

[ Top ]
loadType  [line 432]

  int loadType( String $mode, [bool $searching = false]  )

Determine the load type of this attribute.

Parameters:
String   $mode:  The type of load (view,admin,edit etc)
bool   $searching:  Is this a search?

API Tags:
Return:  Bitmask containing information about load requirements. POSTLOAD|ADDTOQUERY when AF_ONETOONE_LAZY is set. ADDTOQUERY when AF_ONETOONE_LAZY is not set.


Redefinition of:
atkOneToOneRelation::loadType()
Determine the load type of this attribute.

[ Top ]
newUser  [line 384]

  void newUser( string $id, string $pass  )

For creating a new user put the linkpassword in the db

Parameters:
string   $id:  the id of the user to create
string   $pass:  the password for the user


[ Top ]
searchCondition  [line 458]

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

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

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 ]
setCacheField  [line 86]

  void setCacheField( [string $fieldname = "cache"]  )

Set the name of the cache field

Parameters:
string   $fieldname:  The cache fieldname


[ Top ]
_getJoinCondition  [line 396]

  void _getJoinCondition( )

Returns the condition which can be used when calling atkQuery's addJoin() method

Joins the relation's owner with the destination



[ Top ]
Home | About | Contact