src/Module/Api/Method/ArtistsMethod.php
<?php
declare(strict_types=0);
/**
* vim:set softtabstop=4 shiftwidth=4 expandtab:
*
* LICENSE: GNU Affero General Public License, version 3 (AGPL-3.0-or-later)
* Copyright Ampache.org, 2001-2023
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Ampache\Module\Api\Method;
use Ampache\Repository\Model\User;
use Ampache\Module\Api\Api;
use Ampache\Module\Api\Json_Data;
use Ampache\Module\Api\Xml_Data;
/**
* Class ArtistsMethod
* @package Lib\ApiMethods
*/
final class ArtistsMethod
{
public const ACTION = 'artists';
/**
* artists
* MINIMUM_API_VERSION=380001
*
* This takes a collection of inputs and returns
* artist objects. This function is deprecated!
*
* filter = (string) Alpha-numeric search term //optional
* exact = (integer) 0,1, if true filter is exact rather then fuzzy //optional
* add = $browse->set_api_filter(date) //optional
* update = $browse->set_api_filter(date) //optional
* include = (array|string) 'albums', 'songs' //optional
* album_artist = (integer) 0,1, if true filter for album artists only //optional
* offset = (integer) //optional
* limit = (integer) //optional
* cond = (string) Apply additional filters to the browse using ';' separated comma string pairs (e.g. 'filter1,value1;filter2,value2') //optional
* sort = (string) sort name or comma separated key pair. Order default 'ASC' (e.g. 'name,ASC' and 'name' are the same) //optional
*/
public static function artists(array $input, User $user): bool
{
$album_artist = (array_key_exists('album_artist', $input) && (int)$input['album_artist'] == 1);
$browse = Api::getBrowse();
if ($album_artist) {
$browse->set_type('album_artist');
} else {
$browse->set_type('artist');
}
$browse->set_sort_order(html_entity_decode((string)($input['sort'] ?? '')), ['name','ASC']);
$method = (array_key_exists('exact', $input) && (int)$input['exact'] == 1) ? 'exact_match' : 'alpha_match';
$browse->set_api_filter($method, $input['filter'] ?? '');
$browse->set_api_filter('add', $input['add'] ?? '');
$browse->set_api_filter('update', $input['update'] ?? '');
$browse->set_conditions(html_entity_decode((string)($input['cond'] ?? '')));
$results = $browse->get_objects();
if (empty($results)) {
Api::empty('artist', $input['api_format']);
return false;
}
ob_end_clean();
$include = [];
if (array_key_exists('include', $input)) {
$include = (is_array($input['include']))
? $input['include']
: explode(',', html_entity_decode((string)($input['include'])));
}
switch ($input['api_format']) {
case 'json':
Json_Data::set_offset((int)($input['offset'] ?? 0));
Json_Data::set_limit($input['limit'] ?? 0);
echo Json_Data::artists($results, $include, $user);
break;
default:
Xml_Data::set_offset((int)($input['offset'] ?? 0));
Xml_Data::set_limit($input['limit'] ?? 0);
echo Xml_Data::artists($results, $include, $user);
}
return true;
}
}