How to update READONLY values in ATK - Revision history

Wayneh at 08:27, 10 March 2018

2018-03-10T08:27:03Z

← Older revision		Revision as of 08:27, 10 March 2018
Line 63:		Line 63:
	The code demonstrated here was tested on ATK 5.5. Prior to this version I was using a custom trick to accomplish the same job. This way of doing is far more elegant.		The code demonstrated here was tested on ATK 5.5. Prior to this version I was using a custom trick to accomplish the same job. This way of doing is far more elegant.

	Copied from FORUM post by -		Copied by WayneH from FORUM post by -
	Jorge Garifuna		Jorge Garifuna
	Professional Web Developer		Professional Web Developer
	Your Web Solution Partner		Your Web Solution Partner
	http://www.GariDigital.com		http://www.GariDigital.com

Wayneh at 08:26, 10 March 2018

2018-03-10T08:26:28Z

← Older revision		Revision as of 08:26, 10 March 2018
Line 38:		Line 38:
	Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:		Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:

	~~''Code:''~~
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	useattrib("atkdateAttribute");		useattrib("atkdateAttribute");

Wayneh at 08:26, 10 March 2018

2018-03-10T08:26:03Z

← Older revision		Revision as of 08:26, 10 March 2018
Line 15:		Line 15:
	To place the date on the field prior to updating the database you would use the preUpdate() function:		To place the date on the field prior to updating the database you would use the preUpdate() function:

	~~''Code:''~~		<syntaxhighlight lang="php">
	// update field before saving		// update field before saving
	function preUpdate(&$record)		function preUpdate(&$record)
Line 23:		Line 23:
	return true;		return true;
	}		}
			</syntaxhighlight>
	As correct as it may seem, this will not update the “modified_date” field on the database, unless you instruct ATK to specifically do so.		As correct as it may seem, this will not update the “modified_date” field on the database, unless you instruct ATK to specifically do so.

Line 32:		Line 32:
	The following code on your constructor will effectively allow you to update the record on the database, while allowing users to view it without the possibility of altering it:		The following code on your constructor will effectively allow you to update the record on the database, while allowing users to view it without the possibility of altering it:

	~~''Code:''~~		<syntaxhighlight lang="php">
	$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));		$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));
	$modified_date->setForceUpdate(true); // for field to be updated on database after edit function		$modified_date->setForceUpdate(true); // for field to be updated on database after edit function
			</syntaxhighlight>
	Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:		Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:

	''Code:''		''Code:''
	<?php		<syntaxhighlight lang="php">
	useattrib("atkdateAttribute");		useattrib("atkdateAttribute");
	class order extends atkNode		class order extends atkNode
Line 57:		Line 57:
	}// end function		}// end function
	}// end class		}// end class
	?>		</syntaxhighlight>

Wayneh at 08:24, 10 March 2018

2018-03-10T08:24:55Z

← Older revision		Revision as of 08:24, 10 March 2018
Line 8:		Line 8:
	Say you have the following ATK code:		Say you have the following ATK code:

	~~''Code:''~~		<syntaxhighlight lang="php">
	$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));		$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));
			</syntaxhighlight>
	By using the AF_READONLY flag, you are instructing ATK that whenever the value for this record is displayed, the user should only be allowed to view it and not change it. The AF_HIFE_ADD flag simply hides the “modified_date” field during the creation of a new record.		By using the AF_READONLY flag, you are instructing ATK that whenever the value for this record is displayed, the user should only be allowed to view it and not change it. The AF_HIFE_ADD flag simply hides the “modified_date” field during the creation of a new record.

Wayneh at 08:23, 10 March 2018

2018-03-10T08:23:14Z

← Older revision		Revision as of 08:23, 10 March 2018
Line 1:		Line 1:
	Mini-Howto (ATK tip) - How to update READONLY values in ATK		'''Mini-Howto (ATK tip) - How to update READONLY values in ATK'''

	Problem:		'''Problem:'''
	If you use the AF_READONLY flag in ATK so that the user cannot modify a record’s value, you may run into problems when you are trying to update that attribute prior to inserting to the database.		If you use the AF_READONLY flag in ATK so that the user cannot modify a record’s value, you may run into problems when you are trying to update that attribute prior to inserting to the database.

Line 8:		Line 8:
	Say you have the following ATK code:		Say you have the following ATK code:

	Code:		''Code:''
	$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));		$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));


	By using the AF_READONLY flag, you are instructing ATK that whenever the value for this record is displayed, the user should only be allowed to view it and not change it. The AF_HIFE_ADD flag simply hides the “modified_date” field during the creation of a new record.		By using the AF_READONLY flag, you are instructing ATK that whenever the value for this record is displayed, the user should only be allowed to view it and not change it. The AF_HIFE_ADD flag simply hides the “modified_date” field during the creation of a new record.
Line 16:		Line 15:
	To place the date on the field prior to updating the database you would use the preUpdate() function:		To place the date on the field prior to updating the database you would use the preUpdate() function:

	Code:		''Code:''
	// update field before saving		// update field before saving
	function preUpdate(&$record)		function preUpdate(&$record)
Line 27:		Line 26:
	As correct as it may seem, this will not update the “modified_date” field on the database, unless you instruct ATK to specifically do so.		As correct as it may seem, this will not update the “modified_date” field on the database, unless you instruct ATK to specifically do so.

	Solution:		'''Solution:'''

	This problem can be easily solved by using the setForceUpdate() function.		This problem can be easily solved by using the setForceUpdate() function.
Line 33:		Line 32:
	The following code on your constructor will effectively allow you to update the record on the database, while allowing users to view it without the possibility of altering it:		The following code on your constructor will effectively allow you to update the record on the database, while allowing users to view it without the possibility of altering it:

	Code:		''Code:''
	$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));		$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD \| AF_READONLY));
	$modified_date->setForceUpdate(true); // for field to be updated on database after edit function		$modified_date->setForceUpdate(true); // for field to be updated on database after edit function

			Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:

			''Code:''
	~~Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:~~
	Code:
	<?php		<?php
	useattrib("atkdateAttribute");		useattrib("atkdateAttribute");
Line 62:		Line 60:


	Closing remarks:		'''Closing remarks:'''

	The code demonstrated here was tested on ATK 5.5. Prior to this version I was using a custom trick to accomplish the same job. This way of doing is far more elegant.		The code demonstrated here was tested on ATK 5.5. Prior to this version I was using a custom trick to accomplish the same job. This way of doing is far more elegant.

Wayneh: Created page with "Mini-Howto (ATK tip) - How to update READONLY values in ATK Problem: If you use the AF_READONLY flag in ATK so that the user cannot modify a record’s value, you may run into..."

2018-03-10T08:20:31Z

Created page with "Mini-Howto (ATK tip) - How to update READONLY values in ATK Problem: If you use the AF_READONLY flag in ATK so that the user cannot modify a record’s value, you may run into..."

New page

Mini-Howto (ATK tip) - How to update READONLY values in ATK

Problem:
If you use the AF_READONLY flag in ATK so that the user cannot modify a record’s value, you may run into problems when you are trying to update that attribute prior to inserting to the database.

To keep track of changes on a record some developers add a “modified_date” field to the database table and update that field every time a change is made by the user.

Say you have the following ATK code:

Code:
$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD | AF_READONLY));

By using the AF_READONLY flag, you are instructing ATK that whenever the value for this record is displayed, the user should only be allowed to view it and not change it. The AF_HIFE_ADD flag simply hides the “modified_date” field during the creation of a new record.

To place the date on the field prior to updating the database you would use the preUpdate() function:

Code:
// update field before saving
function preUpdate(&$record)
{
// before we update the record, let's get today's date and added to the modified_date field
$record['modified_date'] = date('Y-m-d');
return true;
}

As correct as it may seem, this will not update the “modified_date” field on the database, unless you instruct ATK to specifically do so.

Solution:

This problem can be easily solved by using the setForceUpdate() function.

The following code on your constructor will effectively allow you to update the record on the database, while allowing users to view it without the possibility of altering it:

Code:
$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD | AF_READONLY));
$modified_date->setForceUpdate(true); // for field to be updated on database after edit function

Say you have a node named “order” on a file called “class.order.inc” then your node skeleton code to update your AF_READONLY field would look as follows:
Code:
<?php
useattrib("atkdateAttribute");
class order extends atkNode
{
function order(){
$this->atkNode("order",NF_ADD_LINK | NF_TRACK_CHANGES);
$modified_date = &$this->add(new atkDateAttribute("modified_date","m/d/y","m/d/y",0,0, AF_HIDE_ADD | AF_READONLY));
$modified_date->setForceUpdate(true); // for field to be updated on database after edit function
$this->setTable("order");
}// end function
// update field before saving
function preUpdate(&$record)
{
// before we update the record, let's get today's date and added to the modified_date field
$record['modified_date'] = date('Y-m-d');
return true;
}// end function
}// end class
?>

Closing remarks:

The code demonstrated here was tested on ATK 5.5. Prior to this version I was using a custom trick to accomplish the same job. This way of doing is far more elegant.

Copied from FORUM post by -
Jorge Garifuna
Professional Web Developer
Your Web Solution Partner
http://www.GariDigital.com