PHPWord/tests/PhpWordTests/Element/ImageTest.php

<?php
/**
 * This file is part of PHPWord - A pure PHP library for reading and writing
 * word processing documents.
 *
 * PHPWord is free software distributed under the terms of the GNU Lesser
 * General Public License version 3 as published by the Free Software Foundation.
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code. For the full list of
 * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
 *
 * @see         https://github.com/PHPOffice/PHPWord
 *
 * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
 */

namespace PhpOffice\PhpWordTests\Element;

use PhpOffice\PhpWord\Element\Image;
use PhpOffice\PhpWordTests\AbstractWebServerEmbeddedTest;
use PhpOffice\PhpWord\SimpleType\Jc;

/**
 * Test class for PhpOffice\PhpWord\Element\Image.
 *
 * @runTestsInSeparateProcesses
 */
class ImageTest extends AbstractWebServerEmbeddedTest
{
    /**
     * New instance.
     */
    public function testConstruct(): void
    {
        $src = __DIR__ . '/../_files/images/firefox.png';
        $oImage = new Image($src);

        self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $oImage);
        self::assertEquals($src, $oImage->getSource());
        self::assertEquals(md5($src), $oImage->getMediaId());
        self::assertFalse($oImage->isWatermark());
        self::assertEquals(Image::SOURCE_LOCAL, $oImage->getSourceType());
        self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle());
    }

    /**
     * New instance with style.
     */
    public function testConstructWithStyle(): void
    {
        $src = __DIR__ . '/../_files/images/firefox.png';
        $oImage = new Image(
            $src,
            [
                'width' => 210,
                'height' => 210,
                'alignment' => Jc::CENTER,
                'wrappingStyle' => \PhpOffice\PhpWord\Style\Image::WRAPPING_STYLE_BEHIND,
            ]
        );

        self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle());
    }

    /**
     * Valid image types.
     */
    public function testImages(): void
    {
        $images = [
            ['mars.jpg', 'image/jpeg', 'jpg', 'imagecreatefromjpeg', 'imagejpeg'],
            ['mario.gif', 'image/gif', 'gif', 'imagecreatefromgif', 'imagegif'],
            ['firefox.png', 'image/png', 'png', 'imagecreatefrompng', 'imagepng'],
            ['duke_nukem.bmp', 'image/bmp', 'bmp', null, null],
            ['angela_merkel.tif', 'image/tiff', 'tif', null, null],
        ];

        foreach ($images as $imageData) {
            [$source, $type, $extension, $createFunction, $imageFunction] = $imageData;
            $nam = ucfirst(strtok($source, '.'));
            $source = __DIR__ . "/../_files/images/{$source}";
            $image = new Image($source, null, null, $nam);
            self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $image);
            self::assertEquals($source, $image->getSource());
            self::assertEquals($nam, $image->getName());
            self::assertEquals(md5($source), $image->getMediaId());
            self::assertEquals($type, $image->getImageType());
            self::assertEquals($extension, $image->getImageExtension());
            self::assertEquals($createFunction, $image->getImageCreateFunction());
            self::assertEquals($imageFunction, $image->getImageFunction());
            self::assertFalse($image->isMemImage());
            self::assertNotNull($image->getImageStringData());
        }
    }

    /**
     * Get style.
     */
    public function testStyle(): void
    {
        $oImage = new Image(
            __DIR__ . '/../_files/images/earth.jpg',
            ['height' => 210, 'alignment' => Jc::CENTER]
        );

        self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle());
    }

    /**
     * Test invalid local image.
     */
    public function testInvalidImageLocal(): void
    {
        $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class);
        new Image(__DIR__ . '/../_files/images/thisisnotarealimage');
    }

    /**
     * Test invalid PHP Image.
     */
    public function testInvalidImagePhp(): void
    {
        $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class);
        $object = new Image('test.php');
        $object->getSource();
    }

    /**
     * Test unsupported image.
     */
    public function testUnsupportedImage(): void
    {
        $this->expectException(\PhpOffice\PhpWord\Exception\UnsupportedImageTypeException::class);
        //disable ssl verification, never do this in real application, you should pass the certificiate instead!!!
        $arrContextOptions = [
            'ssl' => [
                'verify_peer' => false,
                'verify_peer_name' => false,
            ],
        ];
        stream_context_set_default($arrContextOptions);
        $object = new Image(self::getRemoteBmpImageUrl());
        $object->getSource();
    }

    /**
     * Get relation Id.
     */
    public function testRelationID(): void
    {
        $oImage = new Image(__DIR__ . '/../_files/images/earth.jpg', ['width' => 100]);
        $iVal = mt_rand(1, 1000);
        $oImage->setRelationId($iVal);
        self::assertEquals($iVal, $oImage->getRelationId());
    }

    /**
     * Test archived image.
     */
    public function testArchivedImage(): void
    {
        $archiveFile = __DIR__ . '/../_files/documents/reader.docx';
        $imageFile = 'word/media/image1.jpeg';
        $image = new Image("zip://{$archiveFile}#{$imageFile}");
        self::assertEquals('image/jpeg', $image->getImageType());
    }

    /**
     * Test getting image as string.
     */
    public function testImageAsStringFromFile(): void
    {
        $image = new Image(__DIR__ . '/../_files/images/earth.jpg');

        self::assertNotNull($image->getImageStringData());
        self::assertNotNull($image->getImageStringData(true));
    }

    /**
     * Test getting image from zip as string.
     */
    public function testImageAsStringFromZip(): void
    {
        $archiveFile = __DIR__ . '/../_files/documents/reader.docx';
        $imageFile = 'word/media/image1.jpeg';
        $image = new Image("zip://{$archiveFile}#{$imageFile}");

        self::assertNotNull($image->getImageStringData());
        self::assertNotNull($image->getImageStringData(true));
    }

    /**
     * Test construct from string.
     */
    public function testConstructFromString(): void
    {
        $source = file_get_contents(__DIR__ . '/../_files/images/earth.jpg');

        $image = new Image($source);
        self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $image);
        self::assertEquals($source, $image->getSource());
        self::assertEquals(md5($source), $image->getMediaId());
        self::assertEquals('image/jpeg', $image->getImageType());
        self::assertEquals('jpg', $image->getImageExtension());
        self::assertEquals('imagecreatefromstring', $image->getImageCreateFunction());
        self::assertEquals('imagejpeg', $image->getImageFunction());
        self::assertTrue($image->isMemImage());

        self::assertNotNull($image->getImageStringData());
        self::assertNotNull($image->getImageStringData(true));
    }

    /**
     * Test construct from GD.
     */
    public function testConstructFromGd(): void
    {
        $source = self::getRemoteImageUrl();

        $image = new Image($source);
        self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $image);
        self::assertEquals($source, $image->getSource());
        self::assertEquals(md5($source), $image->getMediaId());
        self::assertEquals('image/png', $image->getImageType());
        self::assertEquals('png', $image->getImageExtension());
        self::assertEquals('imagecreatefrompng', $image->getImageCreateFunction());
        self::assertEquals('imagepng', $image->getImageFunction());
        self::assertTrue($image->isMemImage());

        self::assertNotNull($image->getImageStringData());
        self::assertNotNull($image->getImageStringData(true));
    }

    /**
     * Test invalid string image.
     */
    public function testInvalidImageString(): void
    {
        $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class);
        $object = new Image('this_is-a_non_valid_image');
        $object->getSource();
    }
}