1. class
  2. Biigle
  3. \
  4. Project

Project

class Project extends Model

Traits

HasFactory

Properties

protected array $hidden

The attributes hidden from the model's JSON form.

Methods

Builder
scopeInCommon(Builder $query, User $user, int $volumeId, array $roles = null)

Scope a query to all projects that the user and the volume with the given ID have in common.

Builder
scopeAccessibleBy(Builder $query, User $user)

Scope a query to all projects that are accessible by a user.

BelongsToMany
users()

The members of this project. Every member has a project-specific project_role_id besides their global user role.

BelongsToMany
admins()

All members of this project with the admin role.

BelongsToMany
editors()

All members of this project with the editor role.

BelongsToMany
guests()

All members of this project with the guest role.

BelongsTo
creator()

The user that created this project. On creation this user is automatically added to the project's users with the 'admin' role by the ProjectObserver.

void
addUserId(int $userId, int $roleId)

Adds the user with the given role to this project.

void
changeRole(int $userId, int $roleId)

Changes the role of an existing user in this project.

bool
userCanBeRemoved(int $userId)

Determines if the user can be removed from the project.

bool
removeUserId(int $userId)

Removes the user by ID from this project.

BelongsToMany
volumes()

The volumes of this project.

BelongsToMany
imageVolumes()

The image volumes of this project.

BelongsToMany
videoVolumes()

The video volumes of this project.

void
addVolumeId(int $id) deprecated

Adds a volume to this project if it wasn't already.

removeVolume(Volume $volume, bool $force = false)

Detaches the volume from this project. Fails if this is the last project, the volume is attached to, unless force is true.

removeAllVolumes(bool $force = false)

Detaches all volumes from this project. Fails if this is the last project, one of the volumes is attached to, unless force is true.

BelongsToMany
labelTrees()

The label trees, this project is using.

BelongsToMany
authorizedLabelTrees()

The private label trees that authorized this project to use them.

string
getThumbnailUrlAttribute()

URL to a unique thumbnail image for this project.

bool
hasGeoInfo()

Check if the project has volumes which have some images with GPS coordinates.

flushGeoInfoCache()

Flush the cached information if this project has volumes which have images with GPS coordinates.

Details

at line 34
Builder scopeInCommon(Builder $query, User $user, int $volumeId, array $roles = null)

Scope a query to all projects that the user and the volume with the given ID have in common.

Parameters

Builder $query
User $user
int $volumeId
array $roles

Array of role IDs to restrict the project membership to. Default is any role.

Return Value

Builder

at line 56
Builder scopeAccessibleBy(Builder $query, User $user)

Scope a query to all projects that are accessible by a user.

Parameters

Builder $query
User $user

Return Value

Builder

at line 76
BelongsToMany users()

The members of this project. Every member has a project-specific project_role_id besides their global user role.

Return Value

BelongsToMany

at line 87
BelongsToMany admins()

All members of this project with the admin role.

Return Value

BelongsToMany

at line 97
BelongsToMany editors()

All members of this project with the editor role.

Return Value

BelongsToMany

at line 107
BelongsToMany guests()

All members of this project with the guest role.

Return Value

BelongsToMany

at line 119
BelongsTo creator()

The user that created this project. On creation this user is automatically added to the project's users with the 'admin' role by the ProjectObserver.

Return Value

BelongsTo

at line 131
void addUserId(int $userId, int $roleId)

Adds the user with the given role to this project.

Parameters

int $userId
int $roleId

Return Value

void

at line 143
void changeRole(int $userId, int $roleId)

Changes the role of an existing user in this project.

Parameters

int $userId
int $roleId

Return Value

void

at line 154
bool userCanBeRemoved(int $userId)

Determines if the user can be removed from the project.

Parameters

int $userId

Return Value

bool

at line 165
bool removeUserId(int $userId)

Removes the user by ID from this project.

Parameters

int $userId

Return Value

bool

at line 179
BelongsToMany volumes()

The volumes of this project.

Return Value

BelongsToMany

at line 189
BelongsToMany imageVolumes()

The image volumes of this project.

Return Value

BelongsToMany

at line 199
BelongsToMany videoVolumes()

The video volumes of this project.

Return Value

BelongsToMany

at line 212
void addVolumeId(int $id) deprecated

deprecated Use `$project->volumes()->attach($id)` instead.

Adds a volume to this project if it wasn't already.

Parameters

int $id

Return Value

void

at line 227
removeVolume(Volume $volume, bool $force = false)

Detaches the volume from this project. Fails if this is the last project, the volume is attached to, unless force is true.

Parameters

Volume $volume
bool $force

Delete the volume completely if this is the last project it belongs to

at line 257
removeAllVolumes(bool $force = false)

Detaches all volumes from this project. Fails if this is the last project, one of the volumes is attached to, unless force is true.

Parameters

bool $force

at line 280
BelongsToMany labelTrees()

The label trees, this project is using.

Return Value

BelongsToMany

at line 290
BelongsToMany authorizedLabelTrees()

The private label trees that authorized this project to use them.

Return Value

BelongsToMany

at line 300
string getThumbnailUrlAttribute()

URL to a unique thumbnail image for this project.

Return Value

string

at line 321
bool hasGeoInfo()

Check if the project has volumes which have some images with GPS coordinates.

Return Value

bool

at line 339
flushGeoInfoCache()

Flush the cached information if this project has volumes which have images with GPS coordinates.