Documentation

Authors
in package

Table of Contents

__construct()  : mixed
admins()  : mixed
authorExists()  : mixed
authors_byclass()  : mixed
countAuthors()  : int
Returns the number of authors
countAuthorsQuery()  : string
Returns the query used to count authors
countPublishedAuthors()  : int
Returns the number of authors with at least one song in the DB
current_author()  : mixed
dashboardData()  : mixed
dataList()  : array<string|int, mixed>
Returns a list of authors
followed_total()  : mixed
followed_validate()  : mixed
freeMagmaID()  : mixed

Methods

__construct()

public __construct() : mixed
Return values
mixed —

admins()

public static admins() : mixed
Return values
mixed —

authorExists()

public static authorExists(mixed $shortname) : mixed
Parameters
$shortname : mixed
Return values
mixed —

authors_byclass()

public authors_byclass() : mixed
Return values
mixed —

countAuthors()

Returns the number of authors

public static countAuthors([mixed $options = false ]) : int
Parameters
$options : mixed = false
Tags
options

array : To be implemented if needed

Return values
int —

countAuthorsQuery()

Returns the query used to count authors

public static countAuthorsQuery([mixed $published = false ]) : string
Parameters
$published : mixed = false
Tags
published

bool : Only queries for authors with at least one file released

Return values
string —

countPublishedAuthors()

Returns the number of authors with at least one song in the DB

public static countPublishedAuthors([mixed $options = false ]) : int
Parameters
$options : mixed = false
Tags
options

array : To be implemented if needed

Return values
int —

current_author()

public current_author() : mixed
Return values
mixed —

dashboardData()

public dashboardData() : mixed
Return values
mixed —

dataList()

Returns a list of authors

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

start int OPTIONAL : Returns records starting from this index

options

limit int OPTIONAL : Limits records to this how many, defaults to Config::$api_default_records;

options

sort string OPTIONAL : Sort by this field. The list is always also further sorted by name ASC

options

order string OPTIONAL : Sort order

options

total_filtered bool : If TRUE returns the total count of a search

options

starts_with string OPTIONAL : Returns only artists whose name starts with this letter

options

text string OPTIONAL : Returns only artists whose name matches in part this string

author_options

array OPTIONAL : Options to be passed to the Author object

scope

string : full|public|private Dictates which fields to serve Only a limited amount of fields are for public consumption Defaults to public, full|private are only available to admins WARNING: there is no admin check here, make sure to require the correct scope

Return values
array<string|int, mixed> —

Returns category_id, category_domain_id array

followed_total()

public followed_total(mixed $user) : mixed
Parameters
$user : mixed
Return values
mixed —

followed_validate()

public followed_validate(mixed $user) : mixed
Parameters
$user : mixed
Return values
mixed —

freeMagmaID()

public static freeMagmaID([mixed $flag = false ]) : mixed
Parameters
$flag : mixed = false
Return values
mixed —

Search results