Docs For Class atkSecureRelation
Class: atkSecureRelation
Source Location: /relations/class.atksecurerelation.incClass 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] atkAttribute | --atkRelation | --atkOneToOneRelation | --atkSecureRelationAuthor(s):
|
[ Top ]
Inherited from parent
| Inherited Properties | Inherited Methods |
|---|---|
|
Inherited From atkOneToOneRelation Inherited From atkRelation Inherited From atkAttribute
|
Inherited From atkOneToOneRelation
Inherited From atkRelation
Inherited From atkAttribute
|
[ 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 ]
Methods
Constructor atkSecureRelation [line 69]
|
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]
|
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]
|
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]
|
Decrypt the field
Parameters:| array | $record: | |
| array | $field: |
API Tags:
| Return: | The decrypted value |
[ Top ]
getLinkPassword [line 129]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
Set the name of the cache field
Parameters:| string | $fieldname: | The cache fieldname |
[ Top ]
_getJoinCondition [line 396]
|
Returns the condition which can be used when calling atkQuery's addJoin() method
Joins the relation's owner with the destination
[ Top ]