Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Commit

Permalink
Merge branch 'feature/phpdoc-mismatch' of https://github.com/micheh/zf2
Browse files Browse the repository at this point in the history
… into hotfix/phpdoc
  • Loading branch information
Show file tree
Hide file tree
Showing 20 changed files with 31 additions and 15 deletions.
1 change: 1 addition & 0 deletions src/Boolean.php
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ public function getCasting()

/**
* @param array|Traversable $translations
* @throws Exception\InvalidArgumentException
* @return Boolean
*/
public function setTranslations($translations)
Expand Down
6 changes: 4 additions & 2 deletions src/Callback.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class Callback extends AbstractFilter
);

/**
* @param array|Traversable $options
* @param callable|array|Traversable $callbackOrOptions
* @param array $callbackParams
*/
public function __construct($callbackOrOptions, $callbackParams = array())
{
Expand All @@ -43,7 +44,8 @@ public function __construct($callbackOrOptions, $callbackParams = array())
* Sets a new callback for this filter
*
* @param callable $callback
* @return Callback
* @throws Exception\InvalidArgumentException
* @return self
*/
public function setCallback($callback)
{
Expand Down
4 changes: 3 additions & 1 deletion src/Compress.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ public function __construct($options = null)
* Set filter setate
*
* @param array $options
* @throws Exception\InvalidArgumentException if options is not an array or Traversable
* @return Compress
*/
public function setOptions($options)
Expand Down Expand Up @@ -81,8 +82,9 @@ public function setOptions($options)
/**
* Returns the current adapter, instantiating it if necessary
*
* @return string
* @throws Exception\RuntimeException
* @throws Exception\InvalidArgumentException
* @return Compress\CompressionAlgorithmInterface
*/
public function getAdapter()
{
Expand Down
4 changes: 3 additions & 1 deletion src/Compress/Bz2.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class Bz2 extends AbstractCompressionAlgorithm
* Class constructor
*
* @param null|array|\Traversable $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if bz2 extension not loaded
*/
public function __construct($options = null)
{
Expand All @@ -60,7 +61,8 @@ public function getBlocksize()
/**
* Sets a new blocksize
*
* @param integer $level
* @param integer $blocksize
* @throws Exception\InvalidArgumentException
* @return Bz2
*/
public function setBlocksize($blocksize)
Expand Down
2 changes: 2 additions & 0 deletions src/Compress/Gz.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class Gz extends AbstractCompressionAlgorithm
* Class constructor
*
* @param null|array|\Traversable $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if zlib extension not loaded
*/
public function __construct($options = null)
{
Expand All @@ -63,6 +64,7 @@ public function getLevel()
* Sets a new compression level
*
* @param integer $level
* @throws Exception\InvalidArgumentException
* @return Gz
*/
public function setLevel($level)
Expand Down
1 change: 1 addition & 0 deletions src/Compress/Rar.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class Rar extends AbstractCompressionAlgorithm
* Class constructor
*
* @param array $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if rar extension not loaded
*/
public function __construct($options = null)
{
Expand Down
1 change: 1 addition & 0 deletions src/Compress/Tar.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class Tar extends AbstractCompressionAlgorithm
* Class constructor
*
* @param array $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if Archive_Tar component not available
*/
public function __construct($options = null)
{
Expand Down
2 changes: 2 additions & 0 deletions src/Compress/Zip.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class Zip extends AbstractCompressionAlgorithm
* Class constructor
*
* @param null|array|\Traversable $options (Optional) Options to set
* @throws Exception\ExtensionNotLoadedException if zip extension not loaded
*/
public function __construct($options = null)
{
Expand Down Expand Up @@ -87,6 +88,7 @@ public function getTarget()
* Sets the target to use
*
* @param string $target
* @throws Exception\InvalidArgumentException
* @return Zip
*/
public function setTarget($target)
Expand Down
1 change: 1 addition & 0 deletions src/Encrypt.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ public function getAdapter()
*
* @param string|array $options (Optional) Encryption options
* @return Encrypt
* @throws Exception\DomainException
* @throws Exception\InvalidArgumentException
*/
public function setAdapter($options = null)
Expand Down
1 change: 1 addition & 0 deletions src/Encrypt/BlockCipher.php
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ public function setCompression($compression)
* Encrypts $value with the defined settings
*
* @param string $value The content to encrypt
* @throws Exception\InvalidArgumentException
* @return string The encrypted content
*/
public function encrypt($value)
Expand Down
2 changes: 1 addition & 1 deletion src/Encrypt/Openssl.php
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ public function getEnvelopeKey()
/**
* Sets envelope keys
*
* @param string|array $options Envelope keys
* @param string|array $key Envelope keys
* @return \Zend\Filter\Encrypt\Openssl
*/
public function setEnvelopeKey($key)
Expand Down
3 changes: 2 additions & 1 deletion src/FilterChain.php
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public function setPluginManager(FilterPluginManager $plugins)
*
* @param mixed $name
* @param array $options
* @return Filter
* @return FilterInterface
*/
public function plugin($name, array $options = array())
{
Expand All @@ -141,6 +141,7 @@ public function plugin($name, array $options = array())
*
* @param callable|FilterInterface $callback A Filter implementation or valid PHP callback
* @param int $priority Priority at which to enqueue filter; defaults to 1000 (higher executes earlier)
* @throws Exception\InvalidArgumentException
* @return FilterChain
*/
public function attach($callback, $priority = self::DEFAULT_PRIORITY)
Expand Down
3 changes: 2 additions & 1 deletion src/Inflector.php
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public function setOptions($options)
* Set Whether or not the inflector should throw an exception when a replacement
* identifier is still found within an inflected target.
*
* @param bool $throwTargetExceptions
* @param bool $throwTargetExceptionsOn
* @return Inflector
*/
public function setThrowTargetExceptionsOn($throwTargetExceptionsOn)
Expand Down Expand Up @@ -407,6 +407,7 @@ public function setStaticRuleReference($name, &$reference)
* Inflect
*
* @param string|array $source
* @throws Exception\RuntimeException
* @return string
*/
public function filter($source)
Expand Down
2 changes: 1 addition & 1 deletion src/Null.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Null extends AbstractFilter
/**
* Constructor
*
* @param string|array|Traversable $options OPTIONAL
* @param string|array|Traversable $typeOrOptions OPTIONAL
*/
public function __construct($typeOrOptions = null)
{
Expand Down
3 changes: 2 additions & 1 deletion src/RealPath.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

namespace Zend\Filter;

use Traversable;
use Zend\Stdlib\ErrorHandler;

/**
Expand All @@ -28,7 +29,7 @@ class RealPath extends AbstractFilter
/**
* Class constructor
*
* @param boolean|\Traversable $options Options to set
* @param boolean|Traversable $existsOrOptions Options to set
*/
public function __construct($existsOrOptions = true)
{
Expand Down
2 changes: 1 addition & 1 deletion src/StringToLower.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class StringToLower extends AbstractUnicode
/**
* Constructor
*
* @param string|array|Traversable $options OPTIONAL
* @param string|array|Traversable $encodingOrOptions OPTIONAL
*/
public function __construct($encodingOrOptions = null)
{
Expand Down
2 changes: 1 addition & 1 deletion src/StringToUpper.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class StringToUpper extends AbstractUnicode
/**
* Constructor
*
* @param string|array|Traversable $options OPTIONAL
* @param string|array|Traversable $encodingOrOptions OPTIONAL
*/
public function __construct($encodingOrOptions = null)
{
Expand Down
2 changes: 1 addition & 1 deletion src/StringTrim.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class StringTrim extends AbstractFilter
/**
* Sets filter options
*
* @param string|array|Traversable $options
* @param string|array|Traversable $charlistOrOptions
*/
public function __construct($charlistOrOptions = null)
{
Expand Down
2 changes: 0 additions & 2 deletions src/Word/DashToUnderscore.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ class DashToUnderscore extends SeparatorToSeparator
{
/**
* Constructor
*
* @param string $separator Space by default
*/
public function __construct()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Word/UnderscoreToSeparator.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class UnderscoreToSeparator extends SeparatorToSeparator
/**
* Constructor
*
* @param string $separator Space by default
* @param string $replacementSeparator Space by default
*/
public function __construct($replacementSeparator = ' ')
{
Expand Down

0 comments on commit 32beb38

Please sign in to comment.