class Setting extends Model (View source)

Traits

Translatable
SoftDeletes
TaggableTrait

Properties

protected $presenterInstance from  HasPresenter
$timestamps from  Model
protected $cropParamsKeys from  HasMedias
$useTranslationFallback
protected $fillable
$translatedAttributes

Methods

object
present(string $presenter = 'presenter')

No description

object
presentAdmin()

No description

$this
setPresenter(string $presenter, string $presenterProperty = 'presenter')

No description

$this
setPresenterAdmin(string $presenter)

No description

bool
isTranslatable(array|string|null $columns = null)

Checks if this model is translatable.

array
getDates()

Get the attributes that should be converted to dates.

from  HasDates
isTranslationModel()

No description

from  Model
scopePublished($query)

No description

from  Model
scopePublishedInListings($query)

No description

from  Model
scopeVisible($query)

No description

from  Model
setPublishStartDateAttribute($value)

No description

from  Model
scopeDraft($query)

No description

from  Model
scopeOnlyTrashed($query)

No description

from  Model
getFillable()

No description

from  Model
getTranslatedAttributes()

No description

from  Model
static 
bootTaggableTrait()

No description

from  Model
MorphToMany
tags()

{@inheritdoc}

from  Model
Builder|null
scopeWithActiveTranslations(Builder $query, string|null $locale = null)

No description

Builder
scopeOrderByTranslation(Builder $query, string $orderField, string $orderType = 'ASC', string|null $locale = null)

No description

Builder
scopeOrderByRawByTranslation(Builder $query, string $orderRawString, string $groupByField, string|null $locale = null)

No description

bool
hasActiveTranslation(string|null $locale = null)

Checks if this model has active translations.

Collection
getActiveLanguages()

No description

Collection
translatedAttribute(string $key)

Returns all translations for a given attribute.

static void
bootHasMedias()

No description

MorphToMany
medias()

Defines the many-to-many relationship for media objects.

bool
hasImage(string $role, string $crop = "default")

Checks if an image has been attached for a role and crop.

string|null
image(string $role, string $crop = "default", array $params = [], bool $has_fallback = false, bool $cms = false, Media|null $media = null)

Returns the URL of the attached image for a role and crop.

array
images(string $role, string $crop = "default", array $params = [])

Returns an array of URLs of all attached images for a role and crop.

array
imagesWithCrops(string $role, array $params = [])

Returns an array of URLs of all attached images for a role, including all crops.

array
imageAsArray(string $role, string $crop = "default", array $params = [], Media|null $media = null)

Returns an array of meta information for the image attached for a role and crop.

array
imagesAsArrays(string $role, string $crop = "default", array $params = [])

Returns an array of meta information for all images attached for a role and crop.

array
imagesAsArraysWithCrops(string $role, array $params = [])

Returns an array of meta information for all images attached for a role, including all crops.

string
imageAltText(string $role, Media|null $media = null)

Returns the alt text of the image attached for a role.

string
imageCaption(string $role, Media|null $media = null)

Returns the caption of the image attached for a role.

string
imageVideo(string $role, Media|null $media = null)

Returns the video URL of the image attached for a role.

Media|null
imageObject(string $role, string $crop = "default")

Returns the media object attached for a role and crop.

string|null
lowQualityImagePlaceholder(string $role, string $crop = "default", array $params = [], bool $has_fallback = false)

Returns the LQIP base64 encoded string for a role.

string|null
socialImage(string $role, string $crop = "default", array $params = [], bool $has_fallback = false)

Returns the URL of the social image for a role and crop.

string
cmsImage(string $role, string $crop = "default", array $params = [])

Returns the URL of the CMS image for a role and crop.

string
defaultCmsImage(array $params = [])

Returns the URL of the default CMS image for this model.

Collection
imageObjects(string $role, string $crop = "default")

Returns the media objects associated with a role and crop.

getTable()

No description

string
getTranslationRelationKey()

No description

Details

object present(string $presenter = 'presenter')

No description

Parameters

string $presenter

Return Value

object

object presentAdmin()

No description

Return Value

object

$this setPresenter(string $presenter, string $presenterProperty = 'presenter')

No description

Parameters

string $presenter
string $presenterProperty

Return Value

$this

$this setPresenterAdmin(string $presenter)

No description

Parameters

string $presenter

Return Value

$this

bool isTranslatable(array|string|null $columns = null)

Checks if this model is translatable.

Parameters

array|string|null $columns

Optionally limit the check to a set of columns.

Return Value

bool

array getDates()

Get the attributes that should be converted to dates.

Return Value

array

protected isTranslationModel()

No description

scopePublished($query)

No description

Parameters

$query

scopePublishedInListings($query)

No description

Parameters

$query

scopeVisible($query)

No description

Parameters

$query

setPublishStartDateAttribute($value)

No description

Parameters

$value

scopeDraft($query)

No description

Parameters

$query

scopeOnlyTrashed($query)

No description

Parameters

$query

getFillable()

No description

getTranslatedAttributes()

No description

static protected bootTaggableTrait()

No description

MorphToMany tags()

{@inheritdoc}

Return Value

MorphToMany

getTranslationModelNameDefault()

No description

Builder|null scopeWithActiveTranslations(Builder $query, string|null $locale = null)

No description

Parameters

Builder $query
string|null $locale

Return Value

Builder|null

Builder scopeOrderByTranslation(Builder $query, string $orderField, string $orderType = 'ASC', string|null $locale = null)

No description

Parameters

Builder $query
string $orderField
string $orderType
string|null $locale

Return Value

Builder

Builder scopeOrderByRawByTranslation(Builder $query, string $orderRawString, string $groupByField, string|null $locale = null)

No description

Parameters

Builder $query
string $orderRawString
string $groupByField
string|null $locale

Return Value

Builder

bool hasActiveTranslation(string|null $locale = null)

Checks if this model has active translations.

Parameters

string|null $locale

Return Value

bool

Collection getActiveLanguages()

No description

Return Value

Collection

Collection translatedAttribute(string $key)

Returns all translations for a given attribute.

Parameters

string $key

Return Value

Collection

static void bootHasMedias()

No description

Return Value

void

MorphToMany medias()

Defines the many-to-many relationship for media objects.

Return Value

MorphToMany

bool hasImage(string $role, string $crop = "default")

Checks if an image has been attached for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

Return Value

bool

string|null image(string $role, string $crop = "default", array $params = [], bool $has_fallback = false, bool $cms = false, Media|null $media = null)

Returns the URL of the attached image for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.

bool $cms

Indicate that you are displaying this image in the CMS views.

Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string|null

array images(string $role, string $crop = "default", array $params = [])

Returns an array of URLs of all attached images for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

array imagesWithCrops(string $role, array $params = [])

Returns an array of URLs of all attached images for a role, including all crops.

Parameters

string $role

Role name.

array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

array imageAsArray(string $role, string $crop = "default", array $params = [], Media|null $media = null)

Returns an array of meta information for the image attached for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

array

array imagesAsArrays(string $role, string $crop = "default", array $params = [])

Returns an array of meta information for all images attached for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

array imagesAsArraysWithCrops(string $role, array $params = [])

Returns an array of meta information for all images attached for a role, including all crops.

Parameters

string $role

Role name.

array $params

Parameters compatible with the current image service, like w or h.

Return Value

array

string imageAltText(string $role, Media|null $media = null)

Returns the alt text of the image attached for a role.

Parameters

string $role

Role name.

Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

string imageCaption(string $role, Media|null $media = null)

Returns the caption of the image attached for a role.

Parameters

string $role

Role name.

Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

string imageVideo(string $role, Media|null $media = null)

Returns the video URL of the image attached for a role.

Parameters

string $role

Role name.

Media|null $media

Provide a media object if you already retrieved one to prevent more SQL queries.

Return Value

string

Media|null imageObject(string $role, string $crop = "default")

Returns the media object attached for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

Return Value

Media|null

string|null lowQualityImagePlaceholder(string $role, string $crop = "default", array $params = [], bool $has_fallback = false)

Returns the LQIP base64 encoded string for a role.

Use this in conjunction with the RefreshLQIP Artisan command.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.

Return Value

string|null

See also

RefreshLQIP

string|null socialImage(string $role, string $crop = "default", array $params = [], bool $has_fallback = false)

Returns the URL of the social image for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

bool $has_fallback

Indicate that you can provide a fallback. Will return null instead of the default image fallback.

Return Value

string|null

string cmsImage(string $role, string $crop = "default", array $params = [])

Returns the URL of the CMS image for a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

array $params

Parameters compatible with the current image service, like w or h.

Return Value

string

string defaultCmsImage(array $params = [])

Returns the URL of the default CMS image for this model.

Parameters

array $params

Parameters compatible with the current image service, like w or h.

Return Value

string

Collection imageObjects(string $role, string $crop = "default")

Returns the media objects associated with a role and crop.

Parameters

string $role

Role name.

string $crop

Crop name.

Return Value

Collection

getTable()

No description

protected string getTranslationRelationKey()

No description

Return Value

string