SlideImage
in package
implements
SlideImageInterface
Class SlideImage
Represents the default settings of a single image in a slide.
Tags
Interfaces, Classes and Traits
- SlideImageInterface
- Interface SlideImageInterface
Table of Contents
- $breakpoint : string
- Breakpoint
- $id : int
- Slide image ID
- $image : string
- Image
- $languageId : int
- Language ID
- $slideImageAreaCollection : SlideImageAreaCollection
- Collection of slide image areas
- __construct() : mixed
- SlideImage constructor.
- addSlideImageArea() : SlideImageInterface
- Adds a slide image area to the slide image area collection
- getBreakpoint() : string
- Return the breakpoint of the slide image.
- getId() : int
- Return the ID of the slide image.
- getImage() : string
- Return the image of the image slider.
- getLanguageId() : int
- Return the language ID of the slide image.
- getSlideImageAreaCollection() : SlideImageAreaCollection
- Return the slide image area collection of the slide image.
- setBreakpoint() : SlideImageInterface
- Set the breakpoint for the slide image.
- setId() : SlideImageInterface
- Set the slide image ID.
- setImage() : SlideImageInterface
- Set the image for the image slider.
- setLanguageId() : SlideImageInterface
- Set the language ID for the slide image.
- setSlideImageAreaCollection() : SlideImageInterface
- Set the slide image area collection for the slide image.
Properties
$breakpoint
Breakpoint
protected
string
$breakpoint
= ''
$id
Slide image ID
protected
int
$id
= 0
$image
Image
protected
string
$image
= ''
$languageId
Language ID
protected
int
$languageId
= 0
$slideImageAreaCollection
Collection of slide image areas
protected
SlideImageAreaCollection
$slideImageAreaCollection
Methods
__construct()
SlideImage constructor.
public
__construct() : mixed
Return values
mixed —addSlideImageArea()
Adds a slide image area to the slide image area collection
public
addSlideImageArea(SlideImageAreaInterface $slideImageArea) : SlideImageInterface
Parameters
- $slideImageArea : SlideImageAreaInterface
Tags
Return values
SlideImageInterface —Same instance for chained method calls.
getBreakpoint()
Return the breakpoint of the slide image.
public
getBreakpoint() : string
Return values
string —Breakpoint of the slide image.
getId()
Return the ID of the slide image.
public
getId() : int
Return values
int —Slide image ID.
getImage()
Return the image of the image slider.
public
getImage() : string
Return values
string —Image of the image slider.
getLanguageId()
Return the language ID of the slide image.
public
getLanguageId() : int
Return values
int —Slide image language ID.
getSlideImageAreaCollection()
Return the slide image area collection of the slide image.
public
getSlideImageAreaCollection() : SlideImageAreaCollection
Return values
SlideImageAreaCollection —Slide image area collection.
setBreakpoint()
Set the breakpoint for the slide image.
public
setBreakpoint(NonEmptyStringType $breakpoint) : SlideImageInterface
Parameters
- $breakpoint : NonEmptyStringType
Return values
SlideImageInterface —Same instance for chained method calls.
setId()
Set the slide image ID.
public
setId(IdType $id) : SlideImageInterface
Parameters
- $id : IdType
-
Slide image ID.
Return values
SlideImageInterface —Same instance for chained method calls.
setImage()
Set the image for the image slider.
public
setImage(StringType $image) : SlideImageInterface
Parameters
- $image : StringType
-
The image to set.
Return values
SlideImageInterface —Same instance for chained method calls.
setLanguageId()
Set the language ID for the slide image.
public
setLanguageId(IdType $languageId) : SlideImageInterface
Parameters
- $languageId : IdType
-
Language ID.
Return values
SlideImageInterface —Same instance for chained method calls.
setSlideImageAreaCollection()
Set the slide image area collection for the slide image.
public
setSlideImageAreaCollection(SlideImageAreaCollection $slideImageAreaCollection) : SlideImageInterface
Parameters
- $slideImageAreaCollection : SlideImageAreaCollection
Return values
SlideImageInterface —Same instance for chained method calls.