SilverWare\Gallery\Pages\GalleryImage
An extension of the page class for a gallery image.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class GalleryImage
extends Page
{
- // members
- private static string $singular_name = 'Gallery Image';
- private static string $plural_name = 'Gallery Images';
- private static string $description = 'An individual image within a gallery album';
- private static string $icon = 'silverware/gallery: admin/client/dist/images/icons/GalleryImage.png';
- private static string $table_name = 'SilverWare_GalleryImage';
- private static boolean $can_be_root = false;
- private static array|string $allowed_children = 'none';
- private static array $defaults = ;
- private static array $casting = ;
- private static array $extensions = ;
- private static array $meta_fields = ;
- private static array $detail_fields = ;
- private static string $meta_date_format = 'd MMMM Y';
- private static boolean $detail_fields_inline = true;
- private static boolean $detail_fields_hide_header = true;
- private static boolean $detail_fields_hide_names = true;
- // methods
- public FieldList getCMSFields()
- public string getMetaImageFolder()
- public DBHTMLText getMetaSummary()
- public GalleryAlbum getAlbum()
- public string getAlbumLink()
- public string getPrevLink()
- public string getNextLink()
- public string getPrevText()
- public string getNextText()
- public boolean getDateShown()
- public boolean getFooterShown()
Hierarchy
Extends
- Page
Members
private
- $allowed_children
—
SilverWare\Gallery\Pages\array|string
Defines the allowed children for this object. - $can_be_root
—
boolean
Determines whether this object can exist at the root level. - $casting
—
array
Maps field and method names to the class names of casting objects. - $defaults
—
array
Defines the default values for the fields of this object. - $description
—
string
Description of this object. - $detail_fields
—
array
Defines the detail fields to show for the object. - $detail_fields_hide_header
—
boolean
Defines the setting for hiding the detail fields header. - $detail_fields_hide_names
—
boolean
Defines the setting for hiding the detail field names. - $detail_fields_inline
—
boolean
Defines the setting for showing the detail fields inline. - $extensions
—
array
Defines the extension classes to apply to this object. - $icon
—
string
Icon file for this object. - $meta_date_format
—
string
Defines the format for the meta date field. - $meta_fields
—
array
Defines the meta field configuration for this object. - $plural_name
—
string
Human-readable plural name. - $singular_name
—
string
Human-readable singular name. - $table_name
—
string
Defines the table name to use for this object.
Methods
public
- getAlbum() — Answers the parent album of the receiver.
- getAlbumLink() — Answers a string of HTML containing a link to the parent album.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getDateShown() — Answers true if the date is to be shown.
- getMetaImageFolder() — Answers the name of the asset folder used for uploading images.
- getMetaSummary() — Answers the summary for the object.
- getNextLink() — Answers a link for the next image in the album.
- getNextText() — Answers the text for the next image button.
- getPrevLink() — Answers a link for the previous image in the album.
- getPrevText() — Answers the text for the previous image button.