Cchost/developer/tutorial/Featured Playlist - Revision history

Fourstones: /* Creating the Featured Playlist Topic */

2008-11-17T23:30:17Z

Creating the Featured Playlist Topic

Fourstones: /* Map an URL to Our Function */

2008-11-17T23:29:32Z

Map an URL to Our Function

← Older revision		Revision as of 23:29, 17 November 2008
Line 49:		Line 49:
	CCEvents::AddHandler(CC_EVENT_MAP_URLS,		CCEvents::AddHandler(CC_EVENT_MAP_URLS,
	'playlist_feature_OnMapUrls');		'playlist_feature_OnMapUrls');

	// This function will be called when the system		// This function will be called when the system
	// needs to build the URL map		// needs to build the URL map

	function playlist_feature_OnMapUrls()		function playlist_feature_OnMapUrls()
	{		{
	// Put our mapping into the system:		// Put our mapping into the system:

	CCEvents::MapUrl( // here's our URL, the 'playlist_id'		CCEvents::MapUrl( // here's our URL, the 'playlist_id'
	// that's appended to this URL will		// that's appended to this URL will
	// passed to our function as a param		// passed to our function as a param
	ccp('playlist', 'feature'),		ccp('playlist', 'feature'),

	// the function to map to:		// the function to map to:
	'playlist_feature_playlist',		'playlist_feature_playlist',

	// the access level (admin only)		// the access level (admin only)
	CC_ADMIN_ONLY,		CC_ADMIN_ONLY,

	// where the function lives (this module)		// where the function lives (this module)
	ccs(__FILE__) );		ccs(__FILE__) );

Fourstones: /* Adding the Command to the Playlst Menu */

2008-11-17T23:28:59Z

Adding the Command to the Playlst Menu

← Older revision		Revision as of 23:28, 17 November 2008
Line 9:		Line 9:
	The idea behind this feature is to put a menu on a playlist ([http://ccmixter.org/playlist/browse/10 example playlist]) that with a single click, automate the entire process.		The idea behind this feature is to put a menu on a playlist ([http://ccmixter.org/playlist/browse/10 example playlist]) that with a single click, automate the entire process.
	=The Code=		=The Code=
	==Adding the Command to the ~~Playlst~~ Menu==		==Adding the Command to the Playlist Menu==
	In order to add a menu item to the playlist menu we first have to create a dataview filter event handler. (Find out how [[cchost/developer/Reverse_Engineering\|that was determined]].)		In order to add a menu item to the playlist menu we first have to create a dataview filter event handler. (Find out how [[cchost/developer/Reverse_Engineering\|that was determined]].)

Line 16:		Line 16:
	CCEvents::AddHandler(CC_EVENT_FILTER_CART_MENU,		CCEvents::AddHandler(CC_EVENT_FILTER_CART_MENU,
	'playlist_feature_OnFilterCartMenu');		'playlist_feature_OnFilterCartMenu');

	CCEvents::AddHandler(CC_EVENT_MAP_URLS,		CCEvents::AddHandler(CC_EVENT_MAP_URLS,
	'playlist_feature_OnMapUrls');		'playlist_feature_OnMapUrls');

	function playlist_feature_OnFilterCartMenu(&$records)		function playlist_feature_OnFilterCartMenu(&$records)
	{		{
	// make sure we have a playlist and only show this		// make sure we have a playlist and only show this
	// command to admins...		// command to admins...

	if( empty($records[0]['cart_id']) \|\| !CCUser::IsAdmin() )		if( empty($records[0]['cart_id']) \|\| !CCUser::IsAdmin() )
	return;		return;

			// some helper declarations...

	~~// some helper declarations...~~

	$row =& $records[0];		$row =& $records[0];
	$playlist_id = $row['cart_id'];		$playlist_id = $row['cart_id'];

	// This is was copy/pasted from the system version,		// This is was copy/pasted from the system version,
	// tweaked for our needs		// tweaked for our needs

	$row['menu'][] = array( 'url' => ccl( 'playlist', 'feature', $playlist_id ),		$row['menu'][] = array( 'url' => ccl( 'playlist', 'feature', $playlist_id ),
	'class' => 'cc_playlist_playlink',		'class' => 'cc_playlist_playlink',

Fourstones: /* The Code */

2008-11-17T23:28:27Z

The Code

@@ Line 9: / Line 9: @@
 The idea behind this feature is to put a menu on a playlist ([http://ccmixter.org/playlist/browse/10 example playlist]) that with a single click, automate the entire process.
 =The Code=
 In order to add a menu item to the playlist menu we first have to create a dataview filter event handler. (Find out how [[cchost/developer/Reverse_Engineering|that was determined]].)

Fourstones: New page: =Overview= ccMixter is a site focused on audio but the 'playlist' feature is just a matter of wording. For an image site the same feature would be called 'gallery' or in a video site it wo...

2008-11-17T22:48:36Z

New page: =Overview= ccMixter is a site focused on audio but the 'playlist' feature is just a matter of wording. For an image site the same feature would be called 'gallery' or in a video site it wo...

New page

=Overview=
ccMixter is a site focused on audio but the 'playlist' feature is just a matter of wording. For an image site the same feature would be called 'gallery' or in a video site it would be called 'channel.'

This tutorial walks through the implementation of an admin feature in ccMixter that with one click will add a playlist to the [http://ccmixter.org/view/media/playlists/featured Featured Playlists] page. It covers event handling, URL mapping, customizing command menus, database insert and browser redirect.

==Feature Spec==
The 'Featured Playlist' page in ccMixter is page created by using the [[Cchost/admin/Content_Manager|Content Manager]] with a topic type of 'feat_playlist'. Once a week the admins on the site would create a new topic, copy from the previous week's featured playlist, change a number in a query and post the new topic. The exact same operation (approximately 20 clicks, a copy/paste and submit) every week.

The idea behind this feature is to put a menu on a playlist ([http://ccmixter.org/playlist/browse/10 example playlist]) that with a single click, automate the entire process.
=The Code=
In order to add a menu item to the playlist menu we first have to create a dataview filter event handler. (Find out how [[cchost/developer/Reverse_Engineering|that was determined]].)

← Older revision		Revision as of 23:30, 17 November 2008
Line 78:		Line 78:

	// the parameter is what was appended to the URL		// the parameter is what was appended to the URL

	function playlist_feature_playlist($playlist_id)		function playlist_feature_playlist($playlist_id)
	{		{
	// needed so we can declare the CCTopics table		// needed so we can declare the CCTopics table

	require_once('cchost_lib/ccextras/cc-topics.inc');		require_once('cchost_lib/ccextras/cc-topics.inc');

	// This is the string (with placeholders) that will		// This is the string (with placeholders) that will
	// be our topic text...		// be our topic text...

	$text =<<<EOF		$text =<<<EOF
	[left][query=t=avatar&u=mcjackinthebox][/query][/left]		[left][query=t=avatar&u=mcjackinthebox][/query][/left]
Line 93:		Line 93:
	[query=t=yahoo_black&playlist=%id%][/query]		[query=t=yahoo_black&playlist=%id%][/query]
	EOF;		EOF;

	// Create an instance of the topics database		// Create an instance of the topics database
	// to make the 'INSERT' easier.		// to make the 'INSERT' easier.
	$topics = new CCTopics();		$topics = new CCTopics();

	// Fill out the fields...		// Fill out the fields...
	$values['topic_id'] = $topics->NextID();		$values['topic_id'] = $topics->NextID();
Line 105:		Line 105:
	$values['topic_user'] = CCUser::CurrentUser();		$values['topic_user'] = CCUser::CurrentUser();
	$values['topic_type'] = 'feat_playlist';		$values['topic_type'] = 'feat_playlist';

	// This is where we replace the placeholder with		// This is where we replace the placeholder with
	// the actual playlist id		// the actual playlist id

	$values['topic_text'] = str_replace('%id%', $playlist_id, $text );		$values['topic_text'] = str_replace('%id%', $playlist_id, $text );


	// Here we use the cart (aka playlist) name for the		// Here we use the cart (aka playlist) name for the
	// topic name		// topic name

	$values['topic_name'] = addslashes(CCDatabase::QueryItem(		$values['topic_name'] = addslashes(CCDatabase::QueryItem(
	'SELECT cart_name FROM cc_tbl_cart WHERE		'SELECT cart_name FROM cc_tbl_cart WHERE
	'cart_id='.$playlist_id));		'cart_id='.$playlist_id));

	// insert the values into the database		// insert the values into the database

	$topics->Insert($values,0);		$topics->Insert($values,0);

	// Redirect the browser to the 'Featured Playlists' page		// Redirect the browser to the 'Featured Playlists' page

	CCUtil::SendBrowserTo( ccl('view','media','playlists') );		CCUtil::SendBrowserTo( ccl('view','media','playlists') );
	}		}