Introduction | Zend_Filter Programmer's Reference Guide | Filter Chains

# Standard Filter Classes

Zend Framework comes with a standard set of filters, which are ready for you to use.

# Alnum

Zend_Filter_Alnum is a filter which returns only alphabetic characters and digits. All other characters are supressed.

# Supported options for Zend_Filter_Alnum

The following options are supported for Zend_Filter_Alnum:

- allowwhitespace: If this option is set then whitespace characters are allowed. Otherwise they are supressed. Per default whitespaces are not allowed.

# Basic usage

See the following example for the default behaviour of this filter.

1. $filter = new Zend_Filter_Alnum();
2. $return = $filter->filter('This is (my) content: 123');
3. // returns 'Thisismycontent123'

The above example returns 'Thisismycontent123'. As you see all whitespaces and also the brackets are filtered.

> Note: Zend_Filter_Alnum works on almost all languages. But actually there are three exceptions: Chinese, Japanese and Korean. Within these languages the english alphabet is use instead of the characters from these languages. The language itself is detected by using Zend_Locale.

# Allow whitespaces

Zend_Filter_Alnum can also allow whitespaces. This can be usefull when you want to strip special chars from a text. See the following example:

1. $filter = new Zend_Filter_Alnum(array('allowwhitespace' => true));
2. $return = $filter->filter('This is (my) content: 123');
3. // returns 'This is my content 123'

The above example returns 'This is my content 123'. As you see only the brackets are filtered whereas the whitespaces are not touched.

To change allowWhiteSpace afterwards you can use setAllowWhiteSpace() and getAllowWhiteSpace().

# Alpha

Zend_Filter_Alpha is a filter which returns the string $value, removing all but alphabetic characters. This filter includes an option to also allow white space characters.

# Supported options for Zend_Filter_Alpha

The following options are supported for Zend_Filter_Alpha:

- allowwhitespace: If this option is set then whitespace characters are allowed. Otherwise they are suppressed. By default whitespace characters are not allowed.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_Alpha();
3. print $filter->filter('This is (my) content: 123');

The above example returns 'Thisismycontent'. Notice that the whitespace characters and brackets are removed.

> Note: Zend_Filter_Alpha works on most languages; however, there are three exceptions: Chinese, Japanese and Korean. With these languages the english alphabet is used. The language is detected through the use of Zend_Locale.

# Allow whitespace characters

Zend_Filter_Alpha can also allow whitespace characters. This can be useful when you want to strip special characters from a string. See the following example:

1. $filter = new Zend_Filter_Alpha(array('allowwhitespace' => true));
3. print $filter->filter('This is (my) content: 123');

The above example returns 'This is my content '. Notice that the parenthesis, colon, and numbers have all been removed while the whitespace characters remain.

To change allowWhiteSpace after instantiation the method setAllowWhiteSpace() may be used.

To query the current value of allowWhiteSpace the method getAllowWhiteSpace() may be used.

# BaseName

Zend_Filter_BaseName allows you to filter a string which contains the path to a file and it will return the base name of this file.

# Supported options for Zend_Filter_BaseName

There are no additional options for Zend_Filter_BaseName.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_BaseName();
3. print $filter->filter('/vol/tmp/filename');

This will return 'filename'.

1. $filter = new Zend_Filter_BaseName();
3. print $filter->filter('/vol/tmp/filename.txt');

This will return 'filename.txt'.

# Boolean

This filter changes a given input to be a `BOOLEAN` value. This is often useful when working with databases or when processing form values.

# Default behaviour for Zend_Filter_Boolean

By default, this filter works by casting the input to a `BOOLEAN` value; in other words, it operates in a similar fashion to calling (boolean) $value.

1. $filter = new Zend_Filter_Boolean();
2. $value = '';
3. $result = $filter->filter($value);
4. // returns false

This means that without providing any configuration, Zend_Filter_Boolean accepts all input types and returns a `BOOLEAN` just as you would get by type casting to `BOOLEAN`.

# Changing behaviour for Zend_Filter_Boolean

Sometimes casting with (boolean) will not suffice. Zend_Filter_Boolean allows you to configure specific types to convert, as well as which to omit.

The following types can be handled:

- boolean: Returns a boolean value as is.

- integer: Converts an integer 0 value to `FALSE`.

- float: Converts a float 0.0 value to `FALSE`.

- string: Converts an empty string '' to `FALSE`.

- zero: Converts a string containing the single character zero ('0') to `FALSE`.

- empty_array: Converts an empty array to `FALSE`.

- null: Converts a `NULL` value to `FALSE`.

- php: Converts values according to PHP when casting them to `BOOLEAN`.

- false_string: Converts a string containing the word "false" to a boolean `FALSE`.

- yes: Converts a localized string which contains the word "no" to `FALSE`.

- all: Converts all above types to `BOOLEAN`.

All other given values will return `TRUE` by default.

There are several ways to select which of the above types are filtered. You can give one or multiple types and add them, you can give an array, you can use constants, or you can give a textual string. See the following examples:

1. // converts 0 to false
2. $filter = new Zend_Filter_Boolean(Zend_Filter_Boolean::INTEGER);
4. // converts 0 and '0' to false
5. $filter = new Zend_Filter_Boolean(
6. Zend_Filter_Boolean::INTEGER + Zend_Filter_Boolean::ZERO
7. );
9. // converts 0 and '0' to false
10. $filter = new Zend_Filter_Boolean(array(
11. 'type' => array(
12. Zend_Filter_Boolean::INTEGER,
13. Zend_Filter_Boolean::ZERO,
14. ),
15. ));
17. // converts 0 and '0' to false
18. $filter = new Zend_Filter_Boolean(array(
19. 'type' => array(
20. 'integer',
21. 'zero',
22. ),
23. ));

You can also give an instance of Zend_Config to set the desired types. To set types after instantiation, use the setType() method.

# Localized booleans

As mentioned previously, Zend_Filter_Boolean can also recognise localized "yes" and "no" strings. This means that you can ask your customer in a form for "yes" or "no" within his native language and Zend_Filter_Boolean will convert the response to the appropriate boolean value.

To set the desired locale, you can either use the locale option, or the method setLocale().

1. $filter = new Zend_Filter_Boolean(array(
2. 'type' => Zend_Filter_Boolean::ALL,
3. 'locale' => 'de',
4. ));
6. // returns false
7. echo $filter->filter('nein');
9. $filter->setLocale('en');
11. // returns true
12. $filter->filter('yes');

# Disable casting

Sometimes it is necessary to recognise only `TRUE` or `FALSE` and return all other values without changes. Zend_Filter_Boolean allows you to do this by setting the casting option to `FALSE`.

In this case Zend_Filter_Boolean will work as described in the following table, which shows which values return `TRUE` or `FALSE`. All other given values are returned without change when casting is set to `FALSE`

Usage without casting
Type | True | False
--- | --- | ---
`Zend_Filter_Boolean::BOOLEAN` | `TRUE` | `FALSE`
`Zend_Filter_Boolean::INTEGER` | 0 | 1
`Zend_Filter_Boolean::FLOAT` | 0.0 | 1.0
`Zend_Filter_Boolean::STRING` | "" |
`Zend_Filter_Boolean::ZERO` | "0" | "1"
`Zend_Filter_Boolean::EMPTY_ARRAY` | array() |
`Zend_Filter_Boolean::NULL` | `NULL` |
`Zend_Filter_Boolean::FALSE_STRING` | "false" (case independently) | "true" (case independently)
`Zend_Filter_Boolean::YES` | localized "yes" (case independently) | localized "no" (case independently)

The following example shows the behaviour when changing the casting option:

1. $filter = new Zend_Filter_Boolean(array(
2. 'type' => Zend_Filter_Boolean::ALL,
3. 'casting' => false,
4. ));
6. // returns false
7. echo $filter->filter(0);
9. // returns true
10. echo $filter->filter(1);
12. // returns the value
13. echo $filter->filter(2);

# Callback

This filter allows you to use own methods in conjunction with Zend_Filter. You don't have to create a new filter when you already have a method which does the job.

Let's expect we want to create a filter which reverses a string.

1. $filter = new Zend_Filter_Callback('strrev');
3. print $filter->filter('Hello!');
4. // returns "!olleH"

As you can see it's really simple to use a callback to define a own filter. It is also possible to use a method, which is defined within a class, by giving an array as callback.

1. // Our classdefinition
2. class MyClass
3. {
4. public function Reverse($param);
5. }
7. // The filter definition
8. $filter = new Zend_Filter_Callback(array('MyClass', 'Reverse'));
9. print $filter->filter('Hello!');

To get the actual set callback use getCallback() and to set another callback use setCallback().

It is also possible to define default parameters, which are given to the called method as array when the filter is executed. This array will be concatenated with the value which will be filtered.

1. $filter = new Zend_Filter_Callback(
2. array(
3. 'callback' => 'MyMethod',
4. 'options' => array('key' => 'param1', 'key2' => 'param2')
5. )
6. );
7. $filter->filter(array('value' => 'Hello'));

When you would call the above method definition manually it would look like this:

1. $value = MyMethod('Hello', 'param1', 'param2');

> Note: You should note that defining a callback method which can not be called will raise an exception.

# Compress and Decompress

These two filters are capable of compressing and decompressing strings, files, and directories. They make use of adapters and support the following compression formats:

- Bz2

- Gz

- Lzf

- Rar

- Tar

- Zip

Each compression format has different capabilities as described below. All compression filters may be used in approximately the same ways, and differ primarily in the options available and the type of compression they offer (both algorithmically as well as string vs. file vs. directory)

# Generic handling

To create a compression filter you need to select the compression format you want to use. The following description takes the Bz2 adapter. Details for all other adapters are described after this section.

The two filters are basically identical, in that they utilize the same backends. Zend_Filter_Compress should be used when you wish to compress items, and Zend_Filter_Decompress should be used when you wish to decompress items.

For instance, if we want to compress a string, we have to initiate Zend_Filter_Compress and indicate the desired adapter.

1. $filter = new Zend_Filter_Compress('Bz2');

To use a different adapter, you simply specify it to the constructor.

You may also provide an array of options or Zend_Config object. If you do, provide minimally the key "adapter", and then either the key "options" or "adapterOptions" (which should be an array of options to provide to the adapter on instantiation).

1. $filter = new Zend_Filter_Compress(array(
2. 'adapter' => 'Bz2',
3. 'options' => array(
4. 'blocksize' => 8,
5. ),
6. ));

> Note: Default compression Adapter
> When no compression adapter is given, then the Gz adapter will be used.

Almost the same usage is we want to decompress a string. We just have to use the decompression filter in this case.

1. $filter = new Zend_Filter_Decompress('Bz2');

To get the compressed string, we have to give the original string. The filtered value is the compressed version of the original string.

1. $filter = new Zend_Filter_Compress('Bz2');
2. $compressed = $filter->filter('Uncompressed string');
3. // Returns the compressed string

Decompression works the same way.

1. $filter = new Zend_Filter_Decompress('Bz2');
2. $compressed = $filter->filter('Compressed string');
3. // Returns the uncompressed string

> Note: Note on string compression
> Not all adapters support string compression. Compression formats like Rar can only handle files and directories. For details, consult the section for the adapter you wish to use.

# Creating an archive

Creating an archive file works almost the same as compressing a string. However, in this case we need an additional parameter which holds the name of the archive we want to create.

1. $filter = new Zend_Filter_Compress(array(
2. 'adapter' => 'Bz2',
3. 'options' => array(
4. 'archive' => 'filename.bz2',
5. ),
6. ));
7. $compressed = $filter->filter('Uncompressed string');
8. // Returns true on success and creates the archive file

In the above example the uncompressed string is compressed, and is then written into the given archive file.

> Note: Existing archives will be overwritten
> The content of any existing file will be overwritten when the given filename of the archive already exists.

When you want to compress a file, then you must give the name of the file with its path.

1. $filter = new Zend_Filter_Compress(array(
2. 'adapter' => 'Bz2',
3. 'options' => array(
4. 'archive' => 'filename.bz2'
5. ),
6. ));
7. $compressed = $filter->filter('C:\temp\compressme.txt');
8. // Returns true on success and creates the archive file

You may also specify a directory instead of a filename. In this case the whole directory with all its files and subdirectories will be compressed into the archive.

1. $filter = new Zend_Filter_Compress(array(
2. 'adapter' => 'Bz2',
3. 'options' => array(
4. 'archive' => 'filename.bz2'
5. ),
6. ));
7. $compressed = $filter->filter('C:\temp\somedir');
8. // Returns true on success and creates the archive file

> Note: Do not compress large or base directories
> You should never compress large or base directories like a complete partition. Compressing a complete partition is a very time consuming task which can lead to massive problems on your server when there is not enough space or your script takes too much time.

# Decompressing an archive

Decompressing an archive file works almost like compressing it. You must specify either the archive parameter, or give the filename of the archive when you decompress the file.

1. $filter = new Zend_Filter_Decompress('Bz2');
2. $compressed = $filter->filter('filename.bz2');
3. // Returns true on success and decompresses the archive file

Some adapters support decompressing the archive into another subdirectory. In this case you can set the target parameter.

1. $filter = new Zend_Filter_Decompress(array(
2. 'adapter' => 'Zip',
3. 'options' => array(
4. 'target' => 'C:\temp',
5. )
6. ));
7. $compressed = $filter->filter('filename.zip');
8. // Returns true on success and decompresses the archive file
9. // into the given target directory

> Note: Directories to extract to must exist
> When you want to decompress an archive into a directory, then that directory must exist.

# Bz2 Adapter

The Bz2 Adapter can compress and decompress:

- Strings

- Files

- Directories

This adapter makes use of PHP's Bz2 extension.

To customize compression, this adapter supports the following options:

- Archive: This parameter sets the archive file which should be used or created.

- Blocksize: This parameter sets the blocksize to use. It can be from '0' to '9'. The default value is '4'.

All options can be set at instantiation or by using a related method. For example, the related methods for 'Blocksize' are getBlocksize() and setBlocksize(). You can also use the setOptions() method which accepts all options as array.

# Gz Adapter

The Gz Adapter can compress and decompress:

- Strings

- Files

- Directories

This adapter makes use of PHP's Zlib extension.

To customize the compression this adapter supports the following options:

- Archive: This parameter sets the archive file which should be used or created.

- Level: This compression level to use. It can be from '0' to '9'. The default value is '9'.

- Mode: There are two supported modes. 'compress' and 'deflate'. The default value is 'compress'.

All options can be set at initiation or by using a related method. For example, the related methods for 'Level' are getLevel() and setLevel(). You can also use the setOptions() method which accepts all options as array.

# Lzf Adapter

The Lzf Adapter can compress and decompress:

- Strings

> Note: Lzf supports only strings
> The Lzf adapter can not handle files and directories.

This adapter makes use of PHP's Lzf extension.

There are no options available to customize this adapter.

# Rar Adapter

The Rar Adapter can compress and decompress:

- Files

- Directories

> Note: Rar does not support strings
> The Rar Adapter can not handle strings.

This adapter makes use of PHP's Rar extension.

> Note: Rar compression not supported
> Due to restrictions with the Rar compression format, there is no compression available for free. When you want to compress files into a new Rar archive, you must provide a callback to the adapter that can invoke a Rar compression program.

To customize the compression this adapter supports the following options:

- Archive: This parameter sets the archive file which should be used or created.

- Callback: A callback which provides compression support to this adapter.

- Password: The password which has to be used for decompression.

- Target: The target where the decompressed files will be written to.

All options can be set at instantiation or by using a related method. For example, the related methods for 'Target' are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array.

# Tar Adapter

The Tar Adapter can compress and decompress:

- Files

- Directories

> Note: Tar does not support strings
> The Tar Adapter can not handle strings.

This adapter makes use of PEAR's Archive_Tar component.

To customize the compression this adapter supports the following options:

- Archive: This parameter sets the archive file which should be used or created.

- Mode: A mode to use for compression. Supported are either '`NULL`' which means no compression at all, 'Gz' which makes use of PHP's Zlib extension and 'Bz2' which makes use of PHP's Bz2 extension. The default value is '`NULL`'.

- Target: The target where the decompressed files will be written to.

All options can be set at instantiation or by using a related method. For example, the related methods for 'Target' are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array.

> Note: Directory usage
> When compressing directories with Tar then the complete file path is used. This means that created Tar files will not only have the subdirectory but the complete path for the compressed file.

# Zip Adapter

The Zip Adapter can compress and decompress:

- Strings

- Files

- Directories

> Note: Zip does not support string decompression
> The Zip Adapter can not handle decompression to a string; decompression will always be written to a file.

This adapter makes use of PHP's Zip extension.

To customize the compression this adapter supports the following options:

- Archive: This parameter sets the archive file which should be used or created.

- Target: The target where the decompressed files will be written to.

All options can be set at instantiation or by using a related method. For example, the related methods for 'Target' are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array.

# Decrypt

This filter will decrypt any given string with the provided setting. Therefor it makes use of Adapters. Actually there are adapters for the Mcrypt and OpenSSL extensions from PHP.

For details about how to encrypt content look at the Encrypt filter. As the basics are covered within the Encrypt filter, we will describe here only the needed additional methods and changes for decryption.

# Decryption with Mcrypt

For decrypting content which was previously encrypted with Mcrypt you need to have the options with which the encryption has been called.

There is one eminent difference for you. When you did not provide a vector at encryption you need to get it after you encrypted the content by using the getVector() method on the encryption filter. Without the correct vector you will not be able to decrypt the content.

As soon as you have provided all options decryption is as simple as encryption.

1. // Use the default blowfish settings
2. $filter = new Zend_Filter_Decrypt('myencryptionkey');
4. // Set the vector with which the content was encrypted
5. $filter->setVector('myvector');
7. $decrypted = $filter->filter('encoded_text_normally_unreadable');
8. print $decrypted;

> Note: Note that you will get an exception if the mcrypt extension is not available in your environment.

> Note: You should also note that all settings which be checked when you create the instance or when you call setEncryption(). If mcrypt detects problem with your settings an exception will be thrown.

# Decryption with OpenSSL

Decryption with OpenSSL is as simple as encryption. But you need to have all data from the person who encrypted the content.

For decryption with OpenSSL you need:

- private: Your private key which will be used for decrypting the content. The private key can be either a filename with path of the key file, or just the content of the key file itself.

- envelope: The encrypted envelope key from the user who encrypted the content. You can either provide the path and filename of the key file, or just the content of the key file itself. When the package option has been set, then you can omit this parameter.

- package: If the envelope key has been packed with the encrypted value. Defaults to `FALSE`.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Decrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the envelope keys at initiation
8. $filter->setEnvelopeKey(array(
9. '/key/from/encoder/first.pem',
10. '/key/from/encoder/second.pem'
11. ));

> Note: Note that the OpenSSL adapter will not work when you do not provide valid keys.

Optionally it could be necessary to provide the passphrase for decrypting the keys themself by using the setPassphrase() method.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Decrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the envelope keys at initiation
8. $filter->setEnvelopeKey(array(
9. '/key/from/encoder/first.pem',
10. '/key/from/encoder/second.pem'
11. ));
12. $filter->setPassphrase('mypassphrase');

At last, decode the content. Our complete example for decrypting the previously encrypted content looks like this.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Decrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the envelope keys at initiation
8. $filter->setEnvelopeKey(array(
9. '/key/from/encoder/first.pem',
10. '/key/from/encoder/second.pem'
11. ));
12. $filter->setPassphrase('mypassphrase');
14. $decrypted = $filter->filter('encoded_text_normally_unreadable');
15. print $decrypted;

# Digits

Returns the string $value, removing all but digits.

# Supported options for Zend_Filter_Digits

There are no additional options for Zend_Filter_Digits.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_Digits();
3. print $filter->filter('October 2009');

This returns "2009".

1. $filter = new Zend_Filter_Digits();
3. print $filter->filter('HTML 5 for Dummies');

This returns "5".

# Dir

Given a string containing a path to a file, this function will return the name of the directory.

# Supported options for Zend_Filter_Dir

There are no additional options for Zend_Filter_Dir.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_Dir();
3. print $filter->filter('/etc/passwd');

This returns "/etc".

1. $filter = new Zend_Filter_Dir();
3. print $filter->filter('C:/Temp/x');

This returns "C:/Temp".

# Encrypt

This filter will encrypt any given string with the provided setting. Therefor it makes use of Adapters. Actually there are adapters for the Mcrypt and OpenSSL extensions from PHP.

As these two encryption methodologies work completely different, also the usage of the adapters differ. You have to select the adapter you want to use when initiating the filter.

1. // Use the Mcrypt adapter
2. $filter1 = new Zend_Filter_Encrypt(array('adapter' => 'mcrypt'));
4. // Use the OpenSSL adapter
5. $filter2 = new Zend_Filter_Encrypt(array('adapter' => 'openssl'));

To set another adapter you can also use setAdapter(), and the getAdapter() method to receive the actual set adapter.

1. // Use the Mcrypt adapter
2. $filter = new Zend_Filter_Encrypt();
3. $filter->setAdapter('openssl');

> Note: When you do not supply the adapter option or do not use setAdapter, then the Mcrypt adapter will be used per default.

# Encryption with Mcrypt

When you have installed the Mcrypt extension you can use the Mcrypt adapter. This adapter supports the following options at initiation:

- key: The encryption key with which the input will be encrypted. You need the same key for decryption.

- algorithm: The algorithm which has to be used. It should be one of the algorithm ciphers which can be found under » PHP's mcrypt ciphers. If not set it defaults to 'blowfish'.

- algorithm_directory: The directory where the algorithm can be found. If not set it defaults to the path set within the mcrypt extension.

- mode: The encryption mode which has to be used. It should be one of the modes which can be found under » PHP's mcrypt modes. If not set it defaults to 'cbc'.

- mode_directory: The directory where the mode can be found. If not set it defaults to the path set within the Mcrypt extension.

- vector: The initialization vector which shall be used. If not set it will be a random vector.

- salt: If the key should be used as salt value. The key used for encryption will then itself also be encrypted. Default is `FALSE`.

- compression: If the encrypted value should be compressed. Default is no compression. For details take a look into compression for Openssl.

If you give a string instead of an array, this string will be used as key.

You can get and set the encryption values also afterwards with the getEncryption() and setEncryption() methods.

> Note: Note that you will get an exception if the mcrypt extension is not available in your environment.

> Note: You should also note that all settings which be checked when you create the instance or when you call setEncryption(). If mcrypt detects problem with your settings an exception will be thrown.

You can get or set the encryption vector by calling getVector() and setVector(). A given string will be truncated or padded to the needed vector size of the used algorithm.

> Note: Note that when you are not using an own vector, you must get the vector and store it. Otherwise you will not be able to decode the encoded string.

1. // Use the default blowfish settings
2. $filter = new Zend_Filter_Encrypt('myencryptionkey');
4. // Set a own vector, otherwise you must call getVector()
5. // and store this vector for later decryption
6. $filter->setVector('myvector');
7. // $filter->getVector();
9. $encrypted = $filter->filter('text_to_be_encoded');
10. print $encrypted;
12. // For decryption look at the Decrypt filter

# Encryption with OpenSSL

When you have installed the OpenSSL extension you can use the OpenSSL adapter. This adapter supports the following options at initiation:

- public: The public key of the user whom you want to provide the encrpted content. You can give multiple public keys by using an array. You can eigther provide the path and filename of the key file, or just the content of the key file itself.

- private: Your private key which will be used for encrypting the content. Also the private key can be either a filename with path of the key file, or just the content of the key file itself.

- compression: If the encrypted value should be compressed. Default is no compression.

- package: If the envelope key should be packed with the encrypted value. Default is `FALSE`.

You can get or set the public keys also afterwards with the getPublicKey() and setPublicKey() methods. The private key can also be get and set with the related getPrivateKey() and setPrivateKey() methods.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Encrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the public keys at initiation
8. $filter->setPublicKey(array(
9. '/public/key/path/first.pem',
10. '/public/key/path/second.pem'
11. ));

> Note: Note that the OpenSSL adapter will not work when you do not provide valid keys.

When you want to encode also the keys, then you have to provide a passphrase with the setPassphrase() method. When you want to decode content which was encoded with a passphrase you will not only need the public key, but also the passphrase to decode the encrypted key.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Encrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the public keys at initiation
8. $filter->setPublicKey(array(
9. '/public/key/path/first.pem',
10. '/public/key/path/second.pem'
11. ));
12. $filter->setPassphrase('mypassphrase');

At last, when you use OpenSSL you need to give the receiver the encrypted content, the passphrase when have provided one, and the envelope keys for decryption.

This means for you, that you have to get the envelope keys after the encryption with the getEnvelopeKey() method.

So our complete example for encrypting content with OpenSSL look like this.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Encrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem'
5. ));
7. // of course you can also give the public keys at initiation
8. $filter->setPublicKey(array(
9. '/public/key/path/first.pem',
10. '/public/key/path/second.pem'
11. ));
12. $filter->setPassphrase('mypassphrase');
14. $encrypted = $filter->filter('text_to_be_encoded');
15. $envelope = $filter->getEnvelopeKey();
16. print $encrypted;
18. // For decryption look at the Decrypt filter

# Simplified usage with Openssl

As seen before, you need to get the envelope key to be able to decrypt the previous encrypted value. This can be very annoying when you work with multiple values.

To have a simplified usage you can set the package option to `TRUE`. The default value is `FALSE`.

1. // Use openssl and provide a private key
2. $filter = new Zend_Filter_Encrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem',
5. 'public' => '/public/key/path/public.pem',
6. 'package' => true
7. ));
9. $encrypted = $filter->filter('text_to_be_encoded');
10. print $encrypted;
12. // For decryption look at the Decrypt filter

Now the returned value contains the encrypted value and the envelope. You don't need to get them after the compression. But, and this is the negative aspect of this feature, the encrypted value can now only be decrypted by using Zend_Filter_Encrypt.

# Compressing the content

Based on the original value, the encrypted value can be a very large string. To reduce the value Zend_Filter_Encrypt allows the usage of compression.

The compression option can eighter be set to the name of a compression adapter, or to an array which sets all wished options for the compression adapter.

1. // Use basic compression adapter
2. $filter1 = new Zend_Filter_Encrypt(array(
3. 'adapter' => 'openssl',
4. 'private' => '/path/to/mykey/private.pem',
5. 'public' => '/public/key/path/public.pem',
6. 'package' => true,
7. 'compression' => 'bz2'
8. ));
10. // Use basic compression adapter
11. $filter2 = new Zend_Filter_Encrypt(array(
12. 'adapter' => 'openssl',
13. 'private' => '/path/to/mykey/private.pem',
14. 'public' => '/public/key/path/public.pem',
15. 'package' => true,
16. 'compression' => array('adapter' => 'zip', 'target' => '\usr\tmp\tmp.zip')
17. ));

> Note: Decryption with same settings
> When you want to decrypt a value which is additionally compressed, then you need to set the same compression settings for decryption as for encryption. Otherwise the decryption will fail.

# HtmlEntities

Returns the string $value, converting characters to their corresponding HTML entity equivalents where they exist.

# Supported options for Zend_Filter_HtmlEntities

The following options are supported for Zend_Filter_HtmlEntities:

- quotestyle: Equivalent to the PHP htmlentities native function parameter quote_style. This allows you to define what will be done with 'single' and "double" quotes. The following constants are accepted: `ENT_COMPAT`, `ENT_QUOTES` `ENT_NOQUOTES` with the default being `ENT_COMPAT`.

- charset: Equivalent to the PHP htmlentities native function parameter charset. This defines the character set to be used in filtering. Unlike the PHP native function the default is 'UTF-8'. See "http://php.net/htmlentities" for a list of supported character sets.

  > Note: This option can also be set via the $options parameter as a Zend_Config object or array. The option key will be accepted as either charset or encoding.

- doublequote: Equivalent to the PHP htmlentities native function parameter double_encode. If set to false existing html entities will not be encoded. The default is to convert everything (true).

  > Note: This option must be set via the $options parameter or the setDoubleEncode() method.

# Basic usage

See the following example for the default behaviour of this filter.

1. $filter = new Zend_Filter_HtmlEntities();
3. print $filter->filter('<');

# Quote Style

Zend_Filter_HtmlEntities allows changing the quote style used. This can be useful when you want to leave double, single, or both types of quotes un-filtered. See the following example:

1. $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_QUOTES));
3. $input = "A 'single' and " . '"double"';
4. print $filter->filter($input);

The above example returns A 'single' and "double". Notice that 'single' as well as "double" quotes are filtered.

1. $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_COMPAT));
3. $input = "A 'single' and " . '"double"';
4. print $filter->filter($input);

The above example returns A 'single' and "double". Notice that "double" quotes are filtered while 'single' quotes are not altered.

1. $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_NOQUOTES));
3. $input = "A 'single' and " . '"double"';
4. print $filter->filter($input);

The above example returns A 'single' and "double". Notice that neither "double" or 'single' quotes are altered.

# Helper Methods

To change or retrieve the quotestyle after instantiation, the two methods setQuoteStyle() and getQuoteStyle() may be used respectively. setQuoteStyle() accepts one parameter $quoteStyle. The following constants are accepted: `ENT_COMPAT`, `ENT_QUOTES`, `ENT_NOQUOTES`

1. $filter = new Zend_Filter_HtmlEntities();
3. $filter->setQuoteStyle(ENT_QUOTES);
4. print $filter->getQuoteStyle(ENT_QUOTES);

To change or retrieve the charset after instantiation, the two methods setCharSet() and getCharSet() may be used respectively. setCharSet() accepts one parameter $charSet. See "http://php.net/htmlentities" for a list of supported character sets.

1. $filter = new Zend_Filter_HtmlEntities();
3. $filter->setQuoteStyle(ENT_QUOTES);
4. print $filter->getQuoteStyle(ENT_QUOTES);

To change or retrieve the doublequote option after instantiation, the two methods setDoubleQuote() and getDoubleQuote() may be used respectively. setDoubleQuote() accepts one boolean parameter $doubleQuote.

1. $filter = new Zend_Filter_HtmlEntities();
3. $filter->setQuoteStyle(ENT_QUOTES);
4. print $filter->getQuoteStyle(ENT_QUOTES);

# Int

Zend_Filter_Int allows you to transform a sclar value which contains into an integer.

# Supported options for Zend_Filter_Int

There are no additional options for Zend_Filter_Int.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_Int();
3. print $filter->filter('-4 is less than 0');

This will return '-4'.

# LocalizedToNormalized

This filter will change any given localized input to it's normalized representation. It uses in Background Zend_Locale to do this transformation for you.

This allows your user to enter informations in his own language notation, and you can then store the normalized value into your database for example.

> Note: Please note that normalization is not equal to translation. This filter can not translate strings from one language into another like you could expect with months or names of days.

The following input types can be normalized:

- integer: Integer numbers, which are localized, will be normalized to the english notation.

- float: Float numbers, which are localized, will be normalized to the english notation.

- numbers: Other numbers, like real, will be normalized to the english notation.

- time: Time values, will be normalized to a named array.

- date: Date values, will be normalized to a named array.

Any other input will be returned as it, without changing it.

> Note: You should note that normalized output is always given as string. Otherwise your environment would transfer the normalized output automatically to the notation used by the locale your environment is set to.

# Normalization for numbers

Any given number like integer, float or real value, can be normalized. Note, that numbers in scientific notation, can actually not be handled by this filter.

So how does this normalization work in detail for numbers:

1. // Initiate the filter
2. $filter = new Zend_Filter_LocalizedToNormalized();
3. $filter->filter('123.456,78');
4. // returns the value '123456.78'

Let's expect you have set the locale 'de' as application wide locale. Zend_Filter_LocalizedToNormalized will take the set locale and use it to detect which sort of input you gave. In our example it was a value with precision. Now the filter will return you the normalized representation for this value as string.

You can also control how your normalized number has to look like. Therefor you can give all options which are also used by Zend_Locale_Format. The most common are:

- date_format

- locale

- precision

For details about how these options are used take a look into this Zend_Locale chapter.

Below is a example with defined precision so you can see how options work:

1. // Numeric Filter
2. $filter = new Zend_Filter_LocalizedToNormalized(array('precision' => 2));
4. $filter->filter('123.456');
5. // returns the value '123456.00'
7. $filter->filter('123.456,78901');
8. // returns the value '123456.79'

# Normalization for date and time

Input for date and time values can also be normalized. All given date and time values will be returned as array, where each date part is given within a own key.

1. // Initiate the filter
2. $filter = new Zend_Filter_LocalizedToNormalized();
3. $filter->filter('12.April.2009');
4. // returns array('day' => '12', 'month' => '04', 'year' => '2009')

Let's expect you have set the locale 'de' again. Now the input is automatically detected as date, and you will get a named array in return.

Of course you can also control how your date input looks like with the date_format and the locale option.

1. // Date Filter
2. $filter = new Zend_Filter_LocalizedToNormalized(
3. array('date_format' => 'ss:mm:HH')
4. );
6. $filter->filter('11:22:33');
7. // returns array('hour' => '33', 'minute' => '22', 'second' => '11')

# NormalizedToLocalized

This filter is the reverse of the filter Zend_Filter_LocalizedToNormalized and will change any given normalized input to it's localized representation. It uses in Background Zend_Locale to do this transformation for you.

This allows you to give your user any stored normalised value in a localized manner, your user is more common to.

> Note: Please note that localization is not equal to translation. This filter can not translate strings from one language into another like you could expect with months or names of days.

The following input types can be localized:

- integer: Integer numbers, which are normalized, will be localized to the set notation.

- float: Float numbers, which are normalized, will be localized to the set notation.

- numbers: Other numbers, like real, will be localized to the set notation.

- time: Time values, will be localized to a string.

- date: Date values, will be normalized to a string.

Any other input will be returned as it, without changing it.

# Localization for numbers

Any given number like integer, float or real value, can be localized. Note, that numbers in scientific notation, can actually not be handled by this filter.

So how does localization work in detail for numbers:

1. // Initiate the filter
2. $filter = new Zend_Filter_NormalizedToLocalized();
3. $filter->filter(123456.78);
4. // returns the value '123.456,78'

Let's expect you have set the locale 'de' as application wide locale. Zend_Filter_NormalizedToLocalized will take the set locale and use it to detect which sort of output you want to have. In our example it was a value with precision. Now the filter will return you the localized representation for this value as string.

You can also control how your localized number has to look like. Therefor you can give all options which are also used by Zend_Locale_Format. The most common are:

- date_format

- locale

- precision

For details about how these options are used take a look into this Zend_Locale chapter.

Below is a example with defined precision so you can see how options work:

1. // Numeric Filter
2. $filter = new Zend_Filter_NormalizedToLocalized(array('precision' => 2));
4. $filter->filter(123456);
5. // returns the value '123.456,00'
7. $filter->filter(123456.78901);
8. // returns the value '123.456,79'

# Localization for date and time

Normalized for date and time values can also be localized. All given date and time values will be returned as string, with the format defined by the set locale.

1. // Initiate the filter
2. $filter = new Zend_Filter_NormalizedToLocalized();
3. $filter->filter(array('day' => '12', 'month' => '04', 'year' => '2009');
4. // returns '12.04.2009'

Let's expect you have set the locale 'de' again. Now the input is automatically detected as date, and will be returned in the format defined by the locale 'de'.

Of course you can also control how your date input looks like with the date_format, and the locale option.

1. // Date Filter
2. $filter = new Zend_Filter_LocalizedToNormalized(
3. array('date_format' => 'ss:mm:HH')
4. );
6. $filter->filter(array('hour' => '33', 'minute' => '22', 'second' => '11'));
7. // returns '11:22:33'

# Null

This filter will change the given input to be `NULL` if it meets specific criteria. This is often necessary when you work with databases and want to have a `NULL` value instead of a boolean or any other type.

# Default behaviour for Zend_Filter_Null

Per default this filter works like PHP's empty() method; in other words, if empty() returns a boolean `TRUE`, then a `NULL` value will be returned.

1. $filter = new Zend_Filter_Null();
2. $value = '';
3. $result = $filter->filter($value);
4. // returns null instead of the empty string

This means that without providing any configuration, Zend_Filter_Null will accept all input types and return `NULL` in the same cases as empty().

Any other value will be returned as is, without any changes.

# Changing behaviour for Zend_Filter_Null

Sometimes it's not enough to filter based on empty(). Therefor Zend_Filter_Null allows you to configure which type will be converted and which not.

The following types can be handled:

- boolean: Converts a boolean `FALSE` value to `NULL`.

- integer: Converts an integer 0 value to `NULL`.

- empty_array: Converts an empty array to `NULL`.

- string: Converts an empty string '' to `NULL`.

- zero: Converts a string containing the single character zero ('0') to `NULL`.

- all: Converts all above types to `NULL`. (This is the default behavior.)

There are several ways to select which of the above types are filtered. You can give one or multiple types and add them, you can give an array, you can use constants, or you can give a textual string. See the following examples:

1. // converts false to null
2. $filter = new Zend_Filter_Null(Zend_Filter_Null::BOOLEAN);
4. // converts false and 0 to null
5. $filter = new Zend_Filter_Null(
6. Zend_Filter_Null::BOOLEAN + Zend_Filter_Null::INTEGER
7. );
9. // converts false and 0 to null
10. $filter = new Zend_Filter_Null( array(
11. Zend_Filter_Null::BOOLEAN,
12. Zend_Filter_Null::INTEGER
13. ));
15. // converts false and 0 to null
16. $filter = new Zend_Filter_Null(array(
17. 'boolean',
18. 'integer',
19. ));

You can also give an instance of Zend_Config to set the wished types. To set types afterwards use setType().

# PregReplace

Zend_Filter_PregReplace performs a search using regular expressions and replaces all found elements.

The option match has to be given to set the pattern which will be searched for. It can be a string for a single pattern, or an array of strings for multiple pattern.

To set the pattern which will be used as replacement the option replace has to be used. It can be a string for a single pattern, or an array of strings for multiple pattern.

1. $filter = new Zend_Filter_PregReplace(array('match' => 'bob',
2. 'replace' => 'john'));
3. $input = 'Hy bob!";
5. $filter->filter($input);
6. // returns 'Hy john!'

You can use getMatchPattern() and setMatchPattern() to set the matching pattern afterwards. To set the replacement pattern you can use getReplacement() and setReplacement().

1. $filter = new Zend_Filter_PregReplace();
2. $filter->setMatchPattern(array('bob', 'Hy'))
3. ->setReplacement(array('john', 'Bye'));
4. $input = 'Hy bob!";
6. $filter->filter($input);
7. // returns 'Bye john!'

For a more complex usage take a look into PHP's » PCRE Pattern Chapter.

# RealPath

This filter will resolve given links and pathnames and returns canonicalized absolute pathnames. References to '/./', '/../' and extra '/' characters in the input path will be stripped. The resulting path will not have any symbolic link, '/./' or '/../' character.

Zend_Filter_RealPath will return `FALSE` on failure, e.g. if the file does not exist. On BSD systems Zend_Filter_RealPath doesn't fail if only the last path component doesn't exist, while other systems will return `FALSE`.

1. $filter = new Zend_Filter_RealPath();
2. $path = '/www/var/path/../../mypath';
3. $filtered = $filter->filter($path);
5. // returns '/www/mypath'

Sometimes it is useful to get also paths when they don't exist, f.e. when you want to get the real path for a path which you want to create. You can then either give a `FALSE` at initiation, or use setExists() to set it.

1. $filter = new Zend_Filter_RealPath(false);
2. $path = '/www/var/path/../../non/existing/path';
3. $filtered = $filter->filter($path);
5. // returns '/www/non/existing/path'
6. // even when file_exists or realpath would return false

# StringToLower

This filter converts any input to be lowercased.

1. $filter = new Zend_Filter_StringToLower();
3. print $filter->filter('SAMPLE');
4. // returns "sample"

Per default it will only handle characters from the actual locale of your server. Characters from other charsets would be ignored. Still, it's possible to also lowercase them when the mbstring extension is available in your environment. Simply set the wished encoding when initiating the StringToLower filter. Or use the setEncoding() method to change the encoding afterwards.

1. // using UTF-8
2. $filter = new Zend_Filter_StringToLower('UTF-8');
4. // or give an array which can be useful when using a configuration
5. $filter = new Zend_Filter_StringToLower(array('encoding' => 'UTF-8'));
7. // or do this afterwards
8. $filter->setEncoding('ISO-8859-1');

> Note: Setting wrong encodings
> Be aware that you will get an exception when you want to set an encoding and the mbstring extension is not available in your environment.
> Also when you are trying to set an encoding which is not supported by your mbstring extension you will get an exception.

# StringToUpper

This filter converts any input to be uppercased.

1. $filter = new Zend_Filter_StringToUpper();
3. print $filter->filter('Sample');
4. // returns "SAMPLE"

Like the StringToLower filter, this filter handles only characters from the actual locale of your server. Using different character sets works the same as with StringToLower.

1. $filter = new Zend_Filter_StringToUpper(array('encoding' => 'UTF-8'));
3. // or do this afterwards
4. $filter->setEncoding('ISO-8859-1');

# StringTrim

This filter modifies a given string such that certain characters are removed from the beginning and end.

# Supported options for Zend_Filter_StringTrim

The following options are supported for Zend_Filter_StringTrim:

- charlist: List of characters to remove from the beginning and end of the string. If this is not set or is null, the default behavior will be invoked, which is to remove only whitespace from the beginning and end of the string.

# Basic usage

A basic example of usage is below:

1. $filter = new Zend_Filter_StringTrim();
3. print $filter->filter(' This is (my) content: ');

The above example returns 'This is (my) content:'. Notice that the whitespace characters have been removed.

# Default behaviour for Zend_Filter_StringTrim

1. $filter = new Zend_Filter_StringTrim(':');
2. // or new Zend_Filter_StringTrim(array('charlist' => ':'));
4. print $filter->filter(' This is (my) content:');

The above example returns 'This is (my) content'. Notice that the whitespace characters and colon are removed. You can also provide an instance of Zend_Config or an array with a 'charlist' key. To set the desired character list after instantiation, use the setCharList() method. The getCharList() return the values set for charlist.

# StripNewlines

Returns the string $value without any newline control characters.

# StripTags

This filter returns the input string, with all HTML and PHP tags stripped from it, except those that have been explicitly allowed. In addition to the ability to specify which tags are allowed, developers can specify which attributes are allowed across all allowed tags and for specific tags only.

Introduction | Zend_Filter Programmer's Reference Guide | Filter Chains