/src/lastfmapi/Api/AlbumApi.php

<?php

namespace LastFmApi\Api;

use LastFmApi\Exception\InvalidArgumentException;
use LastFmApi\Exception\NotAuthenticatedException;
use LastFmApi\Exception\NoResultsException;

use SimpleXMLElement;

/**
 * File that stores api calls for album api calls
 * @package apicalls
 */

/**
 * Allows access to the api requests relating to albums
 */
class AlbumApi extends BaseApi
{

    /**
     * Tag an album using a list of user supplied tags. (Requires full auth)
     * @param array $methodVars An array with the following required values: <i>album</i>, <i>artist</i>, <i>tags</i>
     * @return boolean
     */
    public function addTags($methodVars)
    {
        // Only allow full authed calls
        if ($this->getFullAuth() === true) {
            // Check for required variables
            if (!empty($methodVars['album']) && !empty($methodVars['artist']) && !empty($methodVars['tags'])) {
                // If the tags variables is an array build a CS list
                if (is_array($methodVars['tags'])) {
                    $tags = '';
                    foreach ($methodVars['tags'] as $tag) {
                        $tags .= $tag . ',';
                    }
                    $tags = substr($tags, 0, -1);
                } else {
                    $tags = $methodVars['tags'];
                }
                $methodVars['tags'] = $tags;

                // Set the call variables
                $vars = array(
                    'method' => 'album.addtags',
                    'api_key' => $this->getAuth()->apiKey,
                    'sk' => $this->getAuth()->sessionKey
                );
                $vars = array_merge($vars, $methodVars);

                // Generate a call signiture
                $sig = $this->apiSig($this->getAuth()->apiSecret, $vars);
                $vars['api_sig'] = $sig;

                // Do the call and check for errors
                if ($call = $this->apiPostCall($vars)) {
                    // If none return true
                    return true;
                } else {
                    // If there is return false
                    return false;
                }
            } else {                
                throw new InvalidArgumentException('You must include album, artist and tags variables in the call for this method');
            }
        } else {
            throw new NotAuthenticatedException('Method requires full auth. Call auth.getSession using lastfmApiAuth class');
        }
    }

    /**
     * Get the metadata for an album on Last.fm using the album name or a musicbrainz id
     * @param array $methodVars An array with the following required values: <i>album</i> and optional values: <i>artist</i>, <i>mbid</i>
     * @return array
     */
    public function getInfo($methodVars)
    {
        // Set the call variables
        $vars = array(
            'method' => 'album.getinfo',
            'api_key' => $this->getAuth()->apiKey
        );
        $vars = array_merge($vars, $methodVars);

        $info = array();
        $i = 0;
        if ($call = $this->apiGetCall($vars)) {
            $info['name'] = (string) $call->album->name;
            $info['artist'] = (string) $call->album->artist;
            $info['lastfmid'] = (string) $call->album->id;
            $info['mbid'] = (string) $call->album->mbid;
            $info['url'] = (string) $call->album->url;
            $info['releasedate'] = strtotime(trim((string) $call->album->releasedate));
            $info['image']['small'] = (string) $call->album->image;
            $info['image']['medium'] = (string) $call->album->image[1];
            $info['image']['large'] = (string) $call->album->image[2];
            $info['listeners'] = (string) $call->album->listeners;
            $info['playcount'] = (string) $call->album->playcount;
            foreach ($call->album->tags->tag as $tags) {
                $info['toptags'][$i]['name'] = (string) $tags->name;
                $info['toptags'][$i]['url'] = (string) $tags->url;
                $i++;
            }
            $i = 0;
            foreach ($call->album->tracks->track as $track) {
                $info['tracks'][$i]['name'] = (string) $track->name;
                $info['tracks'][$i]['url'] = (string) $track->url;
                $info['tracks'][$i]['duration'] = (string) $track->duration;
                $info['tracks'][$i]['streamable'] = (string) $track->streamable;
                $info['tracks'][$i]['rank'] = (string) $track['rank'];
                $info['tracks'][$i]['artist'] = array();
                $info['tracks'][$i]['artist']['name'] = $track->artist->name;
                $info['tracks'][$i]['artist']['mbid'] = $track->artist->mbid;
                $info['tracks'][$i]['artist']['url'] = $track->artist->url;
                $i++;
            }
            $info['wiki'] = array(
                'summary' => (string) $call->album->wiki->summary,
                'content' => (string) $call->album->wiki->content
            );

            return $info;
        } else {
            return false;
        }
    }

    /**
     * Get the tags applied by an individual user to an album on Last.fm
     * @param array $methodVars An array with the following required values: <i>album</i>, <i>artist</i>
     * @return array
     */
    public function getTags($methodVars)
    {
        // Only allow full authed calls
        if ($this->getFullAuth() === true) {
            // Check for required variables
            if (!empty($methodVars['album']) && !empty($methodVars['artist'])) {
                // Set the variables
                $vars = array(
                    'method' => 'album.gettags',
                    'api_key' => $this->getAuth()->apiKey,
                    'sk' => $this->getAuth()->sessionKey
                );
                $vars = array_merge($vars, $methodVars);

                // Generate a call signiture
                $sig = $this->apiSig($this->getAuth()->apiSecret, $vars);
                $vars['api_sig'] = $sig;

                $tags = array();
                // Make the call
                if ($call = $this->apiGetCall($vars)) {
                    if (count($call->tags->tag) > 0) {
                        $i = 0;
                        foreach ($call->tags->tag as $tag) {
                            $tags[$i]['name'] = (string) $tag->name;
                            $tags[$i]['url'] = (string) $tag->url;
                            $i++;
                        }

                        return $tags;
                    } else {
                        throw new NoResultsException('User has no tags for this artist');
                    }
                } else {
                    return false;
                }
            } else {
                throw new InvalidArgumentException('You must include album, artist and tags variables in the call for this method');
            }
        } else {
            throw new NotAuthenticatedException('Method requires full auth. Call auth.getSession using lastfmApiAuth class');
        }
    }

    /**
     * Remove a user's tag from an album. (Requires full auth)
     * @param array $methodVars An array with the following required values: <i>album</i>, <i>artist</i>, <i>tag</i>
     * @return boolean
     */
    public function removeTag($methodVars)
    {
        // Only allow full authed calls
        if ($this->getFullAuth() === true) {
            // Check for required variables
            if (!empty($methodVars['album']) && !empty($methodVars['artist']) && !empty($methodVars['tag'])) {
                // Set the variables
                $vars = array(
                    'method' => 'album.removetag',
                    'api_key' => $this->getAuth()->apiKey,
                    'sk' => $this->getAuth()->sessionKey
                );
                $vars = array_merge($vars, $methodVars);

                // Generate a call signature
                $sig = $this->apiSig($this->getAuth()->apiSecret, $vars);
                $vars['api_sig'] = $sig;

                // Do the call
                if ($call = $this->apiPostCall($vars)) {
                    return true;
                } else {
                    return false;
                }
            } else {
                throw new InvalidArgumentException('You must include album, artist and tags variables in the call for this method');
            }
        } else {
            throw new NotAuthenticatedException('Method requires full auth. Call auth.getSession using lastfmApiAuth class');
        }
    }

    /**
     * Search for an album by name. Returns album matches sorted by relevance
     * @param array $methodVars An array with the following required values: <i>album</i>
     * @return array
     */
    public function search($methodVars)
    {
        // Check for required variables
        if (!empty($methodVars['album'])) {
            $vars = array(
                'method' => 'album.search',
                'api_key' => $this->getAuth()->apiKey
            );
            $vars = array_merge($vars, $methodVars);

            $searchresults = array();
            if ($call = $this->apiGetCall($vars)) {
                $callNamespaces = $call->getDocNamespaces(true);
                // fix missing namespace (sic)
                if (!isset($callNamespaces['opensearch'])) {
                    $call->results->addAttribute('xmlns:xmlns:opensearch', 'http://a9.com/-/spec/opensearch/1.1/');
                    $call = new SimpleXMLElement($call->asXML());
                }
                $opensearch = $call->results->children('http://a9.com/-/spec/opensearch/1.1/');
                if ($opensearch->totalResults > 0) {
                    $searchresults['totalResults'] = (string) $opensearch->totalResults;
                    $searchresults['startIndex'] = (string) $opensearch->startIndex;
                    $searchresults['itemsPerPage'] = (string) $opensearch->itemsPerPage;
                    $i = 0;
                    foreach ($call->results->albummatches->album as $album) {
                        $searchresults['results'][$i]['name'] = (string) $album->name;
                        $searchresults['results'][$i]['artist'] = (string) $album->artist;
                        $searchresults['results'][$i]['id'] = (string) $album->id;
			$searchresults['results'][$i]['mbid'] = (string) $album->mbid;
                        $searchresults['results'][$i]['url'] = (string) $album->url;
                        $searchresults['results'][$i]['streamable'] = (string) $album->streamable;
                        $searchresults['results'][$i]['image']['small'] = (string) $album->image[0];
                        $searchresults['results'][$i]['image']['medium'] = (string) $album->image[1];
                        $searchresults['results'][$i]['image']['large'] = (string) $album->image[2];
                        $i++;
                    }

                    return $searchresults;
                } else {
                    throw new NoResultsException('No results', 90);
                }
            } else {
                return false;
            }
        } else {
            throw new InvalidArgumentException('You must include album variable in the call for this method');
        }
    }

}