itstructure / laravel-media-file-uploader

src/Models/Owners/OwnerAlbum.php

<?php

namespace Itstructure\MFU\Models\Owners;

use Illuminate\Database\Eloquent\{Collection as EloquentCollection, Builder as EloquentBuilder};
use Itstructure\MFU\Traits\HasCompositePrimaryKey;
use Itstructure\MFU\Models\Albums\{AlbumBase, AlbumTyped};

/**
 * Class OwnerAlbum
 * @package Itstructure\MFU\Models\Owners
 */
class OwnerAlbum extends Owner
{
    use HasCompositePrimaryKey;

    public $incrementing = false;

    protected $primaryKey = ['album_id', 'owner_id', 'owner_name', 'owner_attribute'];

    protected $table = 'owners_albums';

    protected $fillable = ['album_id', 'owner_id', 'owner_name', 'owner_attribute'];

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function getAlbum()
    {
        return $this->hasOne(AlbumBase::class, 'album_id', 'id');
    }

    /**
     * Get all albums by owner.
     * @param string $ownerName
     * @param int $ownerId
     * @param string|null $ownerAttribute
     * @return EloquentCollection
     */
    public static function getAlbums(string $ownerName, int $ownerId, string $ownerAttribute = null): EloquentCollection
    {
        return static::getAlbumsQuery(static::buildFilterOptions($ownerId, $ownerName, $ownerAttribute))->get();
    }

    /**
     * Get all albums query by owner.
     * @param array $args. It can be an array of the next params: owner_name{string}, owner_id{int}, owner_attribute{string}.
     * @return EloquentBuilder
     */
    public static function getAlbumsQuery(array $args = []): EloquentBuilder
    {
        return AlbumBase::query()->whereIn('id', static::getEntityIdsQuery('album_id', $args)->get()->pluck('album_id'));

The expression return Itstructure\MFU\Models\Albums\AlbumBase::query()->whereIn('id', static::getEntityIdsQuery('album_id', $args)->get()->pluck('album_id')) could return the type Illuminate\Database\Query\Builder which is incompatible with the type-hinted return Illuminate\Database\Eloquent\Builder. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get image albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getImageAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_IMAGE);
    }

    /**
     * Get audio albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getAudioAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_AUDIO);
    }

    /**
     * Get video albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getVideoAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_VIDEO);
    }

    /**
     * Get application albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getAppAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_APP);
    }

    /**
     * Get text albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getTextAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_TEXT);
    }

    /**
     * Get other albums by owner.
     * @param string $ownerName
     * @param int    $ownerId
     * @return EloquentCollection
     */
    public static function getOtherAlbums(string $ownerName, int $ownerId): EloquentCollection
    {
        return static::getAlbums($ownerName, $ownerId, AlbumTyped::ALBUM_TYPE_OTHER);
    }

    /**
     * Get model album primary key name.
     * @return string
     */
    protected static function getDependencyKeyName(): string
    {
        return 'album_id';
    }

    /**
     * @param int $albumId
     * @return bool
     */
    protected static function removeDependency(int $albumId): bool
    {
        return AlbumBase::find($albumId)

The expression return Itstructure\MFU\Models\Albums\AlbumBase::find($albumId)->setRemoveDependencies(true)->delete() could return the type null which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

            ->setRemoveDependencies(true)
            ->delete();
    }
}