PHP Class Ansel_View_Image, horde

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Author: Chuck Hagenbuch ([email protected])

Author: Michael J Rubinsky ([email protected])

Inheritance: extends Ansel_View_Ansel

Show file Open project: horde/horde

Protected Properties

Property	Type	Description
$_date	array	The image's date for use in date browsing.
$_geometry	array	The image geometry.
$_imageList	array	List of image ids in the parent gallery. Used for next/prev fetching.
$_mode	string	The gallery mode for this images's current gallery view.
$_page	integer	The page this image appears on in the current gallery view, if available.
$_revList	array	Cache {@link self::_imageList} in reverse.
$_slug	string	The parent gallery's slug name, if available.
$_style	Ansel_Style	The parent gallery's current style.
$_urls	array	An array of various URLs that are displayed in the view.

Public Methods

Method	Description
__construct ( array $params = [] )	Const'r
getGalleryCrumbData ( ) : array	Return the gallery's breadcrumb data.
getTitle ( ) : string	Get the title for this view.
html ( ) : string	Get the HTML representing this view.
viewType ( )

Protected Methods

Method	Description
_getCommentData ( ) : boolean \| array	Helper for comments
_getView ( ) : Horde_View	Generate the Horde_View and populate with basic/common properties.
_html ( )	Image view specific HTML - done so we can extend View_Image for things like the slideshow view etc.
_includeViewSpecificScripts ( )
_prepare ( )	Build variables needed to output the html. Extracted to this method so child classes can use this as well.

Method Details

__construct() public method

Const'r

public __construct ( array $params = [] )
$params	array

_getCommentData() protected method

Helper for comments

protected _getCommentData ( ) : boolean \| array
return	boolean \| array	Either an array of comment data or false on failure

_getView() protected method

Generate the Horde_View and populate with basic/common properties.

protected _getView ( ) : Horde_View
return	Horde_View

_html() protected method

protected _html ( )

_includeViewSpecificScripts() protected method

protected _includeViewSpecificScripts ( )

_prepare() protected method

Build variables needed to output the html. Extracted to this method so child classes can use this as well.

protected _prepare ( )

getGalleryCrumbData() public method

Return the gallery's breadcrumb data.

public getGalleryCrumbData ( ) : array
return	array

getTitle() public method

Get the title for this view.

public getTitle ( ) : string
return	string	The title.

html() public method

Get the HTML representing this view.

public html ( ) : string
return	string	The HTML.

viewType() public method

public viewType ( )

Property Details

$_date protected property

The image's date for use in date browsing.

protected array $_date
return	array

$_geometry protected property

The image geometry.

protected array $_geometry
return	array

$_imageList protected property

List of image ids in the parent gallery. Used for next/prev fetching.

protected array $_imageList
return	array

$_mode protected property

The gallery mode for this images's current gallery view.

protected string $_mode
return	string

$_page protected property

The page this image appears on in the current gallery view, if available.

protected int $_page
return	integer

$_revList protected property

Cache {@link self::_imageList} in reverse.

protected array $_revList
return	array

$_slug protected property

The parent gallery's slug name, if available.

protected string $_slug
return	string

$_style protected property

The parent gallery's current style.

protected Ansel_Style $_style
return	Ansel_Style

$_urls protected property

An array of various URLs that are displayed in the view.

protected array $_urls
return	array