This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Controller_Block_Slideshow

Displays a slideshow of images on a page.

Concrete5_Library_Controller
Extended by Controller
Extended by Concrete5_Library_BlockController
Extended by BlockController
Extended by Concrete5_Controller_Block_Slideshow

Direct known subclasses

SlideshowBlockController

Package: Blocks\Slideshow
Copyright: Copyright (c) 2003-2012 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Ryan Tyler ryan@concrete5.org
Author: Andrew Embler andrew@concrete5.org
Author: Tony Trupp tony@concrete5.org
Located at core/controllers/blocks/slideshow.php

Methods summary

public string
# getBlockTypeDescription( )

Used for localization. If we want to localize the name/description we have to include this

public string
# getBlockTypeName( )

Returns the name of the block type

public
# getJavaScriptStrings( )

Returns a key/value array of strings that is used to translate items when used in javascript

public
public
public
public
# delete( )

Automatically run when a block is deleted. This removes the special data from the block's specific database table. If a block needs to do more than this this method should be overridden.

public
public
# view( )
public
# add( )
public
# edit( )
public BlockRecord
# duplicate( integer $nbID )

Automatically run when a block is duplicated. This most likely happens when a block is edited: a block is first duplicated, and then presented to the user to make changes.

public
# save( array $data )

Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc... it should override this.

public
protected

Properties summary

protected string $btTable
# 'btSlideshow'
protected string $btInterfaceWidth
# "550"
protected string $btInterfaceHeight
# "400"
protected boolean $btCacheBlockRecord
# true
protected boolean $btCacheBlockOutput
# true
protected boolean $btCacheBlockOutputOnPost
# true
protected boolean $btCacheBlockOutputForRegisteredUsers
# true
protected array $btExportFileColumns
# array('fID')
protected array $btExportTables
# array('btSlideshow','btSlideshowImg')
public integer $defaultDuration
# 5
public integer $defaultFadeDuration
# 2
public string $playback
# "ORDER"