Documentation

Artist
in package

Artist library.

Tags
author

Farottone

OA\Schema

( schema="Artist", title="Artist", @OA\Xml( name="Artist library" ) )

Table of Contents

$artist_s  : string
$id  : string
$int  : mixed
$name  : mixed
$modelArtistData  : mixed
__construct()  : mixed
_modelArtistData()  : array<string|int, mixed>
Artist data model Stores all fields from the DB that become properties We can also serve this fields in an object or array
data()  : array<string|int, mixed>
Serves artist data

Properties

$artist_s

public string $artist_s
Tags
OA\Property

( title="artist_s", description="Same as id, used for consistency with database columns", format="string", )

$id

public string $id
Tags
OA\Property

( title="id", description="Slugified name of the artist used as ID", format="string", )

$int

public mixed $int
Tags
OA\Property

( title="songs", description="Total number of songs available for any platform. Note: this is a song not a file count.", format="int", )

$name

public mixed $name
Tags
OA\Property

( title="name", description="Full name of the artist", format="string", )

$modelArtistData

private static mixed $modelArtistData = array("id" => "public", "name" => "public", "songs" => "public", "artist_s" => "public")

Methods

__construct()

public __construct(mixed $artist_s[, mixed $scope = false ]) : mixed
Parameters
$artist_s : mixed
$scope : mixed = false
Return values
mixed —

_modelArtistData()

Artist data model Stores all fields from the DB that become properties We can also serve this fields in an object or array

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

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> —

data()

Serves artist data

private data([mixed $options = false ]) : array<string|int, mixed>
Parameters
$options : mixed = false
Tags
options

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> —

Search results