oxSelection Class Reference

Public Member Functions
	__construct ($sName, $sValue, $blDisabled, $blActive)
	getValue ()
	getName ()
	isActive ()
	isDisabled ()
	setActiveState ($blActive)
	setDisabled ($blDisabled)
	getLink ()

Protected Attributes
	$_sName = null
	$_sValue = null
	$_blActive = null
	$_blDisabled = null

Detailed Description

Variant selection container class

Definition at line 7 of file oxselection.php.

Constructor & Destructor Documentation

oxSelection::__construct	(		$sName,
			$sValue,
			$blDisabled,
			$blActive
	)

Initializes oxSelection object

Parameters

string	$sName	selection name
string	$sValue	selection value
string	$blDisabled	selection state - disabled/enabled
string	$blActive	selection state - active/inactive

Returns

null

Definition at line 48 of file oxselection.php.

Member Function Documentation

oxSelection::getLink

(

)

Returns selection link (currently returns "#")

Returns

string

Definition at line 121 of file oxselection.php.

oxSelection::getName

(

)

Returns selection name

Returns

string

Definition at line 71 of file oxselection.php.

oxSelection::getValue

(

)

Returns selection value

Returns

string

Definition at line 61 of file oxselection.php.

oxSelection::isActive

(

)

Returns TRUE if current selection is active (chosen)

Returns

bool

Definition at line 81 of file oxselection.php.

oxSelection::isDisabled

(

)

Returns TRUE if current selection is disabled

Returns

bool

Definition at line 91 of file oxselection.php.

oxSelection::setActiveState

(

$blActive

)

Sets selection active/inactive

Parameters

bool

$blActive

selection state TRUE/FALSE

Definition at line 101 of file oxselection.php.

oxSelection::setDisabled

(

$blDisabled

)

Sets selection disabled/enables

Parameters

bool

$blDisabled

selection state TRUE/FALSE

Definition at line 111 of file oxselection.php.

Member Data Documentation

oxSelection::$_blActive = null

protected

Definition at line 29 of file oxselection.php.

oxSelection::$_blDisabled = null

protected

Definition at line 36 of file oxselection.php.

oxSelection::$_sName = null

protected

Definition at line 15 of file oxselection.php.

oxSelection::$_sValue = null

protected

Definition at line 22 of file oxselection.php.

---

The documentation for this class was generated from the following file:

• application/models/oxselection.php