PHP Class app\models\Beatmapset

Inheritance: extends Illuminate\Database\Eloquent\Model
Show file Open project: ppy/osu-web Class Usage Examples

Public Properties

Property Type Description
$timestamps

Protected Properties

Property Type Description
$_storage
$casts
$dates
$fillable
$hidden
$primaryKey
$table

Public Methods

Method Description
allCoverURLs ( )
approver ( )
beatmaps ( ) * |-------------------------------------------------------------------------- | Relationships |-------------------------------------------------------------------------- | | One set has many beatmaps, which in turn have many mods | One set has a single creator.
beatmapsetDiscussion ( ) ranking functions for the set
comments ( $time = null )
coverPath ( )
coverSizes ( )
coverURL ( $coverSize = 'cover' )
currentNominationCount ( )
defaultBeatmaps ( )
defaultJson ( $currentUser = null )
description ( )
disqualify ( User $user, $comment )
events ( )
favourite ( $user )
favourites ( )
hasFavourited ( $user )
isApproved ( )
isGraveyard ( ) one-time checks
isPending ( )
isQualified ( )
isRanked ( )
isValidCoverSize ( $coverSize )
isWIP ( )
listing ( )
mods ( )
nominate ( User $user )
oszDownloadURL ( $noVideo = 1 ) todo: generalize method
previewURL ( )
qualify ( )
rankingETA ( )
ratingsCount ( )
recentEvents ( )
regenerateCovers ( )
replies ( $time = null )
requiredNominationCount ( )
scanBMForBG ( $beatmapFilename ) todo: maybe move this somewhere else (copypasta from old implementation)
scopeActive ( $query )
scopeApproved ( $query )
scopeGraveyard ( $query ) * |-------------------------------------------------------------------------- | Scope Checker Functions |-------------------------------------------------------------------------- | | Checks the approval column, but allows a global filter for | use with the query builder. Beatmapset::all()->unranked() |
scopeQualified ( $query )
scopeRankable ( $query ) Beatmapset::rankable();
scopeRanked ( $query )
scopeRankedOrApproved ( $query )
scopeUnranked ( $query )
scopeWip ( $query )
search ( array $params = [] )
searchDB ( array $params = [] )
searchES ( array $params = [] )
status ( )
storage ( )
storeCover ( $target_filename, $source_path )
unfavourite ( $user )
user ( )
userRatings ( )

Private Methods

Method Description
sanitizeSearchParams ( array &$params = [] )

Method Details

allCoverURLs() public method

public allCoverURLs ( )

approver() public method

public approver ( )

beatmaps() public method

|
public beatmaps ( )

beatmapsetDiscussion() public method

ranking functions for the set

comments() public method

public comments ( $time = null )

coverPath() public method

public coverPath ( )

coverSizes() public static method

public static coverSizes ( )

coverURL() public method

public coverURL ( $coverSize = 'cover' )

currentNominationCount() public method

defaultBeatmaps() public method

public defaultBeatmaps ( )

defaultJson() public method

public defaultJson ( $currentUser = null )

description() public method

public description ( )

disqualify() public method

public disqualify ( User $user, $comment )
$user User

events() public method

public events ( )

favourite() public method

public favourite ( $user )

favourites() public method

public favourites ( )

hasFavourited() public method

public hasFavourited ( $user )

isApproved() public method

public isApproved ( )

isGraveyard() public method

one-time checks
public isGraveyard ( )

isPending() public method

public isPending ( )

isQualified() public method

public isQualified ( )

isRanked() public method

public isRanked ( )

isValidCoverSize() public static method

public static isValidCoverSize ( $coverSize )

isWIP() public method

public isWIP ( )

listing() public static method

public static listing ( )

mods() public method

public mods ( )

nominate() public method

public nominate ( User $user )
$user User

oszDownloadURL() public method

todo: generalize method
public oszDownloadURL ( $noVideo = 1 )

previewURL() public method

public previewURL ( )

qualify() public method

public qualify ( )

rankingETA() public method

public rankingETA ( )

ratingsCount() public method

public ratingsCount ( )

recentEvents() public method

public recentEvents ( )

regenerateCovers() public method

public regenerateCovers ( )

replies() public method

public replies ( $time = null )

requiredNominationCount() public method

scanBMForBG() public method

todo: maybe move this somewhere else (copypasta from old implementation)
public scanBMForBG ( $beatmapFilename )

scopeActive() public method

public scopeActive ( $query )

scopeApproved() public method

public scopeApproved ( $query )

scopeGraveyard() public method

* |-------------------------------------------------------------------------- | Scope Checker Functions |-------------------------------------------------------------------------- | | Checks the approval column, but allows a global filter for | use with the query builder. Beatmapset::all()->unranked() |
public scopeGraveyard ( $query )

scopeQualified() public method

public scopeQualified ( $query )

scopeRankable() public method

Beatmapset::rankable();
public scopeRankable ( $query )

scopeRanked() public method

public scopeRanked ( $query )

scopeRankedOrApproved() public method

public scopeRankedOrApproved ( $query )

scopeUnranked() public method

public scopeUnranked ( $query )

scopeWip() public method

public scopeWip ( $query )

searchDB() public static method

public static searchDB ( array $params = [] )
$params array

searchES() public static method

public static searchES ( array $params = [] )
$params array

status() public method

public status ( )

storage() public method

public storage ( )

storeCover() public method

public storeCover ( $target_filename, $source_path )

unfavourite() public method

public unfavourite ( $user )

user() public method

public user ( )

userRatings() public method

public userRatings ( )

Property Details

$_storage protected property

protected $_storage

$casts protected property

protected $casts

$dates protected property

protected $dates

$fillable protected property

protected $fillable

$hidden protected property

protected $hidden

$primaryKey protected property

protected $primaryKey

$table protected property

protected $table

$timestamps public property

public $timestamps