Documentation

C3DBSongs
in package

Table of Contents

$DB  : mixed
__construct()  : mixed
artist_name()  : mixed
buildFiltersQuery()  : mixed
buildQuery()  : array<string|int, mixed>
Builds query data
comments()  : mixed
downloadedSongs()  : mixed
fileID()  : mixed
files()  : mixed
filesAuthor()  : mixed
fileSongID()  : mixed
last_songs()  : mixed
owned_file()  : mixed
owned_song()  : mixed
postProcessData()  : array<string|int, mixed>
Returns fully formatted song data package
random_songs()  : mixed
record_id()  : mixed
songExists()  : mixed
songs()  : mixed
songsField()  : mixed
tableData()  : mixed
tableDataProfile()  : mixed

Properties

$DB

private mixed $DB
Tags
OA\Parameter

( name="song_data_type", description="The type of dataset to be returned. - bare returns only record IDs - song returns only song data - file returns only file data for the song - full returns all data for the song, all files included ", in="query", @OA\Schema( type="string", enum={"bare","song","file","full"} ), @OA\Examples(example="full", value="full", summary="The full set of song data"), @OA\Examples(example="bare", value="bare", summary="The minimum set of song data") )

Methods

__construct()

public __construct() : mixed
Return values
mixed —

artist_name()

public artist_name(mixed $slug) : mixed
Parameters
$slug : mixed
Return values
mixed —

buildFiltersQuery()

public buildFiltersQuery(mixed $filters[, mixed $game = false ]) : mixed
Parameters
$filters : mixed
$game : mixed = false
Return values
mixed —

buildQuery()

Builds query data

public buildQuery(mixed $args[, mixed $options = false ]) : array<string|int, mixed>
Parameters
$args : mixed
$options : mixed = false
Tags
args

array :

pagination

array OPTIONAL : see C3Tools::doPagination for allowed formats

options

scope array OPTIONAL : artist|title|album|author Use these strings as values to focus the search on specific fields

Return values
array<string|int, mixed> —

comments()

public comments(mixed $limit) : mixed
Parameters
$limit : mixed
Return values
mixed —

downloadedSongs()

public downloadedSongs(mixed $user_id) : mixed
Parameters
$user_id : mixed
Return values
mixed —

fileID()

public fileID(mixed $file_id) : mixed
Parameters
$file_id : mixed
Return values
mixed —

files()

public files([mixed $args = false ]) : mixed
Parameters
$args : mixed = false
Return values
mixed —

filesAuthor()

public static filesAuthor(mixed $d) : mixed
Parameters
$d : mixed
Return values
mixed —

fileSongID()

public fileSongID(mixed $file_id) : mixed
Parameters
$file_id : mixed
Return values
mixed —

last_songs()

public last_songs(mixed $limit[, mixed $author = false ]) : mixed
Parameters
$limit : mixed
$author : mixed = false
Return values
mixed —

owned_file()

public owned_file(mixed $file_id, mixed $author) : mixed
Parameters
$file_id : mixed
$author : mixed
Return values
mixed —

owned_song()

public owned_song(mixed $song_id, mixed $author) : mixed
Parameters
$song_id : mixed
$author : mixed
Return values
mixed —

postProcessData()

Returns fully formatted song data package

public postProcessData(mixed $results, mixed $data_type[, mixed $options = false ]) : array<string|int, mixed>
Parameters
$results : mixed
$data_type : mixed
$options : mixed = false
Tags
results

array : Array of songs IDs from self::songs

data_type

string : bare|song|file|full

options

array :

total

bool : If TRUE, return the count for the total dataset available

Return values
array<string|int, mixed> —

random_songs()

public random_songs(mixed $limit[, mixed $author = false ]) : mixed
Parameters
$limit : mixed
$author : mixed = false
Return values
mixed —

record_id()

public record_id(mixed $song_id) : mixed
Parameters
$song_id : mixed
Return values
mixed —

songExists()

public static songExists(mixed $artist, mixed $title) : mixed
Parameters
$artist : mixed
$title : mixed
Return values
mixed —

songs()

public songs(mixed $args, mixed $data_type[, mixed $options = false ]) : mixed
Parameters
$args : mixed
$data_type : mixed
$options : mixed = false
Return values
mixed —

songsField()

public songsField(mixed $d) : mixed
Parameters
$d : mixed
Return values
mixed —

tableData()

public tableData(mixed $record_id, mixed $title, mixed $artist[, mixed $options = false ]) : mixed
Parameters
$record_id : mixed
$title : mixed
$artist : mixed
$options : mixed = false
Return values
mixed —

tableDataProfile()

public tableDataProfile(mixed $record_id, mixed $title, mixed $artist, mixed $album_art[, mixed $options = false ]) : mixed
Parameters
$record_id : mixed
$title : mixed
$artist : mixed
$album_art : mixed
$options : mixed = false
Return values
mixed —

Search results