Added method and example for user.shout

Author: Matt Oakes

changelog

@@ -7,6 +7,7 @@
 	+ event.getShouts
 	+ event.shout
 	+ user.getShouts
+	+ user.shout
 * Fixed badly formed XML errors appearing. Will return error 95 when it happens. It is up to the application to
 	decide how to handle the error. Thank you to her035 for the advice on how to fix it and the nice example
 	that was made for me (http://her035.de/lastfm/test/xml.php). Much appreciated!

examples/user.shout/index.php

@@ -0,0 +1,40 @@
+<?php
+
+// Include the API
+require '../../lastfmapi/lastfmapi.php';
+
+// Get the session auth data
+$file = fopen('../auth.txt', 'r');
+// Put the auth data into an array
+$authVars = array(
+	'apiKey' => trim(fgets($file)),
+	'secret' => trim(fgets($file)),
+	'username' => trim(fgets($file)),
+	'sessionKey' => trim(fgets($file)),
+	'subscriber' => trim(fgets($file))
+);
+$config = array(
+	'enabled' => true,
+	'path' => '../../lastfmapi/',
+	'cache_length' => 1800
+);
+// Pass the array to the auth class to eturn a valid auth
+$auth = new lastfmApiAuth('setsession', $authVars);
+
+$apiClass = new lastfmApi();
+$userClass = $apiClass->getPackage($auth, 'user', $config);
+
+// Setup the variables
+$methodVars = array(
+	'user' => 'lotrgamemast',
+	'message' => 'Looks like someone just ran the user.shout example'
+);
+
+if ( $userClass->shout($methodVars) ) {
+	echo '<b>Done</b>';
+}
+else {
+	die('<b>Error '.$userClass->error['code'].' - </b><i>'.$userClass->error['desc'].'</i>');
+}
+
+?>

lastfmapi/api/user.php

@@ -917,6 +917,41 @@ public function getWeeklyTrackChart($methodVars) {
 			return FALSE;
 		}
 	}
+	
+	public function shout($methodVars) {
+		// Only allow full authed calls
+		if ( $this->fullAuth == TRUE ) {
+			// Check for required variables
+			if ( !empty($methodVars['user']) && !empty($methodVars['message']) ) {
+				$vars = array(
+					'method' => 'user.shout',
+					'api_key' => $this->auth->apiKey,
+					'user' => $methodVars['user'],
+					'message' => $methodVars['message'],
+					'sk' => $this->auth->sessionKey
+				);
+				$sig = $this->apiSig($this->auth->secret, $vars);
+				$vars['api_sig'] = $sig;
+				
+				if ( $call = $this->apiPostCall($vars) ) {
+					return TRUE;
+				}
+				else {
+					return FALSE;
+				}
+			}
+			else {
+				// Give a 91 error if incorrect variables are used
+				$this->handleError(91, 'You must include user and message variables in the call for this method');
+				return FALSE;
+			}
+		}
+		else {
+			// Give a 92 error if not fully authed
+			$this->handleError(92, 'Method requires full auth. Call auth.getSession using lastfmApiAuth class');
+			return FALSE;
+		}
+	}
 }
 
 ?>