1. trait
  2. A17
  3. \
  4. Twill
  5. \
  6. Models
  7. \
  8. Behaviors
  9. \
  10. HasMedias

HasMedias

trait HasMedias (View source)

Properties

protected $cropParamsKeys

Methods

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.

Details

at line 20
static void bootHasMedias()

No description

Return Value

void

at line 35
MorphToMany medias()

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

Return Value

MorphToMany

at line 81
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

at line 99
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

at line 133
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

at line 155
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

at line 180
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

at line 208
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

at line 230
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

at line 253
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

at line 279
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

at line 305
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

at line 333
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

at line 349
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

at line 374
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

at line 399
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

at line 410
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

at line 428
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