Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

> use GdImage; class MemoryDrawing extends BaseDrawing > use PhpOffice\PhpSpreadsheet\Exception; { > use PhpOffice\PhpSpreadsheet\Shared\File; // Rendering functions >
const RENDERING_DEFAULT = 'imagepng'; const RENDERING_PNG = 'imagepng'; const RENDERING_GIF = 'imagegif'; const RENDERING_JPEG = 'imagejpeg'; // MIME types const MIMETYPE_DEFAULT = 'image/png'; const MIMETYPE_PNG = 'image/png'; const MIMETYPE_GIF = 'image/gif'; const MIMETYPE_JPEG = 'image/jpeg';
> const SUPPORTED_MIME_TYPES = [ /** > self::MIMETYPE_GIF, * Image resource. > self::MIMETYPE_JPEG, * > self::MIMETYPE_PNG, * @var resource > ]; */ >
< * @var resource
> * @var null|GdImage|resource
/** * Rendering function. * * @var string */ private $renderingFunction; /** * Mime type. * * @var string */ private $mimeType; /** * Unique name. * * @var string */ private $uniqueName;
> /** @var null|resource */ /** > private $alwaysNull; * Create a new MemoryDrawing. >
*/ public function __construct() { // Initialise values
< $this->imageResource = null;
$this->renderingFunction = self::RENDERING_DEFAULT; $this->mimeType = self::MIMETYPE_DEFAULT;
< $this->uniqueName = md5(rand(0, 9999) . time() . rand(0, 9999));
> $this->uniqueName = md5(mt_rand(0, 9999) . time() . mt_rand(0, 9999)); > $this->alwaysNull = null;
// Initialize parent parent::__construct(); }
> public function __destruct() /** > { * Get image resource. > if ($this->imageResource) { * > $rslt = @imagedestroy($this->imageResource); * @return resource > // "Fix" for Scrutinizer */ > $this->imageResource = $rslt ? null : $this->alwaysNull; public function getImageResource() > } { > } return $this->imageResource; > } > public function __clone() > { /** > parent::__clone(); * Set image resource. > $this->cloneResource(); * > } * @param resource $value > * > private function cloneResource(): void * @return MemoryDrawing > { */ > if (!$this->imageResource) { public function setImageResource($value) > return; { > } $this->imageResource = $value; > > $width = (int) imagesx($this->imageResource); if ($this->imageResource !== null) { > $height = (int) imagesy($this->imageResource); // Get width/height > $this->width = imagesx($this->imageResource); > if (imageistruecolor($this->imageResource)) { $this->height = imagesy($this->imageResource); > $clone = imagecreatetruecolor($width, $height); } > if (!$clone) { > throw new Exception('Could not clone image resource'); return $this; > } } > > imagealphablending($clone, false); /** > imagesavealpha($clone, true); * Get rendering function. > } else { * > $clone = imagecreate($width, $height); * @return string > if (!$clone) { */ > throw new Exception('Could not clone image resource'); public function getRenderingFunction() > } { > return $this->renderingFunction; > // If the image has transparency... } > $transparent = imagecolortransparent($this->imageResource); > if ($transparent >= 0) { /** > $rgb = imagecolorsforindex($this->imageResource, $transparent); * Set rendering function. > if (empty($rgb)) { * > throw new Exception('Could not get image colors'); * @param string $value see self::RENDERING_* > } * > * @return MemoryDrawing > imagesavealpha($clone, true); */ > $color = imagecolorallocatealpha($clone, $rgb['red'], $rgb['green'], $rgb['blue'], $rgb['alpha']); public function setRenderingFunction($value) > if ($color === false) { { > throw new Exception('Could not get image alpha color'); $this->renderingFunction = $value; > } > return $this; > imagefill($clone, 0, 0, $color); } > } > } /** > * Get mime type. > //Create the Clone!! * > imagecopy($clone, $this->imageResource, 0, 0, 0, 0, $width, $height); * @return string > */ > $this->imageResource = $clone; public function getMimeType() > } { > return $this->mimeType; > /** } > * @param resource $imageStream Stream data to be converted to a Memory Drawing > * /** > * @throws Exception * Set mime type. > */ * > public static function fromStream($imageStream): self * @param string $value see self::MIMETYPE_* > { * > $streamValue = stream_get_contents($imageStream); * @return MemoryDrawing > if ($streamValue === false) { */ > throw new Exception('Unable to read data from stream'); public function setMimeType($value) > } { > $this->mimeType = $value; > return self::fromString($streamValue); > } return $this; > } > /** > * @param string $imageString String data to be converted to a Memory Drawing /** > * * Get indexed filename (using image index). > * @throws Exception * > */ * @return string > public static function fromString(string $imageString): self */ > { public function getIndexedFilename() > $gdImage = @imagecreatefromstring($imageString); { > if ($gdImage === false) { $extension = strtolower($this->getMimeType()); > throw new Exception('Value cannot be converted to an image'); $extension = explode('/', $extension); > } $extension = $extension[1]; > > $mimeType = self::identifyMimeType($imageString); return $this->uniqueName . $this->getImageIndex() . '.' . $extension; > $renderingFunction = self::identifyRenderingFunction($mimeType); } > > $drawing = new self(); /** > $drawing->setImageResource($gdImage); * Get hash code. > $drawing->setRenderingFunction($renderingFunction); * > $drawing->setMimeType($mimeType); * @return string Hash code > */ > return $drawing; public function getHashCode() > } { > return md5( > private static function identifyRenderingFunction(string $mimeType): string $this->renderingFunction . > { $this->mimeType . > switch ($mimeType) { $this->uniqueName . > case self::MIMETYPE_PNG: parent::getHashCode() . > return self::RENDERING_PNG; __CLASS__ > case self::MIMETYPE_JPEG: ); > return self::RENDERING_JPEG; } > case self::MIMETYPE_GIF: } > return self::RENDERING_GIF; > } > > return self::RENDERING_DEFAULT; > } > > /** > * @throws Exception > */ > private static function identifyMimeType(string $imageString): string > { > $temporaryFileName = File::temporaryFilename(); > file_put_contents($temporaryFileName, $imageString); > > $mimeType = self::identifyMimeTypeUsingExif($temporaryFileName); > if ($mimeType !== null) { > unlink($temporaryFileName); > > return $mimeType; > } > > $mimeType = self::identifyMimeTypeUsingGd($temporaryFileName); > if ($mimeType !== null) { > unlink($temporaryFileName); > > return $mimeType; > } > > unlink($temporaryFileName); > > return self::MIMETYPE_DEFAULT; > } > > private static function identifyMimeTypeUsingExif(string $temporaryFileName): ?string > { > if (function_exists('exif_imagetype')) { > $imageType = @exif_imagetype($temporaryFileName); > $mimeType = ($imageType) ? image_type_to_mime_type($imageType) : null; > > return self::supportedMimeTypes($mimeType); > } > > return null; > } > > private static function identifyMimeTypeUsingGd(string $temporaryFileName): ?string > { > if (function_exists('getimagesize')) { > $imageSize = @getimagesize($temporaryFileName); > if (is_array($imageSize)) { > $mimeType = $imageSize['mime'] ?? null; > > return self::supportedMimeTypes($mimeType); > } > } > > return null; > } > > private static function supportedMimeTypes(?string $mimeType = null): ?string > { > if (in_array($mimeType, self::SUPPORTED_MIME_TYPES, true)) { > return $mimeType; > } > > return null; > } >
< * @return resource
> * @return null|GdImage|resource
< * @param resource $value
> * @param GdImage|resource $value
< * @return MemoryDrawing
> * @return $this
< $this->width = imagesx($this->imageResource); < $this->height = imagesy($this->imageResource);
> $this->width = (int) imagesx($this->imageResource); > $this->height = (int) imagesy($this->imageResource);
< * @return MemoryDrawing
> * @return $this
< * @return MemoryDrawing
> * @return $this
< * < * @return string
< public function getIndexedFilename()
> public function getIndexedFilename(): string