Merge pull request zendframework/zendframework#4650 from neeckeloo/fi…

…x-filter-doc-blocks Some doc block fixes
zendframework · Jun 28, 2013 · 6bd4bd0 · 6bd4bd0
commit 6bd4bd0
Show file tree

Hide file tree

Showing 31 changed files with 121 additions and 115 deletions.
diff --git a/src/AbstractFilter.php b/src/AbstractFilter.php
@@ -32,7 +32,7 @@ public static function hasPcreUnicodeSupport()
 
     /**
      * @param  array|Traversable $options
-     * @return AbstractFilter
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setOptions($options)
@@ -86,7 +86,6 @@ public function __invoke($value)
     }
 
     /**
-     *
      * @param  mixed $options
      * @return bool
      */

diff --git a/src/AbstractUnicode.php b/src/AbstractUnicode.php
@@ -15,7 +15,7 @@ abstract class AbstractUnicode extends AbstractFilter
      * Set the input encoding for the given string
      *
      * @param  string|null $encoding
-     * @return StringToLower
+     * @return self
      * @throws Exception\InvalidArgumentException
      * @throws Exception\ExtensionNotLoadedException
      */

diff --git a/src/Boolean.php b/src/Boolean.php
@@ -90,7 +90,7 @@ public function __construct($typeOrOptions = null, $casting = true, $translation
      *
      * @param  int|array $type
      * @throws Exception\InvalidArgumentException
-     * @return bool
+     * @return self
      */
     public function setType($type = null)
     {
@@ -137,7 +137,7 @@ public function getType()
      * @param  bool $flag When true this filter works like cast
      *                       When false it recognises only true and false
      *                       and all other values are returned as is
-     * @return bool
+     * @return self
      */
     public function setCasting($flag = true)
     {
@@ -158,7 +158,7 @@ public function getCasting()
     /**
      * @param  array|Traversable $translations
      * @throws Exception\InvalidArgumentException
-     * @return bool
+     * @return self
      */
     public function setTranslations($translations)
     {

diff --git a/src/Callback.php b/src/Callback.php
@@ -68,7 +68,7 @@ public function getCallback()
      * Sets parameters for the callback
      *
      * @param  mixed $params
-     * @return Callback
+     * @return self
      */
     public function setCallbackParams($params)
     {
@@ -79,7 +79,7 @@ public function setCallbackParams($params)
     /**
      * Get parameters for the callback
      *
-     * @return mixed
+     * @return array
      */
     public function getCallbackParams()
     {

diff --git a/src/Compress.php b/src/Compress.php
@@ -51,7 +51,7 @@ public function __construct($options = null)
      *
      * @param  array $options
      * @throws Exception\InvalidArgumentException if options is not an array or Traversable
-     * @return Compress
+     * @return self
      */
     public function setOptions($options)
     {
@@ -122,7 +122,7 @@ public function getAdapterName()
      * Sets compression adapter
      *
      * @param  string|Compress\CompressionAlgorithmInterface $adapter Adapter to use
-     * @return Compress
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setAdapter($adapter)
@@ -153,7 +153,7 @@ public function getAdapterOptions()
      * Set adapter options
      *
      * @param  array $options
-     * @return Compress
+     * @return self
      */
     public function setAdapterOptions(array $options)
     {

diff --git a/src/Compress/AbstractCompressionAlgorithm.php b/src/Compress/AbstractCompressionAlgorithm.php
@@ -61,7 +61,7 @@ public function getOptions($option = null)
      * Sets all or one option
      *
      * @param  array $options
-     * @return AbstractCompressionAlgorithm
+     * @return self
      */
     public function setOptions(array $options)
     {

diff --git a/src/Compress/Bz2.php b/src/Compress/Bz2.php
@@ -59,7 +59,7 @@ public function getBlocksize()
      *
      * @param  int $blocksize
      * @throws Exception\InvalidArgumentException
-     * @return Bz2
+     * @return self
      */
     public function setBlocksize($blocksize)
     {
@@ -85,7 +85,7 @@ public function getArchive()
      * Sets the archive to use for de-/compression
      *
      * @param  string $archive Archive to use
-     * @return Bz2
+     * @return self
      */
     public function setArchive($archive)
     {

diff --git a/src/Compress/Gz.php b/src/Compress/Gz.php
@@ -61,7 +61,7 @@ public function getLevel()
      *
      * @param int $level
      * @throws Exception\InvalidArgumentException
-     * @return Gz
+     * @return self
      */
     public function setLevel($level)
     {
@@ -87,7 +87,7 @@ public function getMode()
      * Sets a new compression mode
      *
      * @param  string $mode Supported are 'compress', 'deflate' and 'file'
-     * @return Gz
+     * @return self
      * @throws Exception\InvalidArgumentException for invalid $mode value
      */
     public function setMode($mode)
@@ -114,7 +114,7 @@ public function getArchive()
      * Sets the archive to use for de-/compression
      *
      * @param  string $archive Archive to use
-     * @return Gz
+     * @return self
      */
     public function setArchive($archive)
     {

diff --git a/src/Compress/Rar.php b/src/Compress/Rar.php
@@ -62,7 +62,7 @@ public function getCallback()
      * Sets the callback to use
      *
      * @param  string $callback
-     * @return Rar
+     * @return self
      * @throws Exception\InvalidArgumentException if invalid callback provided
      */
     public function setCallback($callback)
@@ -89,7 +89,7 @@ public function getArchive()
      * Sets the archive to use for de-/compression
      *
      * @param  string $archive Archive to use
-     * @return Rar
+     * @return self
      */
     public function setArchive($archive)
     {
@@ -113,7 +113,7 @@ public function getPassword()
      * Sets the password to use
      *
      * @param  string $password
-     * @return Rar
+     * @return self
      */
     public function setPassword($password)
     {
@@ -135,7 +135,7 @@ public function getTarget()
      * Sets the targetpath to use
      *
      * @param  string $target
-     * @return Rar
+     * @return self
      * @throws Exception\InvalidArgumentException if specified target directory does not exist
      */
     public function setTarget($target)

diff --git a/src/Compress/Tar.php b/src/Compress/Tar.php
@@ -65,7 +65,7 @@ public function getArchive()
      * Sets the archive to use for de-/compression
      *
      * @param  string $archive Archive to use
-     * @return Tar
+     * @return self
      */
     public function setArchive($archive)
     {
@@ -89,7 +89,7 @@ public function getTarget()
      * Sets the target path to use
      *
      * @param  string $target
-     * @return Tar
+     * @return self
      * @throws Exception\InvalidArgumentException if target path does not exist
      */
     public function setTarget($target)
@@ -119,7 +119,7 @@ public function getMode()
      * Either Gz or Bz2.
      *
      * @param string $mode
-     * @return Tar
+     * @return self
      * @throws Exception\InvalidArgumentException for invalid $mode values
      * @throws Exception\ExtensionNotLoadedException if bz2 mode selected but extension not loaded
      * @throws Exception\ExtensionNotLoadedException if gz mode selected but extension not loaded

diff --git a/src/Compress/Zip.php b/src/Compress/Zip.php
@@ -60,7 +60,7 @@ public function getArchive()
      * Sets the archive to use for de-/compression
      *
      * @param  string $archive Archive to use
-     * @return Zip
+     * @return self
      */
     public function setArchive($archive)
     {
@@ -85,7 +85,7 @@ public function getTarget()
      *
      * @param  string $target
      * @throws Exception\InvalidArgumentException
-     * @return Zip
+     * @return self
      */
     public function setTarget($target)
     {

diff --git a/src/DateTimeFormatter.php b/src/DateTimeFormatter.php
@@ -36,7 +36,7 @@ public function __construct($options = null)
      * Set the format string accepted by date() to use when formatting a string
      *
      * @param  string $format
-     * @return \Zend\Filter\DateTimeFormatter
+     * @return self
      */
     public function setFormat($format)
     {
@@ -66,8 +66,8 @@ public function filter($value)
     /**
      * Normalize the provided value to a formatted string
      *
-     * @param string|int|DateTime $value
-     * @returns string
+     * @param  string|int|DateTime $value
+     * @return string
      */
     protected function normalizeDateTime($value)
     {

diff --git a/src/Encrypt.php b/src/Encrypt.php
@@ -50,7 +50,7 @@ public function getAdapter()
      * Sets new encryption options
      *
      * @param  string|array $options (Optional) Encryption options
-     * @return Encrypt
+     * @return self
      * @throws Exception\DomainException
      * @throws Exception\InvalidArgumentException
      */

diff --git a/src/Encrypt/BlockCipher.php b/src/Encrypt/BlockCipher.php
@@ -98,7 +98,7 @@ public function getEncryption()
      * Sets new encryption options
      *
      * @param  string|array $options Encryption options
-     * @return BlockCipher
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setEncryption($options)
@@ -162,7 +162,7 @@ public function getVector()
      * Set the inizialization vector
      *
      * @param  string $vector
-     * @return BlockCipher
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setVector($vector)
@@ -180,7 +180,7 @@ public function setVector($vector)
      * Set the encryption key
      *
      * @param  string $key
-     * @return BlockCipher
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setKey($key)
@@ -218,7 +218,7 @@ public function getCompression()
      * Sets a internal compression for values to encrypt
      *
      * @param  string|array $compression
-     * @return BlockCipher
+     * @return self
      */
     public function setCompression($compression)
     {

diff --git a/src/Encrypt/Openssl.php b/src/Encrypt/Openssl.php
@@ -104,7 +104,7 @@ public function __construct($options = array())
      * Sets the encryption keys
      *
      * @param  string|array $keys Key with type association
-     * @return Openssl
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     protected function _setKeys($keys)
@@ -168,7 +168,7 @@ public function getPublicKey()
      * Sets public keys
      *
      * @param  string|array $key Public keys
-     * @return \Zend\Filter\Encrypt\Openssl
+     * @return self
      */
     public function setPublicKey($key)
     {
@@ -202,7 +202,7 @@ public function getPrivateKey()
      *
      * @param  string $key Private key
      * @param  string $passphrase
-     * @return Openssl
+     * @return self
      */
     public function setPrivateKey($key, $passphrase = null)
     {
@@ -239,7 +239,7 @@ public function getEnvelopeKey()
      * Sets envelope keys
      *
      * @param  string|array $key Envelope keys
-     * @return \Zend\Filter\Encrypt\Openssl
+     * @return self
      */
     public function setEnvelopeKey($key)
     {
@@ -271,7 +271,7 @@ public function getPassphrase()
      * Sets a new passphrase
      *
      * @param string $passphrase
-     * @return Openssl
+     * @return self
      */
     public function setPassphrase($passphrase)
     {
@@ -293,7 +293,7 @@ public function getCompression()
      * Sets a internal compression for values to encrypt
      *
      * @param string|array $compression
-     * @return Openssl
+     * @return self
      */
     public function setCompression($compression)
     {
@@ -319,7 +319,7 @@ public function getPackage()
      * Sets if the envelope keys should be included in the encrypted value
      *
      * @param  bool $package
-     * @return Openssl
+     * @return self
      */
     public function setPackage($package)
     {

diff --git a/src/File/Decrypt.php b/src/File/Decrypt.php
@@ -38,7 +38,7 @@ public function getFilename()
      * Sets the new filename where the content will be stored
      *
      * @param  string $filename (Optional) New filename to set
-     * @return Decrypt
+     * @return self
      */
     public function setFilename($filename = null)
     {

diff --git a/src/File/Encrypt.php b/src/File/Encrypt.php
@@ -38,7 +38,7 @@ public function getFilename()
      * Sets the new filename where the content will be stored
      *
      * @param  string $filename (Optional) New filename to set
-     * @return Encrypt
+     * @return self
      */
     public function setFilename($filename = null)
     {

diff --git a/src/File/Rename.php b/src/File/Rename.php
@@ -69,7 +69,7 @@ public function getFile()
      * 'randomize' => Shall target files have a random postfix attached?
      *
      * @param  string|array $options Old file or directory to be rewritten
-     * @return \Zend\Filter\File\Rename
+     * @return self
      */
     public function setFile($options)
     {