Class: Formagic_Item_ImageSubmit

Source Location: /Item/ImageSubmit.php

Class Overview

Formagic_Item_Abstract
   |
   --Formagic_Item_Submit
      |
      --Formagic_Item_ImageSubmit

Formagic image submit button item

Author(s):

Florian Sonnenburg

Version:

$Id: ImageSubmit.php 126 2011-05-18 18:41:58Z meweasle $

Copyright:

Variables

Methods

Inherited Variables

Class: Formagic_Item_Abstract

Formagic_Item_Abstract::$_attributes
Formagic_Item_Abstract::$_filteredValue
Formagic_Item_Abstract::$_filters
Formagic_Item_Abstract::$_isDisabled
Formagic_Item_Abstract::$_isFixed
Formagic_Item_Abstract::$_isHidden
Formagic_Item_Abstract::$_isIgnored
Formagic_Item_Abstract::$_isReadonly
Formagic_Item_Abstract::$_label
Formagic_Item_Abstract::$_name
Formagic_Item_Abstract::$_requiredAttributes
Formagic_Item_Abstract::$_rules
Formagic_Item_Abstract::$_value
Formagic_Item_Abstract::$_violatedRules

Inherited Methods

Class: Formagic_Item_Submit

Formagic_Item_Submit::getHtml(): HTML string representation of submit button
Formagic_Item_Submit::getLabel(): Label is already defined by value property
Formagic_Item_Submit::isTriggered(): Returns true if submit button was triggered to access current page
Formagic_Item_Submit::_init(): Subclass initialization

Class: Formagic_Item_Abstract

Formagic_Item_Abstract::__construct(): Constructor
Formagic_Item_Abstract::addAttribute(): Adds an HTML attribute to the attributes stack.
Formagic_Item_Abstract::addFilter(): Adds filter object to Formagic item
Formagic_Item_Abstract::addRule(): Adds rule object to Formagic item
Formagic_Item_Abstract::getAttribute(): Returns the attributes array for this item.
Formagic_Item_Abstract::getAttributes(): Returns the attributes array for this item.
Formagic_Item_Abstract::getAttributeStr(): Returns attribute string for HTML tag.
Formagic_Item_Abstract::getHtml(): HTML template for renderers that use HTML-Code.
Formagic_Item_Abstract::getLabel(): Returns label for this item.
Formagic_Item_Abstract::getName(): Returns the item name.
Formagic_Item_Abstract::getUnfilteredValue(): Returns current unfiltered value for this item.
Formagic_Item_Abstract::getValue(): Returns the current filtered value for this item.
Formagic_Item_Abstract::getViolatedRules(): Returns array of violated rules.
Formagic_Item_Abstract::hasFilter()
Formagic_Item_Abstract::hasRule(): Tells if a rule exists for this item.
Formagic_Item_Abstract::isDisabled(): Returns disabled status of item
Formagic_Item_Abstract::isHidden(): Returns hidden status of item
Formagic_Item_Abstract::isIgnored(): Returns ignore status of item
Formagic_Item_Abstract::printInfo(): Prints item infos.
Formagic_Item_Abstract::setAttributes(): Sets additional attributes for this item.
Formagic_Item_Abstract::setDisabled(): Sets disabled flag for item and removes it from form
Formagic_Item_Abstract::setFixed(): Sets isFixed flag.
Formagic_Item_Abstract::setHidden(): Sets hidden flag for item.
Formagic_Item_Abstract::setIgnore(): Defines if the item will be ignored in form submit.
Formagic_Item_Abstract::setReadonly(): Sets readonly flag
Formagic_Item_Abstract::setRequiredAttributes()
Formagic_Item_Abstract::setValue(): Sets the item value to $value.
Formagic_Item_Abstract::validate(): Performs rule checks
Formagic_Item_Abstract::_buildAttributeStr()
Formagic_Item_Abstract::_filterValue()
Formagic_Item_Abstract::_init(): Allow subclass initialization.
Formagic_Item_Abstract::_makeDomId(): Takes a string and returns a valid DOM ID.
Formagic_Item_Abstract::_validateItemValue(): Perform validation on item value.
Formagic_Item_Abstract::__toString(): Returns the HTML string representation of the form item.

Class Details

[line 36]
Formagic image submit button item

Tags:

author:	Florian Sonnenburg
version:	$Id: ImageSubmit.php 126 2011-05-18 18:41:58Z meweasle $
copyright:	Copyright (c) 2007-2009 Florian Sonnenburg

[ Top ]

Class Variables

$_clickCoordinates = array()

[line 48]

Click coordiantes if triggered

Tags:

access:

private

Type:

array

[ Top ]

$_src = ''

[line 42]

Image source

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

method getClickCoordinates [line 109]

array getClickCoordinates(
)

Returns click coordinates if triggered.

Tags:

access:

public

[ Top ]

method getHtml [line 80]

string getHtml(
)

HTML string representation of submit button

Tags:

access:

public

Overrides Formagic_Item_Submit::getHtml() (HTML string representation of submit button)

[ Top ]

method getLabel [line 119]

string getLabel(
)

Returns label for this item.

Tags:

return:	The label string.
access:	public

Overrides Formagic_Item_Submit::getLabel() (Label is already defined by value property)

[ Top ]

method setClickCoordinates [line 98]

Formagic_Item_ImageSubmit setClickCoordinates(

$coordinates)

Sets click coordinates.

Tags:

return:	Fluent interface
access:	public

Parameters:

array

$coordinates

[ Top ]

method setSource [line 69]

Formagic_Item_ImageSubmit setSource(

$source)

Set image source.

Tags:

return:	object
access:	public

Parameters:

$source

[ Top ]

method _init [line 55]

void _init(

$additionalArgs)

Subclass initialization.

Tags:

access:

protected

Overrides Formagic_Item_Submit::_init() (Subclass initialization)

Parameters:

$additionalArgs

[ Top ]

Documentation generated on Sun, 22 May 2011 22:40:14 +0200 by phpDocumentor 1.4.3