Index | API

A

AlbumInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for album resources.
AlbumResourceInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for album resources.
ArtistInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for artist resources.
ArtistResourceInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for artist resources.
AlbumResource — Class in namespace Cable8mm\WaterMelon\Resources: Album resource for mapping from melon.com.
ArtistResource — Class in namespace Cable8mm\WaterMelon\Resources: Artist resource for mapping from melon.com.
$ WaterMelon#album — Property in class WaterMelon
$ WaterMelon#artists — Property in class WaterMelon

C

$ Melon#client — Property in class Melon
$ Resource#container — Property in class Resource

E

MelonApiException::emptyResponse() — Method in class MelonApiException: Create exception for empty response.
Melon::emptyToNull() — Method in class Melon: Infer the default image for Melon as null
Resource::emptyToNull() — Method in class Resource: Infer the default image for Melon as null

G

AlbumInterface::getId() — Method in class AlbumInterface: Get the album ID.
AlbumInterface::getTitle() — Method in class AlbumInterface: Get the album title.
AlbumInterface::getAlbumCoverPath() — Method in class AlbumInterface: Get the album cover image path.
AlbumInterface::getReleasedAt() — Method in class AlbumInterface: Get the release date.
AlbumResourceInterface::getMelonAlbumId() — Method in class AlbumResourceInterface: Get the album ID.
AlbumResourceInterface::getTitle() — Method in class AlbumResourceInterface: Get the album title.
AlbumResourceInterface::getAlbumCoverPath() — Method in class AlbumResourceInterface: Get the album cover image path.
AlbumResourceInterface::getReleasedAt() — Method in class AlbumResourceInterface: Get the release date.
ArtistInterface::getId() — Method in class ArtistInterface: Get the artist ID.
ArtistInterface::getName() — Method in class ArtistInterface: Get the artist name.
ArtistInterface::getFeaturedImagePath() — Method in class ArtistInterface: Get the featured image path.
ArtistInterface::getProfileImagePath() — Method in class ArtistInterface: Get the profile image path.
ArtistInterface::getBirth() — Method in class ArtistInterface: Get the birth date.
ArtistInterface::getDebut() — Method in class ArtistInterface: Get the debut date.
ArtistInterface::getAgency() — Method in class ArtistInterface: Get the agency.
ArtistInterface::getGenre() — Method in class ArtistInterface: Get the genre.
ArtistResourceInterface::getMelonArtistId() — Method in class ArtistResourceInterface: Get the artist ID.
ArtistResourceInterface::getName() — Method in class ArtistResourceInterface: Get the artist name.
ArtistResourceInterface::getFeaturedImagePath() — Method in class ArtistResourceInterface: Get the featured image path.
ArtistResourceInterface::getProfileImagePath() — Method in class ArtistResourceInterface: Get the profile image path.
ArtistResourceInterface::getDebut() — Method in class ArtistResourceInterface: Get the debut date.
SongInterface::getId() — Method in class SongInterface: Get the song ID.
SongInterface::getTitle() — Method in class SongInterface: Get the song title.
SongInterface::getAlbumId() — Method in class SongInterface: Get the album ID.
SongInterface::getArtworkImagePath() — Method in class SongInterface: Get the artwork image path.
SongResourceInterface::getMelonSongId() — Method in class SongResourceInterface: Get the song ID.
SongResourceInterface::getTitle() — Method in class SongResourceInterface: Get the song title.
SongResourceInterface::getAlbumId() — Method in class SongResourceInterface: Get the album ID.
SongResourceInterface::getArtworkImagePath() — Method in class SongResourceInterface: Get the artwork image path.
MelonAlbum::getId() — Method in class MelonAlbum: Get the album ID.
MelonAlbum::getTitle() — Method in class MelonAlbum: Get the album title.
MelonAlbum::getAlbumCoverPath() — Method in class MelonAlbum: Get the album cover image path.
MelonAlbum::getReleasedAt() — Method in class MelonAlbum: Get the release date.
MelonArtist::getId() — Method in class MelonArtist: Get the artist ID.
MelonArtist::getName() — Method in class MelonArtist: Get the artist name.
MelonArtist::getFeaturedImagePath() — Method in class MelonArtist: Get the featured image path.
MelonArtist::getProfileImagePath() — Method in class MelonArtist: Get the profile image path.
MelonArtist::getBirth() — Method in class MelonArtist: Get the birth date.
MelonArtist::getDebut() — Method in class MelonArtist: Get the debut date.
MelonArtist::getAgency() — Method in class MelonArtist: Get the agency.
MelonArtist::getGenre() — Method in class MelonArtist: Get the genre.
MelonSong::getId() — Method in class MelonSong: Get the song ID.
MelonSong::getTitle() — Method in class MelonSong: Get the song title.
MelonSong::getAlbumId() — Method in class MelonSong: Get the album ID.
MelonSong::getArtworkImagePath() — Method in class MelonSong: Get the artwork image path.
AlbumResource::getMelonAlbumId() — Method in class AlbumResource: Get the album ID.
AlbumResource::getTitle() — Method in class AlbumResource: Get the album title.
AlbumResource::getAlbumCoverPath() — Method in class AlbumResource: Get the album cover image path.
AlbumResource::getReleasedAt() — Method in class AlbumResource: Get the release date.
ArtistResource::getMelonArtistId() — Method in class ArtistResource: Get the artist ID.
ArtistResource::getName() — Method in class ArtistResource: Get the artist name.
ArtistResource::getFeaturedImagePath() — Method in class ArtistResource: Get the featured image path.
ArtistResource::getProfileImagePath() — Method in class ArtistResource: Get the profile image path.
ArtistResource::getDebut() — Method in class ArtistResource: Get the debut date.
SongResource::getMelonSongId() — Method in class SongResource: Get the song ID.
SongResource::getTitle() — Method in class SongResource: Get the song title.
SongResource::getAlbumId() — Method in class SongResource: Get the album ID.
SongResource::getArtworkImagePath() — Method in class SongResource: Get the artwork image path.
WaterMelon::getSong() — Method in class WaterMelon: Getter to get a information about a song.
WaterMelon::getAlbum() — Method in class WaterMelon: Getter to get a information about a album.
WaterMelon::getArtists() — Method in class WaterMelon: Getter to get a information about artists.

I

MelonApiException::invalidResponse() — Method in class MelonApiException: Create exception for invalid response structure
$ Melon#id — Property in class Melon

J

MelonApiException::jsonParseError() — Method in class MelonApiException: Create exception for JSON parsing failure

M

MelonApiException — Class in namespace Cable8mm\WaterMelon\Exceptions: Exception thrown when the Melon API returns an error or invalid response.
Melon — Class in namespace Cable8mm\WaterMelon: Abstract class for WaterMelon classes.
Melon::make() — Method in class Melon: Class factory to make Melon instance.
MelonAlbum — Class in namespace Cable8mm\WaterMelon: Fetches information about a album from the melon.com API.
MelonArtist — Class in namespace Cable8mm\WaterMelon: Fetches information about a artist from the melon.com API.
MelonSong — Class in namespace Cable8mm\WaterMelon: Fetches information about a song from the melon.com API.
$ AlbumResource#melon — Property in class AlbumResource
AlbumResource::make() — Method in class AlbumResource: Create a new AlbumResource instance.
$ ArtistResource#melon — Property in class ArtistResource
ArtistResource::make() — Method in class ArtistResource: Create a new ArtistResource instance.
$ Resource#melon — Property in class Resource
$ SongResource#melon — Property in class SongResource
SongResource::make() — Method in class SongResource: Create a new SongResource instance.
Makeable — Class in namespace Cable8mm\WaterMelon\Traits: Factory class for creating traits.
Makeable::make() — Method in class Makeable: Create a new instance.
WaterMelon::make() — Method in class WaterMelon: Create a new WaterMelon instance from a song ID.
WaterMelonFactory::make() — Method in class WaterMelonFactory: Create a new WaterMelon instance from a song ID.

O

Melon::offsetSet() — Method in class Melon: Setter for ArrayAccess.
Melon::offsetExists() — Method in class Melon: Whether an offset exists
Melon::offsetUnset() — Method in class Melon: Unset an offset
Melon::offsetGet() — Method in class Melon: Offset to retrieve
Resource::offsetSet() — Method in class Resource: ArrayAccess implementation.
Resource::offsetExists() — Method in class Resource: ArrayAccess implementation.
Resource::offsetUnset() — Method in class Resource: ArrayAccess implementation.
Resource::offsetGet() — Method in class Resource: ArrayAccess implementation.

P

AlbumInterface::parse() — Method in class AlbumInterface: Parse the resource data.
ArtistInterface::parse() — Method in class ArtistInterface: Parse the resource data.
SongInterface::parse() — Method in class SongInterface: Parse the resource data.
Melon::parse() — Method in class Melon: Fetches information about a song, a album or a artist from the melon.com API and saves it to $response and returns it.
MelonAlbum::parse() — Method in class MelonAlbum: Fetches information about a song, a album or a artist from the melon.com API and saves it to $response and returns it.
MelonArtist::parse() — Method in class MelonArtist: Fetches information about a song, a album or a artist from the melon.com API and saves it to $response and returns it.
MelonSong::parse() — Method in class MelonSong: Fetches information about a song, a album or a artist from the melon.com API and saves it to $response and returns it.
WaterMelon::parse() — Method in class WaterMelon: To get a instance of the WaterMelon class after fetching information about a song from the melon.com API.

R

MelonApiException::requestFailed() — Method in class MelonApiException: Create exception for HTTP request failure
$ Melon#response — Property in class Melon
Resource — Class in namespace Cable8mm\WaterMelon\Resources: Resource class for general melon resources.

S

SongInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for song resources.
SongResourceInterface — Class in namespace Cable8mm\WaterMelon\Contracts: Interface for song resources.
SongResource — Class in namespace Cable8mm\WaterMelon\Resources: Song resource for mapping from melon.com.
$ WaterMelon#song — Property in class WaterMelon

T

AlbumResourceInterface::toArray() — Method in class AlbumResourceInterface: Get the resource as an array.
ArtistResourceInterface::toArray() — Method in class ArtistResourceInterface: Get the resource as an array.
SongResourceInterface::toArray() — Method in class SongResourceInterface: Get the resource as an array.
AlbumResource::toArray() — Method in class AlbumResource: To get resource as array.
ArtistResource::toArray() — Method in class ArtistResource: To get resource as array.
Resource::toArray() — Method in class Resource: To get resource as array.
SongResource::toArray() — Method in class SongResource: To get resource as array.

W

WaterMelon — Class in namespace Cable8mm\WaterMelon: Fetch all information about a song, song's albums and song's artists from the melon.com API.
WaterMelonFactory — Class in namespace Cable8mm\WaterMelon: Factory class for creating WaterMelon instances.

_

MelonApiException::__construct() — Method in class MelonApiException: Create a new MelonApiException instance
Melon::__construct() — Method in class Melon: Class constructor.
Resource::__construct() — Method in class Resource: Constructor.
Resource::__get() — Method in class Resource: Reading data from inaccessible (protected or private) or non-existing properties.
WaterMelon::__construct() — Method in class WaterMelon: Constructor.