FileListWidget class - Documentation for SproutCMS

Info Page:

Page options:

class FileListWidget

doc list widget

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

Variables

Name	Visibility	Description
`$default_settings`
`$friendly_desc`
`$friendly_name`
`$heading`		Optional HTML H2 heading that's rendered on front-end view
`$settings`		Settings - These get automatically set in the admin and loaded on the front-end

Functions

Name	Visibility	Description
cleanupSettings	public	Run after import of settings, allows extending widgets to clean up settings which may
getDefaultSettings	public	Returns the default settings for the widget
getEditUrl	public	Returns a URL for editing the contents of this widget
getFriendlyDesc	public	Gets the english name of this widget
getFriendlyName	public	Gets the english name 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?
getOrderSql	private	Returns the SQL which should be used for ordering the articles
getSettings	public	Return the currently loaded settings for the widget
getSettingsForm	public	Returns the settings for the doc list widget
getTitle	public	Returns the title to use for the widget - should not contain HTML
importSettings	public	Imports the settings
render	public	Returns the output of the doc list widget
setTitle	public	Set widget title

public cleanupSettings (from Widget)

void $Widget->cleanupSettings ( );

Run after import of settings, allows extending widgets to clean up settings which may
have bad values for some reason

public getDefaultSettings (from Widget)

unknown $Widget->getDefaultSettings ( );

Returns the default settings for the widget

public getEditUrl

unknown $FileListWidget->getEditUrl ( );

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

public getFriendlyDesc (from Widget)

unknown $Widget->getFriendlyDesc ( );

Gets the english name of this widget

public getFriendlyName (from Widget)

unknown $Widget->getFriendlyName ( );

Gets the english name of this widget

public getInfoLabels

unknown $FileListWidget->getInfoLabels ( );

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

public getNotAvailableReason (from Widget)

unknown $Widget->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.

private getOrderSql

unknown $FileListWidget->getOrderSql ( );

Returns the SQL which should be used for ordering the articles

public getSettings (from Widget)

array $Widget->getSettings ( );

Return the currently loaded settings for the widget

public getSettingsForm

unknown $FileListWidget->getSettingsForm ( );

Returns the settings for the doc list widget
See Widget::getSettingsForm for full documentation

public getTitle (from Widget)

unknown $Widget->getTitle ( );

Returns the title to use for the widget - should not contain HTML

public importSettings (from Widget)

void $Widget->importSettings ( array $settings );

Imports the settings

public render

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

Returns the output of the doc list widget
See Widget::render for full documentation

public setTitle (from Widget)

void $Widget->setTitle ( string $str );

Set widget title

SproutCMS

Search documentation