vendor/imagine/imagine/src/Image/ImagineInterface.php line 36

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Imagine package.
  5. *
  6. * (c) Bulat Shakirzyanov <mallluhuct@gmail.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Imagine\Image;
  14. use Imagine\Factory\ClassFactoryAwareInterface;
  15. use Imagine\Image\Metadata\MetadataReaderInterface;
  16. use Imagine\Image\Palette\Color\ColorInterface;
  18. /**
  19. * The imagine interface.
  20. */
  21. interface ImagineInterface extends ClassFactoryAwareInterface
  22. {
  23. const VERSION = '1.3.4';
  25. /**
  26. * Creates a new empty image with an optional background color.
  27. *
  28. * @param \Imagine\Image\BoxInterface $size
  29. * @param \Imagine\Image\Palette\Color\ColorInterface $color
  30. *
  31. * @throws \Imagine\Exception\InvalidArgumentException
  32. * @throws \Imagine\Exception\RuntimeException
  33. *
  34. * @return \Imagine\Image\ImageInterface
  35. */
  36. public function create(BoxInterface $size, ColorInterface $color = null);
  38. /**
  39. * Opens an existing image from $path.
  40. *
  41. * @param string|\Imagine\File\LoaderInterface|mixed $path the file path, a LoaderInterface instance, or an object whose string representation is the image path
  42. *
  43. * @throws \Imagine\Exception\RuntimeException
  44. *
  45. * @return \Imagine\Image\ImageInterface
  46. */
  47. public function open($path);
  49. /**
  50. * Loads an image from a binary $string.
  51. *
  52. * @param string $string
  53. *
  54. * @throws \Imagine\Exception\RuntimeException
  55. *
  56. * @return \Imagine\Image\ImageInterface
  57. */
  58. public function load($string);
  60. /**
  61. * Loads an image from a resource $resource.
  62. *
  63. * @param resource $resource
  64. *
  65. * @throws \Imagine\Exception\RuntimeException
  66. *
  67. * @return \Imagine\Image\ImageInterface
  68. */
  69. public function read($resource);
  71. /**
  72. * Constructs a font with specified $file, $size and $color.
  73. *
  74. * The font size is to be specified in points (e.g. 10pt means 10)
  75. *
  76. * @param string $file
  77. * @param int $size
  78. * @param \Imagine\Image\Palette\Color\ColorInterface $color
  79. *
  80. * @return \Imagine\Image\FontInterface
  81. */
  82. public function font($file, $size, ColorInterface $color);
  84. /**
  85. * Set the object to be used to read image metadata.
  86. *
  87. * @param \Imagine\Image\Metadata\MetadataReaderInterface $metadataReader
  88. *
  89. * @return $this
  90. */
  91. public function setMetadataReader(MetadataReaderInterface $metadataReader);
  93. /**
  94. * Get the object to be used to read image metadata.
  95. *
  96. * @return \Imagine\Image\Metadata\MetadataReaderInterface
  97. */
  98. public function getMetadataReader();
  99. }