xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • A
  • COL
  • COLGROUP
  • DIV
  • FIELDSET
  • FORM
  • IMG
  • INPUT
  • LABEL
  • LEGEND
  • LI
  • OL
  • OPTGROUP
  • P
  • SCRIPT
  • SELECT
  • TABLE
  • TBODY
  • TD
  • TEXTAREA
  • TFOOT
  • TH
  • THEAD
  • TR
  • UL

Class OPTGROUP

Option group tag.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Set\Mutable implements Core\Mutator
Extended by Core\View\Driver\htmlbuilder\Node
Extended by Core\View\Driver\htmlbuilder\Tags\OPTGROUP
Namespace: Core\View\Driver\htmlbuilder\Tags
Package: Core\View\HTMLBuilder\Tags
Since: 3.0
Requires: PHP 5.3
Version: 1.1
Located at View/Driver/htmlbuilder/Tags/OPTGROUP.inc.php

Methods summary

protected
# __construct( Core\View\Driver\htmlbuilder $proxy, string $type, string $subType, array $classNames, string $id, array $extraArguments = null )

Node constructor.

Node constructor.

Supported extra arguments:

  1. Option group label, stored as label attribute.

  2. Initial value for entry auto-selection. This is automatically provided by the SELECT tag node, if the option group is created via the SELECT::appendGroup() method.

Parameters

$proxy
HTML Builder proxy instance that created this node.
$type
HTML tag name of element.
$subType
Specification of HTML tag, i.e. the type of an input.
$classNames
Array of class names to assign to the node.
$id
Unique ID of node.
$extraArguments
Array of additional arguments passed on from the factory method.

Since

3.0

Overrides

Core\View\Driver\htmlbuilder\Node::__construct
public
# add( string $value, string $displayValue = null, boolean $isSelected = null )

Appends a new option node to the list of child nodes.

Appends a new option node to the list of child nodes.

Parameters

$value

Internal value of the new option. If the value matches the value of the option group (cf. $value property), the option is marked as selected. The value is automatically encoded.

$displayValue

The value of the option box that is shown to the user. Defaults to the internal value if null. The display value is automatically encoded.

$isSelected

If set, selection detection is based on this value, otherwise it is automatically detected based on the value of the new option.

Returns


$this

Since

3.0
public
# addSet( array $set )

Adds a set of new options at once.

Adds a set of new options at once.

Parameters

$set

Associative key-value array of new option values and display values, respectively, to add.

Returns


$this

Since

3.0
public
# setLabel( string $value )

Sets a new label for the option group. Stored as label attribute.

Sets a new label for the option group. Stored as label attribute.

Parameters

$value
New label to set.

Returns


$this

Since

3.0

Methods inherited from Core\View\Driver\htmlbuilder\Node

__clone(), __toString(), _parseClasses(), addClass(), append(), cdata(), derive(), extend(), id(), issetStyle(), js(), jsCDATA(), safeID(), setAllowsShortTag(), setAttribute(), setAttributes(), setId(), setStyle(), setTitle(), text(), verbatim()

Methods inherited from Core\Set\Mutable

__set(), __unset()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\View\Driver\htmlbuilder\Node

AllowsInnerNL, AllowsOuterNL, AllowsShortTag

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected mixed $_v_value

Pre-selected value for setting the selected attribute for an option node with matching value.

Pre-selected value for setting the selected attribute for an option node with matching value.

Since

3.0
#

Properties inherited from Core\View\Driver\htmlbuilder\Node

$_id, $_safeID, $_v_attributeClass, $_v_attributes, $_v_children, $_v_classes, $_v_proxy, $_v_styles, $_v_type

Magic properties

public read-only mixed $value

Initial value for entry auto-selection.

Magic properties inherited from Core\View\Driver\htmlbuilder\Node

$attributeClass, $attributes, $classes, $id, $proxy, $safeID, $styles, $type

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen