Bånder

MetadataJobDispatcher
in package

Table of Contents

Properties

$defaultBatchSize  : int
$defaultQueue  : string

Methods

__construct()  : mixed
getLibraryStats()  : array<string|int, mixed>
syncAlbums()  : int
syncAlbumsFull()  : int
syncAlbumsGeneral()  : int
Enhanced album sync methods with specific sync types
syncAlbumsIdentifierBased()  : int
syncAlbumsLegacy()  : int
syncArtists()  : int
syncArtistsFull()  : int
syncArtistsGeneral()  : int
Enhanced artist sync methods with specific sync types
syncArtistsIdentifierBased()  : int
syncArtistsLegacy()  : int
syncLibrary()  : int
syncMixed()  : int
syncSongs()  : int
validateIds()  : array<string|int, mixed>

Properties

Methods

__construct()

public __construct([int $defaultBatchSize = 10 ][, string $defaultQueue = 'default' ]) : mixed
Parameters
$defaultBatchSize : int = 10
$defaultQueue : string = 'default'

getLibraryStats()

public getLibraryStats(int $libraryId) : array<string|int, mixed>
Parameters
$libraryId : int
Return values
array<string|int, mixed>

syncAlbums()

public syncAlbums(array<string|int, mixed> $albumIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ][, bool $includeSongs = false ][, bool $includeArtists = false ][, callable|null $progressCallback = null ][, string $syncType = 'general' ]) : int
Parameters
$albumIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
$includeSongs : bool = false
$includeArtists : bool = false
$progressCallback : callable|null = null
$syncType : string = 'general'
Return values
int

syncAlbumsFull()

public syncAlbumsFull(array<string|int, mixed> $albumIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$albumIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncAlbumsGeneral()

Enhanced album sync methods with specific sync types

public syncAlbumsGeneral(array<string|int, mixed> $albumIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$albumIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncAlbumsIdentifierBased()

public syncAlbumsIdentifierBased(array<string|int, mixed> $albumIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$albumIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncAlbumsLegacy()

public syncAlbumsLegacy(array<string|int, mixed> $albumIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$albumIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncArtists()

public syncArtists(array<string|int, mixed> $artistIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ][, callable|null $progressCallback = null ][, string $syncType = 'general' ]) : int
Parameters
$artistIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
$progressCallback : callable|null = null
$syncType : string = 'general'
Return values
int

syncArtistsFull()

public syncArtistsFull(array<string|int, mixed> $artistIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$artistIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncArtistsGeneral()

Enhanced artist sync methods with specific sync types

public syncArtistsGeneral(array<string|int, mixed> $artistIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$artistIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncArtistsIdentifierBased()

public syncArtistsIdentifierBased(array<string|int, mixed> $artistIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$artistIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncArtistsLegacy()

public syncArtistsLegacy(array<string|int, mixed> $artistIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ]) : int
Parameters
$artistIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
Return values
int

syncLibrary()

public syncLibrary(int $libraryId[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ][, bool $includeSongs = false ][, bool $includeArtists = false ][, callable|null $progressCallback = null ][, string $albumSyncType = 'general' ][, string $artistSyncType = 'general' ]) : int
Parameters
$libraryId : int
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
$includeSongs : bool = false
$includeArtists : bool = false
$progressCallback : callable|null = null
$albumSyncType : string = 'general'
$artistSyncType : string = 'general'
Return values
int

syncMixed()

public syncMixed([array<string|int, mixed> $albumIds = [] ][, array<string|int, mixed> $songIds = [] ][, array<string|int, mixed> $artistIds = [] ][, int|null $libraryId = null ][, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ][, bool $includeSongs = false ][, bool $includeArtists = false ][, callable|null $progressCallback = null ]) : int
Parameters
$albumIds : array<string|int, mixed> = []
$songIds : array<string|int, mixed> = []
$artistIds : array<string|int, mixed> = []
$libraryId : int|null = null
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
$includeSongs : bool = false
$includeArtists : bool = false
$progressCallback : callable|null = null
Return values
int

syncSongs()

public syncSongs(array<string|int, mixed> $songIds[, bool $forceUpdate = false ][, int|null $batchSize = null ][, string|null $queueName = null ][, callable|null $progressCallback = null ]) : int
Parameters
$songIds : array<string|int, mixed>
$forceUpdate : bool = false
$batchSize : int|null = null
$queueName : string|null = null
$progressCallback : callable|null = null
Return values
int

validateIds()

public validateIds([array<string|int, mixed> $albumIds = [] ][, array<string|int, mixed> $songIds = [] ][, array<string|int, mixed> $artistIds = [] ]) : array<string|int, mixed>
Parameters
$albumIds : array<string|int, mixed> = []
$songIds : array<string|int, mixed> = []
$artistIds : array<string|int, mixed> = []
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results