Skip to content
Sitemason - Build on Us

SMImageSize Class Reference

Methods

getAlt

(string) getAlt()
A string
6.0

Information

Returns the alt property of the Image Size's parent.  This method is present simply for convenience, since the user could alternately use a combination of the getImage() method and then a corresponding getAlt() method on that resulting SMImage.

getCaption

(string) getCaption ()
A string
6.0

Information

Returns the caption property of the Image Size's parent.  This method is present simply for convenience, since the user could alternately use a combination of the getImage() method and then a corresponding getCaption() method on that resulting SMImage.

getCopyright

(string) getCopyright ()
The Image's copyright property
6.0

Information

Returns the copyright property of the ImageSize's Image.  This method is present simply for convenience, since the user could alternately use a combination of the getImage() method and then a corresponding getCaption() method on that resulting SMImage.

getFileSize

(int) getFileSize()
An integer
6.0

Information

Returns the size (file size) in bytes for the given Image Size.

getHeight

(int) getHeight()
An integer
6.0

Information

Returns the height of the Image Size in pixels.

getImage

(SMImage) getImage()
An SMImage object
6.0

Information

Returns the parent SMImage object for the Image Size.

getLabel

(string) getLabel()
A string
6.0

Information

Returns the label property of the Image Size.  Currently, Sitemason only supports two Image Sizes with the following labels: "main" and "thumbnail."  The sizes of each of these Image Sizes are set in the Sitemason CMS interface.  In the future, other custom Image Sizes (with custom labels) will be supported.

getTitle

(string) getTitle()
A string
6.0

Information

Returns the title property of the Image Size's parent.  This method is present simply for convenience, since the user could alternately use a combination of the getImage() method and then a corresponding getTitle() method on that resulting SMImage.

getURL

(string) getURL()
A string
6.0

Information

Returns the URL for the Image Size.

getWidth

(int) getWidth()
An integer
6.0

Information

Returns the width of the Image Size in pixels.