Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zend.filter.whitelist.html

Size:9290
Storage flags:no_autoload,compress/gzip (31%)

Whitelist — Zend Framework 2 2.4.2 documentation

Whitelist

This filter will return null if the value being filtered is not present the filter’s allowed list of values. If the value is present, it will return that value.

For the opposite functionality see the Blacklist filter.

Supported Options

The following options are supported for Zend\Filter\Whitelist:

  • strict: Uses strict mode when comparing: passed through to in_array‘s third argument.
  • list: An array of allowed values.

Basic Usage

This is a basic example:

1
2
3
4
5
$whitelist = new \Zend\Filter\Whitelist(array(
    'list' => array('allowed-1', 'allowed-2')
));
echo $whitelist->filter('allowed-2');   // => 'allowed-2'
echo $whitelist->filter('not-allowed'); // => null

Table Of Contents

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 Whitelist 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