Slide
in package
implements
SlideInterface
Class Slide
Represents the default settings of a single slide in a slider. Has got the slider image settings as collection for every image of a slide.
Tags
Interfaces, Classes and Traits
- SlideInterface
- Interface SlideInterface
Table of Contents
- $altText : string
- Image alt text
- $id : int
- Slide ID
- $languageId : int
- Language ID
- $slideImageCollection : SlideImageCollection
- Collection of Slide Images
- $sortOrder : int
- Sort order
- $thumbnail : string
- Thumbnail
- $title : string
- Title
- $url : string
- Link url
- $urlTarget : string
- Link target (e.g. _blank or _self)
- __construct() : mixed
- addSlideImage() : SlideInterface
- Adds a slide image to the slide image collection
- getAltText() : string
- Return the alt text of the slide.
- getId() : int
- Return the slide ID.
- getLanguageId() : int
- Return the language ID.
- getSlideImageCollection() : SlideImageCollection
- Return the slide image collection of the slide.
- getSortOrder() : int
- Return the slide sort order.
- getThumbnail() : string
- Return the thumbnail of the slide.
- getTitle() : string
- Return the title of the slide.
- getUrl() : string
- Return the URL of the slide.
- getUrlTarget() : string
- Return the url target property.
- setAltText() : SlideInterface
- Set the alt text for the slide.
- setId() : SlideInterface
- Set the slide ID for the slide.
- setLanguageId() : SlideInterface
- Set the language ID for the slide.
- setSlideImageCollection() : SlideInterface
- Set the slide image collection for the slide.
- setSortOrder() : SlideInterface
- Set the sort order for the slide.
- setThumbnail() : SlideInterface
- Set the thumbnail for the slide.
- setTitle() : SlideInterface
- Set the title for the slide.
- setUrl() : SlideInterface
- Set the URL for the slide.
- setUrlTarget() : SlideInterface
- Set the url target property for the slide.
Properties
$altText
Image alt text
protected
string
$altText
= ''
$id
Slide ID
protected
int
$id
= 0
$languageId
Language ID
protected
int
$languageId
= 0
$slideImageCollection
Collection of Slide Images
protected
SlideImageCollection
$slideImageCollection
$sortOrder
Sort order
protected
int
$sortOrder
= 0
$thumbnail
Thumbnail
protected
string
$thumbnail
= ''
$title
Title
protected
string
$title
= ''
$url
Link url
protected
string
$url
= ''
$urlTarget
Link target (e.g. _blank or _self)
protected
string
$urlTarget
= ''
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addSlideImage()
Adds a slide image to the slide image collection
public
addSlideImage(SlideImageInterface $slideImage) : SlideInterface
Parameters
- $slideImage : SlideImageInterface
Tags
Return values
SlideInterface —Same instance for chained method calls.
getAltText()
Return the alt text of the slide.
public
getAltText() : string
Return values
string —Alt text of the slide.
getId()
Return the slide ID.
public
getId() : int
Return values
int —Slide ID.
getLanguageId()
Return the language ID.
public
getLanguageId() : int
Return values
int —Language ID.
getSlideImageCollection()
Return the slide image collection of the slide.
public
getSlideImageCollection() : SlideImageCollection
Return values
SlideImageCollection —Slide image collection.
getSortOrder()
Return the slide sort order.
public
getSortOrder() : int
Return values
int —sort order.
getThumbnail()
Return the thumbnail of the slide.
public
getThumbnail() : string
Return values
string —Thumbnail.
getTitle()
Return the title of the slide.
public
getTitle() : string
Return values
string —Title.
getUrl()
Return the URL of the slide.
public
getUrl() : string
Return values
string —URL.
getUrlTarget()
Return the url target property.
public
getUrlTarget() : string
Return values
string —URL target e.g. '_blank'.
setAltText()
Set the alt text for the slide.
public
setAltText(StringType $altText) : SlideInterface
Parameters
- $altText : StringType
-
.
Return values
SlideInterface —Same instance for chained method calls.
setId()
Set the slide ID for the slide.
public
setId(IdType $id) : SlideInterface
Parameters
- $id : IdType
-
Slide ID.
Return values
SlideInterface —Same instance for chained method calls.
setLanguageId()
Set the language ID for the slide.
public
setLanguageId(IdType $languageId) : SlideInterface
Parameters
- $languageId : IdType
-
Language ID.
Return values
SlideInterface —Same instance for chained method calls.
setSlideImageCollection()
Set the slide image collection for the slide.
public
setSlideImageCollection(SlideImageCollection $slideImageCollection) : SlideInterface
Parameters
- $slideImageCollection : SlideImageCollection
Return values
SlideInterface —Same instance for chained method calls.
setSortOrder()
Set the sort order for the slide.
public
setSortOrder(IntType $sortOrder) : SlideInterface
Parameters
- $sortOrder : IntType
-
Slide sort order.
Return values
SlideInterface —Same instance for chained method calls.
setThumbnail()
Set the thumbnail for the slide.
public
setThumbnail(StringType $thumbnail) : SlideInterface
Parameters
- $thumbnail : StringType
-
Thumbnail to set.
Return values
SlideInterface —Same instance for chained method calls.
setTitle()
Set the title for the slide.
public
setTitle(StringType $title) : SlideInterface
Parameters
- $title : StringType
-
Title for the slide.
Return values
SlideInterface —Same instance for chained method calls.
setUrl()
Set the URL for the slide.
public
setUrl(StringType $url) : SlideInterface
Parameters
- $url : StringType
-
URL.
Return values
SlideInterface —Same instance for chained method calls.
setUrlTarget()
Set the url target property for the slide.
public
setUrlTarget(StringType $urlTarget) : SlideInterface
Parameters
- $urlTarget : StringType
-
URL target e.g. '_blank'.
Return values
SlideInterface —Same instance for chained method calls.