Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Applied fixes from StyleCI #768

Merged
merged 1 commit into from
Aug 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Binary/MimeTypeGuesserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ interface MimeTypeGuesserInterface
/**
* @param string $binary The image binary
*
* @return string|null mime type or null if it could be not be guessed.
* @return string|null mime type or null if it could be not be guessed
*/
public function guess($binary);
}
10 changes: 5 additions & 5 deletions Imagine/Cache/CacheManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ public function addResolver($filter, ResolverInterface $resolver)
*
* @return ResolverInterface
*
* @throws \OutOfBoundsException If neither a specific nor a default resolver is available.
* @throws \OutOfBoundsException If neither a specific nor a default resolver is available
*/
protected function getResolver($filter, $resolver)
{
Expand Down Expand Up @@ -120,7 +120,7 @@ protected function getResolver($filter, $resolver)
* Gets filtered path for rendering in the browser.
* It could be the cached one or an url of filter action.
*
* @param string $path The path where the resolved file is expected.
* @param string $path The path where the resolved file is expected
* @param string $filter
* @param array $runtimeConfig
* @param string $resolver
Expand Down Expand Up @@ -160,8 +160,8 @@ public function getRuntimePath($path, array $runtimeConfig)
/**
* Returns a web accessible URL.
*
* @param string $path The path where the resolved file is expected.
* @param string $filter The name of the imagine filter in effect.
* @param string $path The path where the resolved file is expected
* @param string $filter The name of the imagine filter in effect
* @param array $runtimeConfig
* @param string $resolver
*
Expand Down Expand Up @@ -211,7 +211,7 @@ public function isStored($path, $filter, $resolver = null)
* @param string $filter
* @param string $resolver
*
* @return string The url of resolved image.
* @return string The url of resolved image
*
* @throws NotFoundHttpException if the path can not be resolved
*/
Expand Down
4 changes: 2 additions & 2 deletions Imagine/Cache/Resolver/AbstractFilesystemResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ protected function makeFolder($dir)
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*
* @param string $path The resource path to convert.
* @param string $filter The name of the imagine filter.
* @param string $path The resource path to convert
* @param string $filter The name of the imagine filter
*
* @return string
*/
Expand Down
18 changes: 9 additions & 9 deletions Imagine/Cache/Resolver/AmazonS3Resolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ class AmazonS3Resolver implements ResolverInterface
/**
* Constructs a cache resolver storing images on Amazon S3.
*
* @param \AmazonS3 $storage The Amazon S3 storage API. It's required to know authentication information.
* @param string $bucket The bucket name to operate on.
* @param \AmazonS3 $storage The Amazon S3 storage API. It's required to know authentication information
* @param string $bucket The bucket name to operate on
* @param string $acl The ACL to use when storing new objects. Default: owner read/write, public read
* @param array $objUrlOptions A list of options to be passed when retrieving the object url from Amazon S3.
* @param array $objUrlOptions A list of options to be passed when retrieving the object url from Amazon S3
*/
public function __construct(\AmazonS3 $storage, $bucket, $acl = \AmazonS3::ACL_PUBLIC, array $objUrlOptions = array())
{
Expand Down Expand Up @@ -141,10 +141,10 @@ public function remove(array $paths, array $filters)
*
* If the option is already set, it will be overwritten.
*
* @see \AmazonS3::get_object_url() for available options.
* @see \AmazonS3::get_object_url() for available options
*
* @param string $key The name of the option.
* @param mixed $value The value to be set.
* @param string $key The name of the option
* @param mixed $value The value to be set
*
* @return AmazonS3Resolver $this
*/
Expand All @@ -158,10 +158,10 @@ public function setObjectUrlOption($key, $value)
/**
* Returns the object path within the bucket.
*
* @param string $path The base path of the resource.
* @param string $filter The name of the imagine filter in effect.
* @param string $path The base path of the resource
* @param string $filter The name of the imagine filter in effect
*
* @return string The path of the object on S3.
* @return string The path of the object on S3
*/
protected function getObjectPath($path, $filter)
{
Expand Down
32 changes: 16 additions & 16 deletions Imagine/Cache/Resolver/AwsS3Resolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ class AwsS3Resolver implements ResolverInterface
/**
* Constructs a cache resolver storing images on Amazon S3.
*
* @param S3Client $storage The Amazon S3 storage API. It's required to know authentication information.
* @param string $bucket The bucket name to operate on.
* @param S3Client $storage The Amazon S3 storage API. It's required to know authentication information
* @param string $bucket The bucket name to operate on
* @param string $acl The ACL to use when storing new objects. Default: owner read/write, public read
* @param array $getOptions A list of options to be passed when retrieving the object url from Amazon S3.
* @param array $putOptions A list of options to be passed when saving the object to Amazon S3.
* @param array $getOptions A list of options to be passed when retrieving the object url from Amazon S3
* @param array $putOptions A list of options to be passed when saving the object to Amazon S3
*/
public function __construct(S3Client $storage, $bucket, $acl = 'public-read', array $getOptions = array(), $putOptions = array())
{
Expand Down Expand Up @@ -183,10 +183,10 @@ public function remove(array $paths, array $filters)
*
* If the option is already set, it will be overwritten.
*
* @see Aws\S3\S3Client::getObjectUrl() for available options.
* @see Aws\S3\S3Client::getObjectUrl() for available options
*
* @param string $key The name of the option.
* @param mixed $value The value to be set.
* @param string $key The name of the option
* @param mixed $value The value to be set
*
* @return AmazonS3Resolver $this
*
Expand All @@ -202,10 +202,10 @@ public function setObjectUrlOption($key, $value)
*
* If the option is already set, it will be overwritten.
*
* @see Aws\S3\S3Client::getObjectUrl() for available options.
* @see Aws\S3\S3Client::getObjectUrl() for available options
*
* @param string $key The name of the option.
* @param mixed $value The value to be set.
* @param string $key The name of the option
* @param mixed $value The value to be set
*
* @return AmazonS3Resolver $this
*/
Expand All @@ -221,10 +221,10 @@ public function setGetOption($key, $value)
*
* If the option is already set, it will be overwritten.
*
* @see Aws\S3\S3Client::putObject() for available options.
* @see Aws\S3\S3Client::putObject() for available options
*
* @param string $key The name of the option.
* @param mixed $value The value to be set.
* @param string $key The name of the option
* @param mixed $value The value to be set
*
* @return AmazonS3Resolver $this
*/
Expand All @@ -238,10 +238,10 @@ public function setPutOption($key, $value)
/**
* Returns the object path within the bucket.
*
* @param string $path The base path of the resource.
* @param string $filter The name of the imagine filter in effect.
* @param string $path The base path of the resource
* @param string $filter The name of the imagine filter in effect
*
* @return string The path of the object on S3.
* @return string The path of the object on S3
*/
protected function getObjectPath($path, $filter)
{
Expand Down
4 changes: 2 additions & 2 deletions Imagine/Cache/Resolver/CacheResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ protected function removePathAndFilter($path, $filter)
*
* When overriding this method, ensure generateIndexKey is adjusted accordingly.
*
* @param string $path The image path in use.
* @param string $filter The filter in use.
* @param string $path The image path in use
* @param string $filter The filter in use
*
* @return string
*/
Expand Down
16 changes: 8 additions & 8 deletions Imagine/Cache/Resolver/FlysystemResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ protected function getFileUrl($path, $filter)
/**
* Resolves filtered path for rendering in the browser.
*
* @param string $path The path where the original file is expected to be.
* @param string $filter The name of the imagine filter in effect.
* @param string $path The path where the original file is expected to be
* @param string $filter The name of the imagine filter in effect
*
* @return string The absolute URL of the cached image.
* @return string The absolute URL of the cached image
*
* @throws NotResolvableException
*/
Expand All @@ -110,9 +110,9 @@ public function resolve($path, $filter)
/**
* Stores the content of the given binary.
*
* @param BinaryInterface $binary The image binary to store.
* @param string $path The path where the original file is expected to be.
* @param string $filter The name of the imagine filter in effect.
* @param BinaryInterface $binary The image binary to store
* @param string $path The path where the original file is expected to be
* @param string $filter The name of the imagine filter in effect
*/
public function store(BinaryInterface $binary, $path, $filter)
{
Expand All @@ -123,8 +123,8 @@ public function store(BinaryInterface $binary, $path, $filter)
}

/**
* @param string[] $paths The paths where the original files are expected to be.
* @param string[] $filters The imagine filters in effect.
* @param string[] $paths The paths where the original files are expected to be
* @param string[] $filters The imagine filters in effect
*/
public function remove(array $paths, array $filters)
{
Expand Down
16 changes: 8 additions & 8 deletions Imagine/Cache/Resolver/ResolverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ public function isStored($path, $filter);
/**
* Resolves filtered path for rendering in the browser.
*
* @param string $path The path where the original file is expected to be.
* @param string $filter The name of the imagine filter in effect.
* @param string $path The path where the original file is expected to be
* @param string $filter The name of the imagine filter in effect
*
* @return string The absolute URL of the cached image.
* @return string The absolute URL of the cached image
*
* @throws NotResolvableException
*/
Expand All @@ -32,15 +32,15 @@ public function resolve($path, $filter);
/**
* Stores the content of the given binary.
*
* @param BinaryInterface $binary The image binary to store.
* @param string $path The path where the original file is expected to be.
* @param string $filter The name of the imagine filter in effect.
* @param BinaryInterface $binary The image binary to store
* @param string $path The path where the original file is expected to be
* @param string $filter The name of the imagine filter in effect
*/
public function store(BinaryInterface $binary, $path, $filter);

/**
* @param string[] $paths The paths where the original files are expected to be.
* @param string[] $filters The imagine filters in effect.
* @param string[] $paths The paths where the original files are expected to be
* @param string[] $filters The imagine filters in effect
*/
public function remove(array $paths, array $filters);
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Interface to make PostProcessors configurable without breaking BC.
*
* @see PostProcessorInterface for the original interface.
* @see PostProcessorInterface for the original interface
*
* @author Alex Wilson <a@ax.gy>
*/
Expand Down
2 changes: 1 addition & 1 deletion Imagine/Filter/PostProcessor/PostProcessorInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Interface for PostProcessors - handlers which can operate on binaries prepared in FilterManager.
*
* @see ConfigurablePostProcessorInterface For a means to configure these at run-time.
* @see ConfigurablePostProcessorInterface For a means to configure these at run-time
*
* @author Konstantin Tjuterev <kostik.lv@gmail.com>
*/
Expand Down
6 changes: 3 additions & 3 deletions Tests/Imagine/Filter/Loader/AutoRotateFilterLoaderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ class AutoRotateFilterLoaderTest extends AbstractTest
/**
* Starts a test with expected results.
*
* @param $exifValue {String} The exif value to be returned by the metadata mock.
* @param $expectCallRotateValue {null|number} The expected rotation value, null if no rotation is expected.
* @param $expectCallFlip {Boolean} True if a horizontal flip is expected, false otherwise.
* @param $exifValue {String} The exif value to be returned by the metadata mock
* @param $expectCallRotateValue {null|number} The expected rotation value, null if no rotation is expected
* @param $expectCallFlip {Boolean} True if a horizontal flip is expected, false otherwise
*/
private function loadExif($exifValue, $expectCallRotateValue, $expectCallFlip)
{
Expand Down