diff --git a/src/Resolvable/ResolvableFilesystem.php b/src/Resolvable/ResolvableFilesystem.php index e15b1a2..b36695f 100644 --- a/src/Resolvable/ResolvableFilesystem.php +++ b/src/Resolvable/ResolvableFilesystem.php @@ -4,6 +4,26 @@ use Gaufrette\FilesystemInterface; +/** + * Filesystem decorator providing resolve() method to resolve an object path into URI. + * + * Example: + * $client = // AwsS3 client instantiation + * $decorated = new Filesystem(new AwsS3($client, 'my_bucket', ['directory' => 'root/dir'])); + * $filesystem = new ResolvableFilesystem( + * $decorated, + * new AwsS3PresignedUrlResolver($client, 'my_bucket', 'root/dir') + * ); + * + * try { + * // should return something like "https://eu-west-1.blabla.aws.com/my_bucket/root/dir/foo/bar.png?token + * var_dump($filesystem->resolve('foo/bar.png')); + * } catch (ResolverException $e) { + * + * } + * + * @author Albin Kerouanton + */ class ResolvableFilesystem implements FilesystemInterface { /** @var FilesystemInterface */ diff --git a/src/Resolvable/Resolver/AwsS3PresignedUrlResolver.php b/src/Resolvable/Resolver/AwsS3PresignedUrlResolver.php index f78e74c..cd40ad3 100644 --- a/src/Resolvable/Resolver/AwsS3PresignedUrlResolver.php +++ b/src/Resolvable/Resolver/AwsS3PresignedUrlResolver.php @@ -8,6 +8,8 @@ /** * Resolves object paths into time-limited URLs, namely presigned URLs. * + * @author Albin Kerouanton + * * @see http://docs.aws.amazon.com/AmazonS3/latest/dev/ShareObjectPreSignedURL.html */ class AwsS3PresignedUrlResolver implements ResolverInterface diff --git a/src/Resolvable/Resolver/AwsS3PublicUrlResolver.php b/src/Resolvable/Resolver/AwsS3PublicUrlResolver.php index 2f14642..dcd0332 100644 --- a/src/Resolvable/Resolver/AwsS3PublicUrlResolver.php +++ b/src/Resolvable/Resolver/AwsS3PublicUrlResolver.php @@ -6,7 +6,9 @@ use Gaufrette\Extras\Resolvable\ResolverInterface; /** - * Resolves objects' path into public URLs. + * Resolves path of public objects into URLs. + * + * @author Albin Kerouanton */ class AwsS3PublicUrlResolver implements ResolverInterface { diff --git a/src/Resolvable/Resolver/StaticUrlResolver.php b/src/Resolvable/Resolver/StaticUrlResolver.php index e696265..d060c78 100644 --- a/src/Resolvable/Resolver/StaticUrlResolver.php +++ b/src/Resolvable/Resolver/StaticUrlResolver.php @@ -6,6 +6,8 @@ /** * Resolves object path by prepending a static prefix. + * + * @author Albin Kerouanton */ class StaticUrlResolver implements ResolverInterface { diff --git a/src/Resolvable/ResolverException.php b/src/Resolvable/ResolverException.php index 62643d6..e4d5ba5 100644 --- a/src/Resolvable/ResolverException.php +++ b/src/Resolvable/ResolverException.php @@ -2,6 +2,11 @@ namespace Gaufrette\Extras\Resolvable; +/** + * Base exception thrown by resolvers if they fail to resolve an object path into URI. + * + * @author Albin Kerouanton + */ class ResolverException extends \Exception { } diff --git a/src/Resolvable/ResolverInterface.php b/src/Resolvable/ResolverInterface.php index 0d0beb4..45ac255 100644 --- a/src/Resolvable/ResolverInterface.php +++ b/src/Resolvable/ResolverInterface.php @@ -2,6 +2,11 @@ namespace Gaufrette\Extras\Resolvable; +/** + * Resolves an object path into an URI. + * + * @author Albin Kerouanton + */ interface ResolverInterface { /** diff --git a/src/Resolvable/UnresolvableObjectException.php b/src/Resolvable/UnresolvableObjectException.php index a0f7697..e4c8b22 100644 --- a/src/Resolvable/UnresolvableObjectException.php +++ b/src/Resolvable/UnresolvableObjectException.php @@ -2,6 +2,11 @@ namespace Gaufrette\Extras\Resolvable; +/** + * Exception thrown by the filesystem when resolution fail. + * + * @author Albin Kerouanton + */ class UnresolvableObjectException extends \Exception { /**