Class Ansel_Widget

Description

Ansel_Widget:: class wraps the display of widgets to be displayed in various Ansel_Views.

$Horde: ansel/lib/Widget.php,v 1.7.2.3 2009/06/19 22:45:19 mrubinsk Exp $

Copyright 2008-2009 The Horde Project (http://www.horde.org/)

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

Located in /lib/Widget.php (line 16)


	
			
Direct descendents
Class Description
 class Ansel_Widget_Actions Ansel_Widget_Actions:: class to wrap the display of gallery actions
 class Ansel_Widget_GalleryFaces Horde_Widget_GalleryFaces:: class to display a widget containing mini thumbnails of faces in the gallery.
 class Ansel_Widget_Geodata Ansel_Widget_Geodata:: class to wrap the display of a Google map showing images with geolocation data.
 class Ansel_Widget_ImageFaces Horde_Widget_ImageFaces:: class to display a widget containing mini thumbnails of faces in the image.
 class Ansel_Widget_Links Ansel_Widget_links:: class to wrap the display of various feed links etc...
 class Ansel_Widget_OtherGalleries Ansel_Widget_OtherGalleries:: class to display a widget containing mini thumbnails and links to other galleries owned by the same user as the currently viewed image/gallery.
 class Ansel_Widget_OwnerFaces Ansel_Widget_OwnerFaces:: class to display a widget containing mini thumbnails of faces that have been tagged by the gallery owner.
 class Ansel_Widget_SimilarPhotos Horde_Widget_SimilarPhotos:: class to display a widget containing mini thumbnails of images that are similar, based on tags.
 class Ansel_Widget_Tags Ansel_Widget_Tags:: class to display a tags widget in the image and gallery views.
Variable Summary
 array $_params
 string $_render
 array $_style
 string $_title
 Ansel_View $_view
Method Summary
 Ansel_Widget Ansel_Widget (array $params)
 void attach (Ansel_View $view)
 mixed factory (string $type, [array $params = array()])
 void html ()
 boolean isSupported (string $view)
 string _htmlBegin ()
 string _htmlEnd ()
Variables
array $_params = array() (line 23)

Any parameters this widget will need..


Redefined in descendants as:
string $_render = 'auto' (line 53)

Determine if this widget will be automatically rendered, or if it is the calling code's responsibility to render it.

array $_style (line 38)

Holds the style definition for the gallery this view is for (or the image's parent gallery if this is for an image view).

string $_title (line 45)

Title for this widget.

Ansel_View $_view (line 30)

Reference to the Ansel_View we are attaching to

Methods
Constructor Ansel_Widget (line 84)

Constructor

Ansel_Widget Ansel_Widget (array $params)
  • array $params
attach (line 98)

Attach this widget to the passed in view. Normally called by the Ansel_View once this widget is added.

void attach (Ansel_View $view)
  • Ansel_View $view: The view to attach to

Redefined in descendants as:
factory (line 63)

Factory method for creating Ansel_Widgets

  • return: Ansel_Widget object | PEAR_Error
mixed factory (string $type, [array $params = array()])
  • string $type: The type of widget to create.
  • array $params: Any parameters the widget needs.
html (line 116)

Get the HTML for this widget

  • abstract:
void html ()

Redefined in descendants as:
isSupported (line 152)

Determine if a particular view (Image, Gallery etc..) is supported by this widget.

  • TODO:
boolean isSupported (string $view)
  • string $view: The view to check
_htmlBegin (line 125)

Default HTML for the beginning of the widget.

string _htmlBegin ()
_htmlEnd (line 137)

Default HTML for the end of the widget.

string _htmlEnd ()

Documentation generated on Sun, 30 Jan 2011 05:08:50 +0000 by phpDocumentor 1.4.3