Image::stream

Encoded current image and return PSR-7 stream

1.6M Downloads / Month

Open Source MIT License

public Intervention\Image\Image stream([mixed $format, [int $quality]])

Encodes the current image in given format and given image quality and creates new PSR-7 stream based on image data.

Parameters

format (optional)

Define the encoding format from one of the following formats:

  • jpg — return JPEG encoded image data
  • png — return Portable Network Graphics (PNG) encoded image data
  • gif — return Graphics Interchange Format (GIF) encoded image data
  • tif — return Tagged Image File Format (TIFF) encoded image data
  • bmp — return Bitmap (BMP) encoded image data
  • data-url — encode current image data in data URI scheme (RFC 2397)

By default the method will return data encoded in the type of the current image. If no image type is defined yet, data will be encoded as jpeg.

quality (optional)

Define the quality of the encoded image optionally. Data ranging from 0 (poor quality, small file) to 100 (best quality, big file). Quality is only applied if you're encoding JPG format since PNG compression is lossless and does not affect image quality. Default: 90.

Return Values

PSR-7 stream as instance of GuzzleHttp\Psr7\Stream.

Examples

// encode png image as jpg stream
$stream = Image::make('public/foo.png')->stream('jpg', 60);

See also