下記のオプションが Zend_Filter_Alnum でサポートされます。

このフィルターの既定の振る舞いについては、下記の例をご覧ください。

$filter = new Zend_Filter_Alnum();
$return = $filter->filter('This is (my) content: 123');
// 'Thisismycontent123' を返します

上記の例は 'Thisismycontent123' を返します。 ご覧の通り、空白の全てと、括弧がフィルターされています。

Zend_Filter_Alnum は空白も許します。 テキストから特別な文字を取り除きたい場合に役立つでしょう。下記の例をご覧ください。

$filter = new Zend_Filter_Alnum(array('allowwhitespace' => true));
$return = $filter->filter('This is (my) content: 123');
// 'This is my content 123' を返します。

上記の例は 'This is my content 123' を返します。 ご覧の通り、括弧はフィルターされましたが、空白には手が出されていません。

あとで allowWhiteSpace を変更するには、 setAllowWhiteSpace() や getAllowWhiteSpace() を使用できます。

下記のオプションが Zend_Filter_Alpha でサポートされます。

下記は基本的な使用例です。

$filter = new Zend_Filter_Alpha();

print $filter->filter('This is (my) content: 123');

上記の例は 'Thisismycontent' を返します。 空白文字と括弧が削除されていることに注意してください。

Zend_Filter_Alpha は空白文字も許せます。 文字列から特別な文字を取り除きたい場合に役立つでしょう。 下記の例をご覧ください。

$filter = new Zend_Filter_Alpha(array('allowwhitespace' => true));

print $filter->filter('This is (my) content: 123');

上記の例は 'This is my content ' を返します。 括弧やコロン、数字が全て除去された一方で、空白文字が残っていることに注意してください。

メソッド初期化後に allowWhiteSpace を変更するには、 setAllowWhiteSpace() が使えるでしょう。

メソッドの現在の allowWhiteSpace の値を照会するには、 getAllowWhiteSpace() が使えるでしょう。

Zend_Filter_BaseName に対する追加オプションはありません。

下記は基本的な使用例です。

$filter = new Zend_Filter_BaseName();

print $filter->filter('/vol/tmp/filename');

これは 'filename' を返します。

$filter = new Zend_Filter_BaseName();

print $filter->filter('/vol/tmp/filename.txt');

これは 'filename.txt' を返します。

The following options are supported 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.

$filter = new Zend_Filter_Boolean();
$value  = '';
$result = $filter->filter($value);
// 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.

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:

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:

// converts 0 to false
$filter = new Zend_Filter_Boolean(Zend_Filter_Boolean::INTEGER);

// converts 0 and '0' to false
$filter = new Zend_Filter_Boolean(
    Zend_Filter_Boolean::INTEGER + Zend_Filter_Boolean::ZERO
);

// converts 0 and '0' to false
$filter = new Zend_Filter_Boolean(array(
    'type' => array(
        Zend_Filter_Boolean::INTEGER,
        Zend_Filter_Boolean::ZERO,
    ),
));

// converts 0 and '0' to false
$filter = new Zend_Filter_Boolean(array(
    'type' => array(
        'integer',
        'zero',
    ),
));

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

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().

$filter = new Zend_Filter_Boolean(array(
    'type'   => Zend_Filter_Boolean::ALL,
    'locale' => 'de',
));

// returns false
echo $filter->filter('nein');

$filter->setLocale('en');

// returns true
$filter->filter('yes');

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

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

$filter = new Zend_Filter_Boolean(array(
    'type'    => Zend_Filter_Boolean::ALL,
    'casting' => false,
));

// returns false
echo $filter->filter(0);

// returns true
echo $filter->filter(1);

// returns the value
echo $filter->filter(2);

Zend_Filter_Callback では、下記のオプションがサポートされます。

このフィルタの使い方はとても簡単です。 文字列を逆にするフィルタを生成したいとしましょう。

$filter = new Zend_Filter_Callback('strrev');

print $filter->filter('Hello!');
// "!olleH"を返します

おわかりのように、自分自身のフィルタを定義するために本当に簡単にコールバックを使えます。 メソッド（それはクラス内で定義されます）をコールバックとして配列を与えることによって使うこともできます。

// クラスの定義
class MyClass
{
    public function Reverse($param);
}

// フィルター定義
$filter = new Zend_Filter_Callback(array('MyClass', 'Reverse'));
print $filter->filter('Hello!');

実際に設定されているコールバックを取得するには getCallback() を使い、 他のコールバックを設定するには setCallback() を使います。

フィルタが実行されるとき、 呼ばれるメソッドに配列として与えられるデフォルト・パラメータを定義できます。 この配列は、フィルターされた値で結合されます。

$filter = new Zend_Filter_Callback(
    array(
        'callback' => 'MyMethod',
        'options'  => array('key' => 'param1', 'key2' => 'param2')
    )
);
$filter->filter(array('value' => 'Hello'));

手動で上記のメソッド定義を呼ぶと、それはこのように見えます:

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

The following options are supported for Zend_Filter_Compress and Zend_Filter_Decompress:

The following compression formats are supported by their own adapter:

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)

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.

$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).

$filter = new Zend_Filter_Compress(array(
    'adapter' => 'Bz2',
    'options' => array(
        'blocksize' => 8,
    ),
));

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

$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.

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

Decompression works the same way.

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

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.

$filter     = new Zend_Filter_Compress(array(
    'adapter' => 'Bz2',
    'options' => array(
        'archive' => 'filename.bz2',
    ),
));
$compressed = $filter->filter('Uncompressed string');
// 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.

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

$filter     = new Zend_Filter_Compress(array(
    'adapter' => 'Bz2',
    'options' => array(
        'archive' => 'filename.bz2'
    ),
));
$compressed = $filter->filter('C:\temp\compressme.txt');
// 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.

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

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.

$filter     = new Zend_Filter_Decompress('Bz2');
$compressed = $filter->filter('filename.bz2');
// 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.

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

The Bz2 Adapter can compress and decompress:

This adapter makes use of PHP's Bz2 extension.

To customize compression, this adapter supports the following options:

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.

The Gz Adapter can compress and decompress:

This adapter makes use of PHP's Zlib extension.

To customize the compression this adapter supports the following options:

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.

The Lzf Adapter can compress and decompress:

This adapter makes use of PHP's Lzf extension.

There are no options available to customize this adapter.

The Rar Adapter can compress and decompress:

This adapter makes use of PHP's Rar extension.

To customize the compression this adapter supports the following options:

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.

The Tar Adapter can compress and decompress:

This adapter makes use of PEAR's Archive_Tar component.

To customize the compression this adapter supports the following options:

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.

The Zip Adapter can compress and decompress:

This adapter makes use of PHP's Zip extension.

To customize the compression this adapter supports the following options:

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.

Zend_Filter_Digits に対する追加オプションはありません。

下記は基本的な使用例です。

$filter = new Zend_Filter_Digits();

print $filter->filter('October 2009');

これは "2009" を返します。

$filter = new Zend_Filter_Digits();

print $filter->filter('HTML 5 for Dummies');

これは "5" を返します。

Zend_Filter_Dir に対する追加オプションはありません。

下記は基本的な使用例です。

$filter = new Zend_Filter_Dir();

print $filter->filter('/etc/passwd');

これは "/etc" を返します。

$filter = new Zend_Filter_Dir();

print $filter->filter('C:/Temp/x');

これは "C:/Temp" を返します。

Zend_Filter_Encrypt および Zend_Filter_Decrypt では、下記のオプションがサポートされます。

これら 2 つの暗号化手法はまったく異なる方式なので、 アダプタの使用法もそれぞれ異なります。 フィルタを初期化する際に、どのアダプタを使うかを選ばなければなりません。

// Mcrypt アダプタを使用します
$filter1 = new Zend_Filter_Encrypt(array('adapter' => 'mcrypt'));

// OpenSSL アダプタを使用します
$filter2 = new Zend_Filter_Encrypt(array('adapter' => 'openssl'));

別のアダプタを設定するために setAdapter() を使用することもできます。また getAdapter() メソッドで、実際に設定されているアダプタを取得できます。

// Mcrypt アダプタを使用します
$filter = new Zend_Filter_Encrypt();
$filter->setAdapter('openssl');

Mcrypt 拡張モジュールをインストールすると、 Mcrypt アダプタが使えるようになります。 もしオプション配列の代わりに文字列を与えると、 文字列がキーとして使われます。

初期化した後で暗号化の値を取得したり設定したりするには、それぞれ getEncryption() および setEncryption() メソッドを使用します。

暗号化ベクトルの取得や設定には、それぞれ getVector() および setVector() を使用可能です。指定した文字列が、 そのアルゴリズムに必要なベクトルのサイズに応じて切り詰められたり伸ばされたりします。

// デフォルト設定の blowfish を使用します
$filter = new Zend_Filter_Encrypt('myencryptionkey');

// 自前のベクトルを設定します。それ以外の場合は getVector()
// をコールしてベクトルを保存しておかないと、後で復号できなくなります
$filter->setVector('myvector');
// $filter->getVector();

$encrypted = $filter->filter('text_to_be_encoded');
print $encrypted;

// 復号の方法は Decrypt フィルタを参照ください

Mcrypt で暗号化したコンテンツを復号するには、 暗号化を行った際に指定したオプションが必要です。

ここでひとつ暗号化時との大きな違いがあります。 暗号化の際にベクトルを指定しなかった場合は、コンテンツを暗号化した後で フィルタの getVector() メソッドを使用してベクトルを取得する必要があります。 正しいベクトルがなければ、コンテンツを復号することはできません。

オプションを指定しさえすれば、復号は暗号化と同じくらい単純なことです。

// デフォルト設定の blowfish を使用します
$filter = new Zend_Filter_Decrypt('myencryptionkey');

// コンテンツの暗号化用ベクトルを設定します
$filter->setVector('myvector');

$decrypted = $filter->filter('encoded_text_normally_unreadable');
print $decrypted;

OpenSSL 拡張モジュールをインストールすると、 OpenSSL アダプタが使えるようになります。 後から公開鍵を取得あるいは設定するには、getPublicKey() および setPublicKey() メソッドを使用します。 秘密鍵についても、getPrivateKey() および setPrivateKey() メソッドで取得あるいは設定できます。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Encrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時に公開鍵を指定することもできます
$filter->setPublicKey(array(
    '/public/key/path/first.pem',
    '/public/key/path/second.pem'
));

鍵自体も暗号化したい場合は、パスフレーズを setPassphrase() メソッドで渡します。 パスフレーズつきで暗号化したコンテンツを復号したい場合は、 公開鍵だけではなく (暗号化された鍵を復号するための) パスフレーズも必要となります。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Encrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時に公開鍵を指定することもできます
$filter->setPublicKey(array(
    '/public/key/path/first.pem',
    '/public/key/path/second.pem'
));
$filter->setPassphrase('mypassphrase');

最後に、OpenSSL を使用した場合に受け手に渡す必要があるものをまとめます。 暗号化されたコンテンツ、パスフレーズを使用した場合はそのパスフレーズ、 そして復号用のエンベロープ鍵。これらが必要となります。

つまり、暗号化を終えたらエンベロープ鍵を取得する必要があるということです。 取得するには getEnvelopeKey() メソッドを使用します。

OpenSSL でコンテンツの暗号化を行う完全な例は、このようになります。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Encrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時に公開鍵を指定することもできます
$filter->setPublicKey(array(
    '/public/key/path/first.pem',
    '/public/key/path/second.pem'
));
$filter->setPassphrase('mypassphrase');

$encrypted = $filter->filter('text_to_be_encoded');
$envelope  = $filter->getEnvelopeKey();
print $encrypted;

// 復号の方法は Decrypt フィルタを参照ください

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Encrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem',
    'public'  => '/public/key/path/public.pem',
    'package' => true
));

$encrypted = $filter->filter('text_to_be_encoded');
print $encrypted;

// 復号の方法は Decrypt フィルタを参照ください

// Use basic compression adapter
$filter1 = new Zend_Filter_Encrypt(array(
    'adapter'     => 'openssl',
    'private'     => '/path/to/mykey/private.pem',
    'public'      => '/public/key/path/public.pem',
    'package'     => true,
    'compression' => 'bz2'
));

// Use basic compression adapter
$filter2 = new Zend_Filter_Encrypt(array(
    'adapter'     => 'openssl',
    'private'     => '/path/to/mykey/private.pem',
    'public'      => '/public/key/path/public.pem',
    'package'     => true,
    'compression' => array('adapter' => 'zip', 'target' => '\usr\tmp\tmp.zip')
));

OpenSSL での復号は、暗号化と同様にシンプルです。 しかし、コンテンツを暗号化した人からすべてのデータを受け取る必要があります。 下記の例をご覧ください。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Decrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時にエンベロープ鍵を指定することもできます
$filter->setEnvelopeKey(array(
    '/key/from/encoder/first.pem',
    '/key/from/encoder/second.pem'
));

オプションで、パスフレーズを渡さなければ鍵を復号できないようにすることもできます。 そのために使用するのが setPassphrase() メソッドです。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Decrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時にエンベロープ鍵を指定することもできます
$filter->setEnvelopeKey(array(
    '/key/from/encoder/first.pem',
    '/key/from/encoder/second.pem'
));
$filter->setPassphrase('mypassphrase');

最後に、コンテンツを復号します。 暗号化したコンテンツの復号を行う完全な例は、このようになります。

// openssl を使用し、秘密鍵を指定します
$filter = new Zend_Filter_Decrypt(array(
    'adapter' => 'openssl',
    'private' => '/path/to/mykey/private.pem'
));

// もちろん、初期化時にエンベロープ鍵を指定することもできます
$filter->setEnvelopeKey(array(
    '/key/from/encoder/first.pem',
    '/key/from/encoder/second.pem'
));
$filter->setPassphrase('mypassphrase');

$decrypted = $filter->filter('encoded_text_normally_unreadable');
print $decrypted;

The following options are supported for Zend_Filter_HtmlEntities:

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

$filter = new Zend_Filter_HtmlEntities();

print $filter->filter('<');

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:

$filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_QUOTES));

$input  = "A 'single' and " . '"double"';
print $filter->filter($input);

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

$filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_COMPAT));

$input  = "A 'single' and " . '"double"';
print $filter->filter($input);

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

$filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_NOQUOTES));

$input  = "A 'single' and " . '"double"';
print $filter->filter($input);

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

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

$filter = new Zend_Filter_HtmlEntities();

$filter->setQuoteStyle(ENT_QUOTES);
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.

$filter = new Zend_Filter_HtmlEntities();

$filter->setQuoteStyle(ENT_QUOTES);
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.

$filter = new Zend_Filter_HtmlEntities();

$filter->setQuoteStyle(ENT_QUOTES);
print $filter->getQuoteStyle(ENT_QUOTES);

Zend_Filter_Int に対する追加オプションはありません。

下記は基本的な使用例です。

$filter = new Zend_Filter_Int();

print $filter->filter('-4 is less than 0');

これは '-4' を返します。

Zend_Filter_LocalizedToNormalized および Zend_Filter_NormalizedToLocalized では、下記のオプションがサポートされます。

正規化により、ユーザーがユーザー固有の言語表記で情報を入力でき、 さらに例えば正規化された値をデータベースに保存できるようになります。 一方で地域化により、 保管された正規化された値をローカルな流儀でユーザーに提示できるようになります。

下記の入力型が正規化および地域化されます。

その他の入力はいずれも変更無しにそのまま返されます。

整数、フロートまたは実数のようなあらゆる数が正規化されます。 指数表記の数値は、実はこのフィルタで扱えないので注意してください。

数値についての詳しい正規化方法

//フィルタ初期化
$filter = new Zend_Filter_LocalizedToNormalized();
$filter->filter('123.456,78');
//値 '123456.78' を返します。

アプリケーション全体のロケールとしてロケール 'de' を設定したつもりになりましょう。 Zend_Filter_LocalizedToNormalizedは設定されたロケールを受け取って、 どの種類の入力をあなたが与えたか検出するために、それを使います。 われわれの例ではそれは精度を持つ値でした。 そこで、この値を文字列として正規化した表現をフィルタは返します。

正規化した数がどのようになるべきか、コントロールすることもできます。 このためにZend_Locale_Formatでも使用されるオプションを 全て与えられます。利用可能なオプションについて詳しくは、この Zend_Locale の章をご覧ください。

下記はオプションの動作方法が分かるように精度を定義した例です。

//数値フィルタ
$filter = new Zend_Filter_LocalizedToNormalized(array('precision' => 2));

$filter->filter('123.456');
//値 '123456.00' を返します。

$filter->filter('123.456,78901');
//値 '123456.79' を返します。

日付や時刻の値の入力もまた、正規化できます。 与えられた日付および時刻は全て、独自のキーの範囲内で日付の各部分が与えられた 配列として返されます。

//フィルタ初期化
$filter = new Zend_Filter_LocalizedToNormalized();
$filter->filter('12.April.2009');
// array('day' => '12', 'month' => '04', 'year' => '2009') を返します。

ふたたびロケール 'de' を設定したつもりになりましょう。 そこで、入力は自動的に日付として検出され、 返り値に連想配列を受け取ります。

もちろん、日付の入力値をどのようにするか date_formatやlocaleオプションで コントロールすることもできます。

//日付フィルタ
$filter = new Zend_Filter_LocalizedToNormalized(
    array('date_format' => 'ss:mm:HH')
);

$filter->filter('11:22:33');
// array('hour' => '33', 'minute' => '22', 'second' => '11') を返します。

整数、フロートまたは実数のようなあらゆる数が地域化されます。 指数表記の数値は、実はこのフィルタで扱えないので注意してください。

数値についての詳しい地域化方法

//フィルタを初期化
$filter = new Zend_Filter_NormalizedToLocalized();
$filter->filter(123456.78);
//値 '123.456,78' を返します。

アプリケーション全体のロケールとしてロケール 'de' を設定したつもりになりましょう。 Zend_Filter_NormalizedToLocalizedは設定されたロケールを受け取って、 どの種類の出力をあなたが受け取りたいのか検出するために、それを使います。 われわれの例ではそれは精度を持つ値でした。 そこで、この値を文字列として地域化した表現をフィルタは返します。

地域化した数がどのようになるべきか、コントロールすることもできます。 このためにZend_Locale_Formatでも使用されるオプションを 全て与えられます。 これらのオプションの使い方について詳しくは、この Zend_Locale の章 をご覧ください。

下記はオプションの動作方法が分かるように精度を定義した例です。

//数値フィルタ
$filter = new Zend_Filter_NormalizedToLocalized(array('precision' => 2));

$filter->filter(123456);
//値 '123.456,00' を返します。

$filter->filter(123456.78901);
//値 '123.456,79' を返します。

日付や時刻の値を正規化したものもまた、地域化できます。 与えられた日付および時刻は全て、設定されたロケールで定義された形式で 文字列として返されます。

//フィルタを初期化
$filter = new Zend_Filter_NormalizedToLocalized();
$filter->filter(array('day' => '12', 'month' => '04', 'year' => '2009');
// '12.04.2009' を返します。

ふたたびロケール 'de' を設定したつもりになりましょう。 そこで、入力は自動的に日付として検出され、 ロケール 'de' で定義された形式で返されます。

もちろん、日付の入力値をどのようにするか date_formatやlocaleオプションで コントロールすることもできます。

//日付フィルタ
$filter = new Zend_Filter_LocalizedToNormalized(
    array('date_format' => 'ss:mm:HH')
);

$filter->filter(array('hour' => '33', 'minute' => '22', 'second' => '11'));
// '11:22:33' を返します。

Zend_Filter_Null では、下記のオプションがサポートされます。

デフォルトではこのフィルタはPHPの empty()メソッドのように動作します。 言い換えると、もしempty()がブールの TRUE を返す場合、 NULL値が返されます。

$filter = new Zend_Filter_Null();
$value  = '';
$result = $filter->filter($value);
// 空文字列の代わりに null を返します

これは、何の設定もなしに、 Zend_Filter_Nullは全ての入力を受け付けて、 empty()と同じ場合に NULLを返すことを意味します。

他の値ではいずれも変更無しにそのまま返されます。

しばしば、empty()に基づくフィルタでは十分ではありません。 そのため、Zend_Filter_Nullでは、 いずれのタイプが変換されるか否か設定できます。

下記のタイプが操作できます。

上記のタイプのうちのいずれをフィルタするかを選択する方法が、いくつかあります。 １つまたは複数のタイプを与えて、それに追加できます。 配列を与えたり、定数を使えます。 または、原文の文字列を与えられます。 下記の例をご覧ください。

// false を null に変換
$filter = new Zend_Filter_Null(Zend_Filter_Null::BOOLEAN);

// false 及び 0 を null に変換
$filter = new Zend_Filter_Null(
    Zend_Filter_Null::BOOLEAN + Zend_Filter_Null::INTEGER
);

// false 及び 0 を null に変換
$filter = new Zend_Filter_Null( array(
    Zend_Filter_Null::BOOLEAN,
    Zend_Filter_Null::INTEGER
));

// false 及び 0 を null に変換
$filter = new Zend_Filter_Null(array(
    'boolean',
    'integer',
));

希望のタイプをセットするために、 Zend_Config のインスタンスを与えることもできます。 タイプをセットするには、後で setType() を使います。

The following options are supported for Zend_Filter_PregReplace:

To use this filter properly you must give two options:

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.

$filter = new Zend_Filter_PregReplace(array('match' => '/bob/',
                                            'replace' => 'john'));
$input  = 'Hy bob!';

$filter->filter($input);
// 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().

$filter = new Zend_Filter_PregReplace();
$filter->setMatchPattern(array('bob', 'Hy'))
       ->setReplacement(array('john', 'Bye'));
$input  = 'Hy bob!";

$filter->filter($input);
// returns 'Bye john!'

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

Zend_Filter_RealPath では、下記のオプションがサポートされます。

与えられたパス名のリンク全てで完全パスが返されます。 '/./' や '/../' への参照、 及び、入力パスの余分な '/' 記号は取り除かれます。 結果のパスにはいかなるシンボリックリンクも無く、 '/./' や '/../' 文字もありません。

たとえばファイルが存在しない場合、 Zend_Filter_RealPathは失敗するとFALSEを返します。 もし最後のパスのコンポーネントだけが存在しない場合、 BSD システムではZend_Filter_RealPathは失敗しますが、 他のシステムではFALSEを返します。

$filter = new Zend_Filter_RealPath();
$path   = '/www/var/path/../../mypath';
$filtered = $filter->filter($path);

// '/www/mypath' を返します。

それらが存在しないとき、 たとえば、生成したいパスのために実際のパスを取得したいとき、 パスを得るためにしばしば役に立ちます。 初期化でFALSEを渡すこともできますし、 それを設定するためにsetExists()を使うこともできます。

$filter = new Zend_Filter_RealPath(false);
$path   = '/www/var/path/../../non/existing/path';
$filtered = $filter->filter($path);

// file_exists または realpath が false を返すときでも
// '/www/non/existing/path' を返します。

Zend_Filter_StringToLower では、下記のオプションがサポートされます。

これは基本的な例です。

$filter = new Zend_Filter_StringToLower();

print $filter->filter('SAMPLE');
// "sample" を返します

デフォルトでは、それはサーバの現時点のロケールで、文字を取り扱うだけです。 他のcharset由来の文字は、無視されます。 さらに、mbstring拡張が環境で利用できるとき、 それらを小文字にすることもできます。 StringToLowerフィルタを初期化するときは、 希望のエンコーディングを設定するだけです。 または、後でエンコーディングを変更するために、 setEncoding()メソッドを使います。

// UTF-8 を使用
$filter = new Zend_Filter_StringToLower('UTF-8');

//または、構成を使うときに、役に立つことがありえる配列を与えます
$filter = new Zend_Filter_StringToLower(array('encoding' => 'UTF-8'));

//または後でこのようにします
$filter->setEncoding('ISO-8859-1');

Zend_Filter_StringToUpper では、下記のオプションがサポートされます。

これは、StringToUpper フィルタを使用する基本的な例です。

$filter = new Zend_Filter_StringToUpper();

print $filter->filter('Sample');
// "SAMPLE" を返します

StringToLowerフィルタの様に、 このフィルタは、サーバの現時点のロケール由来の文字だけを処理します。 StringToLowerと同様に、 異なる文字セットを使っても動作します。

$filter = new Zend_Filter_StringToUpper(array('encoding' => 'UTF-8'));

//または後でこのようにします
$filter->setEncoding('ISO-8859-1');

The following options are supported for Zend_Filter_StringTrim:

A basic example of usage is below:

$filter = new Zend_Filter_StringTrim();

print $filter->filter(' This is (my) content: ');

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

$filter = new Zend_Filter_StringTrim(':');
// or new Zend_Filter_StringTrim(array('charlist' => ':'));

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.

Zend_Filter_StripNewLines に対する追加オプションはありません。

下記は基本的な使用例です。

$filter = new Zend_Filter_StripNewLines();

print $filter->filter("This is (my)\n\rcontent: ');

上記の例では 'This is (my) content:' を返します。 改行文字が全て削除されたことに注意してください。

The following options are supported for Zend_Filter_StripTags:

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

$filter = new Zend_Filter_StripTags();

print $filter->filter('<B>My content</B>');

As result you will get the stripped content 'My content'.

When the content contains broken or partitial tags then the complete following content will be erased. See the following example:

$filter = new Zend_Filter_StripTags();

print $filter->filter('This contains <a href="http://example.com">no ending tag');

The above will return 'This contains' with the rest being stripped.

Zend_Filter_StripTags allows stripping of all but defined tags. This can be used for example to strip all tags but links from a text.

$filter = new Zend_Filter_StripTags(array('allowTags' => 'a'));

$input  = "A text with <br/> a <a href='link.com'>link</a>";
print $filter->filter($input);
// returns: A text with a <a href='link.com'>link</a>

The above example strips all tags but the link. By providing an array you can set multiple tags at once.

It is also possible to strip all but allowed attributes from a tag.

$filter = new Zend_Filter_StripTags(array('allowAttribs' => 'src'));

$input  = "A text with <br/> a <img src='picture.com' width='100'>picture</img>";
print $filter->filter($input);
// returns: A text with a <img src='picture.com'>picture</img>

The above example strips all tags but img. Additionally from the img tag all attributes but src will be stripped. By providing an array you can set multiple attributes at once.