Using Content History in your Component - Revision history

Cmb: Markup changes and corrected some spellings.

2022-09-15T15:28:07Z

Markup changes and corrected some spellings.

← Older revision		Revision as of 15:28, 15 September 2022
Line 1:		Line 1:
	In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category, and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.		In version 3.2, Joomla added the ability to track content history (also called versions) for all core components. This allows you to view and restore from prior versions of an article, banner, category and other content types. This feature can easily be added to third-party components. This tutorial shows you how to do this. We will illustrate this by adding content history to an example component.

	'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.		'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

	== Set up Working Environment ==		== Set Up Working Environment ==

	# Install a new instance of Joomla version 3.2 on your local workstation.		# Install a new instance of Joomla version 3.2 on your local workstation.
Line 24:		Line 24:
	Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.		Our example component uses a table called #__joompro_subscriptions to store each subscription. In addition, it uses the standard Joomla categories. So we will add a row in #__content_types for the category table and one for the component table.

	The row for the categories can be copied from the row for "Weblinks Category" (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.		The row for the categories can be copied from the row for ''Weblinks Category'' (or any other category row). The only columns that need to be changed are <code>type_title</code> and <code>type_alias</code>. The other columns are the same as for <code>com_weblinks.category</code>.

	The SQL statement for adding this row is as follows:		The SQL statement for adding this row is as follows:
Line 42:		Line 42:
	For the actual subscriptions, we only need the following information in the content types table:		For the actual subscriptions, we only need the following information in the content types table:

	*'''type_title:''' ~~<code>~~Subscriptions~~</code>~~		*'''type_title:''' ''Subscriptions''
	*'''type_alias:''' ~~<code>~~com_joomprosubs.subscription~~</code>~~		*'''type_alias:''' ''com_joomprosubs.subscription''
	*'''table:'''		*'''table:'''
	::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>		::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>
Line 78:		Line 78:

	<source lang="xml">		<source lang="xml">

	<fieldset name="component">		<fieldset name="component">
	<field		<field
Line 104:		Line 103:
	</fieldset>		</fieldset>
	</source>		</source>
	With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.		With this code, we will now be able to add and save these options. Go into the Options for the component and set ''save_history'' to Yes and ''history_limit'' to 10.

	== Update Content History During Table Save and Delete ==		== Update Content History During Table Save and Delete ==
Line 117:		Line 116:
	At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.		At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

	== Add ~~type alias~~ to ~~model~~ ==		== Add Type Alias to the Model ==

	To make restoring work, you need to add <code>$typeAlias</code> property to your model class. Model is located in <code>administrator/components/com_joomprosubs/models/subscription.php</code>		To make restoring work, you need to add <code>$typeAlias</code> property to your model class. Model is located in <code>administrator/components/com_joomprosubs/models/subscription.php</code>

Line 189:		Line 187:
	In our example component, we need the following values.		In our example component, we need the following values.
	*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.		*'''formfile:''' <code>administrator/components/com_joomprosubs/models/forms/subscription.xml</code>.
	*'''hideFields:''' checked_out, checked_out_time, params, ~~langauge~~. The last two columns are not used.		*'''hideFields:''' checked_out, checked_out_time, params, language. The last two columns are not used.
	*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.		*'''ignoreChanges:''' modified_by, modified, checked_out, checked_out_time.
	*'''convertToInt:''' publish_up, publish_down.		*'''convertToInt:''' publish_up, publish_down.
Line 240:		Line 238:
	</source>		</source>

	Note that the "/" characters are now ~~preceeded~~ by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.		Note that the "/" characters are now preceded by two escape "\" characters. The first one is the SQL escape character for the second "\" character. The second "\" is the JSON escape character for the "/" character.

	With this change to the SQL install file, the changes for content history are complete.		With this change to the SQL install file, the changes for content history are complete.

Wilsonge: Various cleanup

2019-05-27T16:06:40Z

Various cleanup

← Older revision		Revision as of 16:06, 27 May 2019
Line 3:		Line 3:
	'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.		'''Important Note:''' This tutorial assumes that the component uses a JTable sub-class for its "CRUD" (create/update/delete) operations. If the component does not use JTable then the simplest thing to do is to re-work it to use JTable's store() and delete() methods. If you do that, you will be able to use the methods described in this tutorial.

	=Set up Working Environment=		== Set up Working Environment ==

	# Install a new instance of Joomla version 3.2 on your local workstation.		# Install a new instance of Joomla version 3.2 on your local workstation.
Line 10:		Line 10:
	At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.		At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

	=Add Rows to Content Types Table=		== Add Rows to Content Types Table ==
	The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:		The first thing we need to do is to add two new rows into the #__content_types table. This table stores information about the different tables for each content type. As of Joomla version 3.2, this table is used by the com_tags and com_contenthistory components to get information about each content type for which history is stored. The columns for #__content_types are as follows:

Line 70:		Line 70:
	'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.		'''Tip:''' When creating the values for the JSON strings, one trick is to copy from an existing row and edit the strings.

	=Add Component Level Options=		== Add Component Level Options ==
	The content history component uses two options as follows.		The content history component uses two options as follows.
	*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.		*'''save_history:''' If Yes, history is saved. Otherwise, no history is saved.
Line 106:		Line 106:
	With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.		With this code, we will now be able to add and save these options. Go into the Options for the component and set save_history to Yes and history_limit to 10.

	=Update Content History During Table Save and Delete=		== Update Content History During Table Save and Delete ==
	Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.		Next we need to tell our component to call the content history methods during the save and delete operations. We can do this by adding this line of code to the <code>__construct()</code> method of the <code>JoomprosubsTableSubscription</code> class.

Line 117:		Line 117:
	At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.		At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

	=Add type alias to model=		== Add type alias to model ==

	To make restoring work, you need to add <code>$typeAlias</code> property to your model class. Model is located in <code>administrator/components/com_joomprosubs/models/subscription.php</code>		To make restoring work, you need to add <code>$typeAlias</code> property to your model class. Model is located in <code>administrator/components/com_joomprosubs/models/subscription.php</code>
Line 127:		Line 127:
	If this is not set, you will get <code>Error restoring item version from history.</code> error, because Joomla! can not find correct row from <code>#__content_types</code> table.		If this is not set, you will get <code>Error restoring item version from history.</code> error, because Joomla! can not find correct row from <code>#__content_types</code> table.

	=Add Versions Button to ~~Tool Bar~~=		== Add Versions Button to Toolbar ==
	At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.		At this point, categories are working completely and we are saving history versions in the #__ucm_history table for our component. However, we need to be able to access these changes on our edit screen. To do this, we need to add the Versions button to the edit screen's toolbar. We do this by adding this code to the file <code>administrator/components/com_joomprosubs/views/subscription/view.html.php</code>, just before the code that adds the "cancel" button, as shown here.

Line 135:		Line 135:
	JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);		JToolbarHelper::versions('com_joomprosubs.subscription', $this->item->id);
	}		}
	~~JToolBarHelper~~::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');		JToolbarHelper::cancel('subscription.cancel', 'JTOOLBAR_CLOSE');
	}		}
	</source>		</source>
Line 145:		Line 145:
	There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.		There are still two things missing, however. One is that we don't have a way to add the Version Note to each version. The second is that we don't currently have meaningful labels for the versions when we use the Preview or Compare features. We will address these in the next two sections of this tutorial.

	=Add Version Note Field to Form=		== Add Version Note Field to Form ==
	The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.		The content history feature adds a new field called "version_note" to the component edit form. This optional field is not saved in the component table. Instead, it is used to label the version in the content history table.

Line 173:		Line 173:
	Now we can add in a version note and see this in the Item Version History modal window.		Now we can add in a version note and see this in the Item Version History modal window.

	=Add Labels to Pop-Up Windows=		== Add Labels to Pop-Up Windows ==
	At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.		At this point, everything works. However, when we use the pop-up Preview or Compare windows in the Item Version History modal, we see the database column names instead of the translated label from the form. Also, we see the category and user id numbers instead of the category name and user name.

Line 220:		Line 220:
	The entire JSON string for this column is as follows.		The entire JSON string for this column is as follows.

	<source>		<source lang="json">
	{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",		{"formFile":"administrator\/components\/com_joomprosubs\/models\/forms\/subscription.xml",
	"hideFields":["checked_out","checked_out_time","params","language"],		"hideFields":["checked_out","checked_out_time","params","language"],
Line 244:		Line 244:
	With this change to the SQL install file, the changes for content history are complete.		With this change to the SQL install file, the changes for content history are complete.

	=Update Extension SQL Files=		== Update Extension SQL Files ==
	To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.		To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

Renekorss: added missing description to edit model to make restoring work

2015-03-20T11:04:27Z

added missing description to edit model to make restoring work

← Older revision		Revision as of 11:04, 20 March 2015
Line 116:		Line 116:

	At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.		At this point, we should be able to see content history working for the Joomprosubs categories. Test this by adding a new category for the component and then clicking on the Versions button in the toolbar. It should work exactly the same as categories for the core Joomla components.

			=Add type alias to model=

			To make restoring work, you need to add <code>$typeAlias</code> property to your model class. Model is located in <code>administrator/components/com_joomprosubs/models/subscription.php</code>

			<source lang="php">
			public $typeAlias = 'com_joomprosubs.subscription';
			</source>

			If this is not set, you will get <code>Error restoring item version from history.</code> error, because Joomla! can not find correct row from <code>#__content_types</code> table.

	=Add Versions Button to Tool Bar=		=Add Versions Button to Tool Bar=

Tom Hutchison: /* Add Rows to Content Types Table */ source lang tags look better

2013-11-03T22:51:26Z

Add Rows to Content Types Table: source lang tags look better

← Older revision		Revision as of 22:51, 3 November 2013
Line 28:		Line 28:
	The SQL statement for adding this row is as follows:		The SQL statement for adding this row is as follows:

	<~~pre~~>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)		<source lang="sql">
			INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
	VALUES		VALUES
	(null,		(null,
Line 37:		Line 38:
	'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',		'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
	'WeblinksHelperRoute::getCategoryRoute',		'WeblinksHelperRoute::getCategoryRoute',
	'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</~~pre~~>		'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</source>

	For the actual subscriptions, we only need the following information in the content types table:		For the actual subscriptions, we only need the following information in the content types table:
Line 46:		Line 47:
	::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>		::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>
	::This creates a JSON object as follows:		::This creates a JSON object as follows:
	:special:		:::special:
	::dbtable = #__joompro_subscriptions		:::dbtable = #__joompro_subscriptions
	::key = id		:::key = id
	::type = Subscription		:::type = Subscription
	::prefix = JoomprosubsTable		:::prefix = JoomprosubsTable

	The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.		The <code>type_alias</code> column is used by the com_contenthistory component to find the row for each component in the #__content_types table. The <code>table</code> column gives the com_contenthistory component the information it needs to work with the JTable class for each component. The None of the other columns need to be set for now. Note that we will come back to the <code>content_history_options</code> column later in the tutorial to improve the appearance of the pop-up window.
Line 56:		Line 57:
	The SQL for adding this second row to the #__content_types table is as follows:		The SQL for adding this second row to the #__content_types table is as follows:

	<~~pre~~>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)		<source lang="sql">INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
	VALUES		VALUES
	(null,		(null,
Line 63:		Line 64:
	'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',		'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
	'', '', '', '');		'', '', '', '');
	</~~pre~~>		</source>

	These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.		These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

Tom Hutchison: /* Add Rows to Content Types Table */ indent

2013-11-03T22:48:01Z

Add Rows to Content Types Table: indent

← Older revision		Revision as of 22:48, 3 November 2013
Line 45:		Line 45:
	*'''table:'''		*'''table:'''
	::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>		::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>
	This creates a JSON object as follows:		::This creates a JSON object as follows:
	:special:		:special:
	::dbtable = #__joompro_subscriptions		::dbtable = #__joompro_subscriptions

Tom Hutchison: /* Add Rows to Content Types Table */ hmm, maybe

 tags for long and large blocks of code

2013-11-03T22:47:13Z

Add Rows to Content Types Table: hmm, maybe <pre> tags for long and large blocks of code

← Older revision		Revision as of 22:47, 3 November 2013
Line 28:		Line 28:
	The SQL statement for adding this row is as follows:		The SQL statement for adding this row is as follows:

	<~~code~~>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)		<pre>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
	VALUES		VALUES
	(null,		(null,
Line 37:		Line 37:
	'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',		'{"common":{"core_content_item_id":"id","core_title":"title","core_state":"published","core_alias":"alias","core_created_time":"created_time","core_modified_time":"modified_time","core_body":"description", "core_hits":"hits","core_publish_up":"null","core_publish_down":"null","core_access":"access", "core_params":"params", "core_featured":"null", "core_metadata":"metadata", "core_language":"language", "core_images":"null", "core_urls":"null", "core_version":"version", "core_ordering":"null", "core_metakey":"metakey", "core_metadesc":"metadesc", "core_catid":"parent_id", "core_xreference":"null", "asset_id":"asset_id"}, "special":{"parent_id":"parent_id","lft":"lft","rgt":"rgt","level":"level","path":"path","extension":"extension","note":"note"}}',
	'WeblinksHelperRoute::getCategoryRoute',		'WeblinksHelperRoute::getCategoryRoute',
	'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</~~code~~>		'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml", "hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"], "ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],"convertToInt":["publish_up", "publish_down"], "displayLookup":[{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}');</pre>

	For the actual subscriptions, we only need the following information in the content types table:		For the actual subscriptions, we only need the following information in the content types table:
Line 43:		Line 43:
	*'''type_title:''' <code>Subscriptions</code>		*'''type_title:''' <code>Subscriptions</code>
	*'''type_alias:''' <code>com_joomprosubs.subscription</code>		*'''type_alias:''' <code>com_joomprosubs.subscription</code>
	*'''table:''' <~~code~~>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</~~code~~>. This creates a JSON object as follows:		*'''table:'''
			::<pre>{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}</pre>
			This creates a JSON object as follows:
	:special:		:special:
	::dbtable = #__joompro_subscriptions		::dbtable = #__joompro_subscriptions
Line 54:		Line 56:
	The SQL for adding this second row to the #__content_types table is as follows:		The SQL for adding this second row to the #__content_types table is as follows:

	<~~code~~>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)		<pre>INSERT INTO `#__content_types` (`type_id`, `type_title`, `type_alias`, `table`, `rules`, `field_mappings`, `router`, `content_history_options`)
	VALUES		VALUES
	(null,		(null,
Line 61:		Line 63:
	'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',		'{"special":{"dbtable":"#__joompro_subscriptions","key":"id","type":"Subscription","prefix":"JoomprosubsTable"}}',
	'', '', '', '');		'', '', '', '');
	</~~code~~>		</pre>

	These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.		These lines should be added to the file <code>administrator/components/com_joomprosubs/sql/install.mysql.utf8.sql</code> so that these rows will be created when the component is installed. You should also run these commands on your database to add the two rows to your #__content_types table before going to the next section. Remember to change the placeholder prefix "#__" to the actual prefix for your database before running the SQL commands on your local database.

Dextercowley: add link to final code

2013-11-03T22:13:52Z

add link to final code

← Older revision		Revision as of 22:13, 3 November 2013
Line 234:		Line 234:
	To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.		To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

	Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla.		Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla. You can download the com_joomprosubs component with the code for content history added here: https://github.com/joomla/jdoc-examples/raw/master/zip_archives/com_joomprosubs-3.2.1.zip.

	[[Category:Development]][[Category:Content History]]		[[Category:Development]][[Category:Content History]]
	[[Category:Tutorials]]		[[Category:Tutorials]]

Dextercowley: Update link for zip file.

2013-11-03T22:11:47Z

Update link for zip file.

← Older revision		Revision as of 22:11, 3 November 2013
Line 6:		Line 6:

	# Install a new instance of Joomla version 3.2 on your local workstation.		# Install a new instance of Joomla version 3.2 on your local workstation.
	# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: ~~<to be filled in when available>~~.		# Install the example component using the file com_joomprosubs_3.2.0.zip in the Extension Manager: Install screen. You can get the ZIP archive here: https://github.com/joomla/jdoc-examples/raw/master/zip_archives/com_joomprosubs-3.2.0.zip.

	At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.		At this point, you should be able to see the Joompro Subscriptions component in the Components menu in the back end of Joomla. This is the component before we have added content history to it.

Dextercowley: /* Update Extension SQL Files */

2013-11-03T21:19:55Z

Update Extension SQL Files

← Older revision		Revision as of 21:19, 3 November 2013
Line 232:		Line 232:

	=Update Extension SQL Files=		=Update Extension SQL Files=
			To tidy things up, should should edit the uninstall SQL file to remove the rows from the #__content_types table. Also, if your component uses the one-click update feature, you should create a SQL file to create these rows when the component is updated.

			Hopefully, this tutorial will help you as you update your component to take advantage of the content history feature in Joomla.

	[[Category:Development]][[Category:Content History]]		[[Category:Development]][[Category:Content History]]
	[[Category:Tutorials]]		[[Category:Tutorials]]

Dextercowley: /* Add Labels to Pop-Up Windows */

2013-11-03T21:17:04Z

Add Labels to Pop-Up Windows

@@ Line 173: / Line 173: @@
 :*''targetColumn:'' The column in the target table to use in the SQL query JOIN statement. For example, "id".
 :*''displayColumn:'' The column in the target table to display in the Preview or Compare pop-up window. For example, "name" or "title".
 =Update Extension SQL Files=