cakephp-2.0 > FormHelper :: select()
FormHelper
- __call
- __construct
- _csrfField
- _dateTimeSelected
- _extractOption
- _generateOptions
- _getModel
- _initInputField
- _inputLabel
- _introspectModel
- _isRequiredField
- _name
- _secure
- _selectOptions
- button
- checkbox
- create
- dateTime
- day
- end
- error
- file
- hidden
- hour
- input
- inputs
- isFieldError
- label
- meridian
- minute
- month
- postButton
- postLink
- radio
- secure
- select
- submit
- tagIsInvalid
- textarea
- unlockField
- year
A
AbstractTransport
AclBehavior
AclComponent
AclInterface
AclNode
AclShell
Aco
AcoAction
ActionsAuthorize
ApcEngine
ApiShell
App
AppController
AppController
AppHelper
AppHelper
AppModel
AppModel
AppShell
Aro
AuthComponent
B
BadRequestException
BakeShell
BakeTask
BaseAuthenticate
BaseAuthorize
BasicAuthenticate
BasicAuthentication
BehaviorCollection
C
Cache
CacheEngine
CacheException
CacheHelper
CacheSession
CakeEmail
CakeErrorController
CakeException
CakeLog
CakeLogException
CakeLogInterface
CakePlugin
CakeRequest
CakeResponse
CakeRoute
CakeSchema
CakeSession
CakeSessionException
CakeSessionHandlerInterface
CakeSocket
ClassRegistry
CommandListShell
Component
ComponentCollection
ConfigReaderInterface
Configure
ConfigureException
ConnectionManager
ConsoleErrorHandler
ConsoleException
ConsoleInput
ConsoleInputArgument
ConsoleInputOption
ConsoleInputSubcommand
ConsoleOptionParser
ConsoleOutput
ConsoleShell
ContainableBehavior
Controller
ControllerAuthorize
ControllerTask
CookieComponent
CrudAuthorize
D
DatabaseSession
DataSource
DbAcl
DbAclSchema
DbConfigTask
DboSource
Debugger
DebugTransport
DigestAuthenticate
DigestAuthentication
Dispatcher
E
EmailComponent
ErrorHandler
ExceptionRenderer
ExtractTask
F
File
FileEngine
FileLog
FixtureTask
Folder
ForbiddenException
FormAuthenticate
FormHelper
H
Helper
HelperCollection
HelpFormatter
HtmlHelper
HttpException
HttpResponse
HttpSocket
I
I18n
I18nModel
i18nSchema
I18nShell
Inflector
IniReader
InternalErrorException
J
JqueryEngineHelper
JsBaseEngineHelper
JsHelper
L
L10n
M
MailTransport
MediaView
MemcacheEngine
MethodNotAllowedException
MissingActionException
MissingBehaviorException
MissingComponentException
MissingConnectionException
MissingControllerException
MissingDatabaseException
MissingDatasourceConfigException
MissingDatasourceException
MissingHelperException
MissingLayoutException
MissingModelException
MissingPluginException
MissingShellException
MissingShellMethodException
MissingTableException
MissingTaskException
MissingTestLoaderException
MissingViewException
Model
ModelBehavior
ModelTask
MootoolsEngineHelper
Multibyte
Mysql
N
NotFoundException
NumberHelper
O
Object
ObjectCollection
P
PagesController
PagesController
PaginatorComponent
PaginatorHelper
Permission
PhpReader
PluginShortRoute
PluginTask
Postgres
PrivateActionException
ProjectTask
PrototypeEngineHelper
R
RedirectRoute
RequestHandlerComponent
Router
RouterException
RssHelper
S
Sanitize
Scaffold
ScaffoldView
SchemaShell
Security
SecurityComponent
SessionComponent
SessionHelper
SessionsSchema
Set
Shell
ShellDispatcher
SmtpTransport
SocketException
Sqlite
Sqlserver
String
T
TaskCollection
TemplateTask
TestsuiteShell
TestTask
TextHelper
ThemeView
TimeHelper
TranslateBehavior
TreeBehavior
U
UnauthorizedException
UpgradeShell
V
Validation
View
ViewTask
W
WincacheEngine
X
XcacheEngine
Xml
XmlException
select
Returns a formatted SELECT element.
Method
(string)
public select
($fieldName, $options = array(), $attributes = array())
Parameters
Parameter | Type | Comment | Default |
---|---|---|---|
$fieldName | string | required Name attribute of the SELECT | |
$options | array | optional Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the SELECT element | array() |
$attributes | array | optional The HTML attributes of the select element. | array() |
Return
stringComment
Returns a formatted SELECT element.
### Attributes:
- `showParents` - If included in the array and set to true, an additional option element
will be added for the parent of each option group. You can set an option with the same name
and it's key will be used for the value of the option.
- `multiple` - show a multiple select box. If set to 'checkbox' multiple checkboxes will be
created instead.
- `empty` - If true, the empty select option is shown. If a string,
that string is displayed as the empty element.
- `escape` - If true contents of options will be HTML entity encoded. Defaults to true.
- `value` The selected value of the input.
- `class` - When using multiple = checkbox the classname to apply to the divs. Defaults to 'checkbox'.
### Using options
A simple array will create normal options:
{{{
$options = array(1 => 'one', 2 => 'two);
$this->Form->select('Model.field', $options));
}}}
While a nested options array will create optgroups with options inside them.
{{{
$options = array(
1 => 'bill',
'fred' => array(
2 => 'fred',
3 => 'fred jr.'
)
);
$this->Form->select('Model.field', $options);
}}}
In the above `2 => 'fred'` will not generate an option element. You should enable the `showParents`
attribute to show the fred option.
If you have multiple options that need to have the same value attribute, you can
use an array of arrays to express this:
{{{
$options = array(
array('name' => 'United states', 'value' => 'USA'),
array('name' => 'USA', 'value' => 'USA'),
);
}}}
@param string $fieldName Name attribute of the SELECT
@param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the
SELECT element
@param array $attributes The HTML attributes of the select element.
@return string Formatted SELECT element
@link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
### Attributes:
- `showParents` - If included in the array and set to true, an additional option element
will be added for the parent of each option group. You can set an option with the same name
and it's key will be used for the value of the option.
- `multiple` - show a multiple select box. If set to 'checkbox' multiple checkboxes will be
created instead.
- `empty` - If true, the empty select option is shown. If a string,
that string is displayed as the empty element.
- `escape` - If true contents of options will be HTML entity encoded. Defaults to true.
- `value` The selected value of the input.
- `class` - When using multiple = checkbox the classname to apply to the divs. Defaults to 'checkbox'.
### Using options
A simple array will create normal options:
{{{
$options = array(1 => 'one', 2 => 'two);
$this->Form->select('Model.field', $options));
}}}
While a nested options array will create optgroups with options inside them.
{{{
$options = array(
1 => 'bill',
'fred' => array(
2 => 'fred',
3 => 'fred jr.'
)
);
$this->Form->select('Model.field', $options);
}}}
In the above `2 => 'fred'` will not generate an option element. You should enable the `showParents`
attribute to show the fred option.
If you have multiple options that need to have the same value attribute, you can
use an array of arrays to express this:
{{{
$options = array(
array('name' => 'United states', 'value' => 'USA'),
array('name' => 'USA', 'value' => 'USA'),
);
}}}
@param string $fieldName Name attribute of the SELECT
@param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the
SELECT element
@param array $attributes The HTML attributes of the select element.
@return string Formatted SELECT element
@link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs