ImageGalleryWidget class - Documentation for SproutCMS

Info Page:

Page options:

class ImageGalleryWidget

Shows a list of pages that are related to this one

File: /sprout/Widgets/ImageGalleryWidget.php
Namespace: Sprout\Widgets
Extends: Widget

Variables

Name	Visibility	Description
`$classname`
`$crop_opts`
`$default_settings`
`$display_opts`
`$friendly_desc`
`$friendly_name`
`$order_opts`

Functions

Name	Visibility	Description
contentReplace	public (static)	Registered content replacement for embedded gallery via the editor
getEditUrl	public	Returns a URL for editing the contents of this widget
getInfoLabels	public	Returns a label which describes the contents of this widget
getNotAvailableReason	public	Is there sufficent content to add this addon at the moment?
getSettingsForm	public	Returns the settings HTML
orderSql	private	Returns the SQL which should be used for ordering the images
render	public	Does the front-end rendering of this widget
validateSettings	private	Validate and cleanup the settings fields

public contentReplace

string ImageGalleryWidget::contentReplace ( string $html );

Registered content replacement for embedded gallery via the editor

public getEditUrl

unknown $ImageGalleryWidget->getEditUrl ( );

Returns a URL for editing the contents of this widget
See Widget::getEditUrl for full documentation

public getInfoLabels

unknown $ImageGalleryWidget->getInfoLabels ( );

Returns a label which describes the contents of this widget
See Widget::get_info_label for full documentation

public getNotAvailableReason

unknown $ImageGalleryWidget->getNotAvailableReason ( );

Is there sufficent content to add this addon at the moment?
If this widget is not available, a string message should be returned
If this widget *is* available, NULL should be returned.

public getSettingsForm

unknown $ImageGalleryWidget->getSettingsForm ( );

Returns the settings HTML

private orderSql

unknown $ImageGalleryWidget->orderSql ( One $order );

Returns the SQL which should be used for ordering the images

public render

unknown $ImageGalleryWidget->render ( int $orientation );

Does the front-end rendering of this widget

private validateSettings

unknown $ImageGalleryWidget->validateSettings ( );

Validate and cleanup the settings fields

SproutCMS

Search documentation