Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zend.form.element.monthselect.html

Size:13878
Storage flags:no_autoload,compress/gzip (25%)

Month Select — Zend Framework 2 2.4.2 documentation

Month SelectΒΆ

Zend\Form\Element\MonthSelect is meant to be paired with the Zend\Form\View\Helper\FormMonthSelect. This element creates two select elements, where the first one is populated with months and the second is populated with years. By default, it sets 100 years in the past for the year element, starting with the current year.

Basic Usage

1
2
3
4
5
6
7
8
9
use Zend\Form\Element;
use Zend\Form\Form;

$monthYear = new Element\MonthSelect('monthyear');
$monthYear->setLabel('Select a month and a year');
$monthYear->setMinYear(1986);

$form = new Form('dateselect');
$form->add($monthYear);

Using the array notation:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
use Zend\Form\Form;

$form = new Form('dateselect');
$form->add(array(
    'type' => 'Zend\Form\Element\MonthSelect',
    'name' => 'monthyear',
    'options' => array(
        'label' => 'Select a month and a year',
        'min_year' => 1986,
    )
));

Public Methods

The following methods are in addition to the inherited methods of Zend\Form\Element.

getMonthElement()

Returns the Select element that is used for the months part.

Return type:Zend\Form\Element\Select
getYearElement()

Returns the Select element that is used for the years part.

Return type:Zend\Form\Element\Select
setMonthAttributes(array $monthAttributes)

Set attributes on the Select element that is used for the months part.

getMonthAttributes()

Get attributes on the Select element that is used for the months part.

Return type:array
setYearAttributes(array $yearAttributes)

Set attributes on the Select element that is used for the years part.

getYearAttributes()

Get attributes on the Select element that is used for the years part.

Return type:array
setMinYear(int $minYear)

Set the minimum year.

getMinYear()

Get the minimum year.

setMaxYear(int $maxYear)

Set the maximum year.

getMaxYear()

Get the maximum year.

setValue(mixed $value)

Set the value for the MonthSelect element.

If the value is an instance of \DateTime, it will use the month and year values from that date. Otherwise, the value should be an associative array with the month key for the month value, and with the year key for the year value.

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Login with your GitHub account.
  2. Go to Month Select on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.

For more information about the PHK package format: http://phk.tekwire.net