ListsTests.php

<?php
/*
 * --------------------------------------------------------------------------------
 * <copyright company="Aspose" file="ListsTests.php">
 *   Copyright (c) 2024 Aspose.Words for Cloud
 * </copyright>
 * <summary>
 *   Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 * 
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 * 
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 * </summary>
 * --------------------------------------------------------------------------------
 */

namespace Aspose\Words\Tests;

use Aspose\Words\WordsApi;
use Aspose\Words\Model\Requests\{GetListOnlineRequest, GetListRequest, GetListsOnlineRequest, GetListsRequest, InsertListOnlineRequest, InsertListRequest, UpdateListLevelOnlineRequest, UpdateListLevelRequest, UpdateListOnlineRequest, UpdateListRequest};
use Aspose\Words\Model\{ListInsert, ListLevelUpdate, ListUpdate};
use PHPUnit\Framework\Assert;

/*
 * Example of how to work with lists.
 */
class ListsTests extends BaseTestContext
{
    /*
     * Test for getting lists from document.
     */
    public function testGetLists()
    {
        $remoteDataFolder = self::$baseRemoteFolderPath . "/DocumentElements/Lists";
        $localFile = "DocumentElements/Lists/ListsGet.doc";
        $remoteFileName = "TestGetLists.doc";

        $this->uploadFile(
            realpath(__DIR__ . '/../../..') . "/TestData/" . $localFile,
            $remoteDataFolder . "/" . $remoteFileName
        );

        $request = new GetListsRequest(
            $remoteFileName,
            $remoteDataFolder,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->getLists($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
        Assert::assertNotNull($result->getLists());
        Assert::assertNotNull($result->getLists()->getListInfo());
        Assert::assertCount(2, $result->getLists()->getListInfo());
        Assert::assertEquals(1, $result->getLists()->getListInfo()[0]->getListId());
    }

    /*
     * Test for getting lists from document online.
     */
    public function testGetListsOnline()
    {
        $localFile = "DocumentElements/Lists/ListsGet.doc";

        $requestDocument = realpath(__DIR__ . '/../../..') . '/TestData/' . $localFile;
        $request = new GetListsOnlineRequest(
            $requestDocument,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->getListsOnline($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
    }

    /*
     * Test for getting list from document.
     */
    public function testGetList()
    {
        $remoteDataFolder = self::$baseRemoteFolderPath . "/DocumentElements/Lists";
        $localFile = "DocumentElements/Lists/ListsGet.doc";
        $remoteFileName = "TestGetList.doc";

        $this->uploadFile(
            realpath(__DIR__ . '/../../..') . "/TestData/" . $localFile,
            $remoteDataFolder . "/" . $remoteFileName
        );

        $request = new GetListRequest(
            $remoteFileName,
            1,
            $remoteDataFolder,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->getList($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
        Assert::assertNotNull($result->getList());
        Assert::assertEquals(1, $result->getList()->getListId());
    }

    /*
     * Test for getting list from document online.
     */
    public function testGetListOnline()
    {
        $localFile = "DocumentElements/Lists/ListsGet.doc";

        $requestDocument = realpath(__DIR__ . '/../../..') . '/TestData/' . $localFile;
        $request = new GetListOnlineRequest(
            $requestDocument,
            1,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->getListOnline($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
    }

    /*
     * Test for updating list from document.
     */
    public function testUpdateList()
    {
        $remoteDataFolder = self::$baseRemoteFolderPath . "/DocumentElements/Lists";
        $localFile = "DocumentElements/Lists/ListsGet.doc";
        $remoteFileName = "TestUpdateList.doc";

        $this->uploadFile(
            realpath(__DIR__ . '/../../..') . "/TestData/" . $localFile,
            $remoteDataFolder . "/" . $remoteFileName
        );

        $requestListUpdate = new ListUpdate(array(
            "is_restart_at_each_section" => true,
        ));
        $request = new UpdateListRequest(
            $remoteFileName,
            1,
            $requestListUpdate,
            $remoteDataFolder,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->updateList($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
    }

    /*
     * Test for updating list from document online.
     */
    public function testUpdateListOnline()
    {
        $localFile = "DocumentElements/Lists/ListsGet.doc";

        $requestDocument = realpath(__DIR__ . '/../../..') . '/TestData/' . $localFile;
        $requestListUpdate = new ListUpdate(array(
            "is_restart_at_each_section" => true,
        ));
        $request = new UpdateListOnlineRequest(
            $requestDocument,
            1,
            $requestListUpdate,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->updateListOnline($request);
        Assert::assertTrue($result !== NULL);
        Assert::assertNotNull($result->getModel()->getList());
        Assert::assertEquals(1, $result->getModel()->getList()->getListId());
        Assert::assertTrue($result->getModel()->getList()->getIsRestartAtEachSection());
    }

    /*
     * Test for updating list level from document.
     */
    public function testUpdateListLevel()
    {
        $remoteDataFolder = self::$baseRemoteFolderPath . "/DocumentElements/Lists";
        $localFile = "DocumentElements/Lists/ListsGet.doc";
        $remoteFileName = "TestUpdateListLevel.doc";

        $this->uploadFile(
            realpath(__DIR__ . '/../../..') . "/TestData/" . $localFile,
            $remoteDataFolder . "/" . $remoteFileName
        );

        $requestListUpdate = new ListLevelUpdate(array(
            "alignment" => "Right",
        ));
        $request = new UpdateListLevelRequest(
            $remoteFileName,
            1,
            1,
            $requestListUpdate,
            $remoteDataFolder,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->updateListLevel($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
    }

    /*
     * Test for updating list level from document online.
     */
    public function testUpdateListLevelOnline()
    {
        $localFile = "DocumentElements/Lists/ListsGet.doc";

        $requestDocument = realpath(__DIR__ . '/../../..') . '/TestData/' . $localFile;
        $requestListUpdate = new ListLevelUpdate(array(
            "alignment" => "Right",
        ));
        $request = new UpdateListLevelOnlineRequest(
            $requestDocument,
            1,
            $requestListUpdate,
            1,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->updateListLevelOnline($request);
        Assert::assertTrue($result !== NULL);
        Assert::assertNotNull($result->getModel()->getList());
        Assert::assertNotNull($result->getModel()->getList()->getListLevels());
        Assert::assertNotNull($result->getModel()->getList()->getListLevels()->getListLevel());
        Assert::assertCount(9, $result->getModel()->getList()->getListLevels()->getListLevel());

    }

    /*
     * Test for inserting list from document.
     */
    public function testInsertList()
    {
        $remoteDataFolder = self::$baseRemoteFolderPath . "/DocumentElements/Lists";
        $localFile = "DocumentElements/Lists/ListsGet.doc";
        $remoteFileName = "TestInsertList.doc";

        $this->uploadFile(
            realpath(__DIR__ . '/../../..') . "/TestData/" . $localFile,
            $remoteDataFolder . "/" . $remoteFileName
        );

        $requestListInsert = new ListInsert(array(
            "template" => "OutlineLegal",
        ));
        $request = new InsertListRequest(
            $remoteFileName,
            $requestListInsert,
            $remoteDataFolder,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->insertList($request);
        Assert::assertTrue(json_decode($result, true) !== NULL);
        Assert::assertNotNull($result->getList());
        Assert::assertEquals(3, $result->getList()->getListId());
    }

    /*
     * Test for inserting list from document online.
     */
    public function testInsertListOnline()
    {
        $localFile = "DocumentElements/Lists/ListsGet.doc";

        $requestDocument = realpath(__DIR__ . '/../../..') . '/TestData/' . $localFile;
        $requestListInsert = new ListInsert(array(
            "template" => "OutlineLegal",
        ));
        $request = new InsertListOnlineRequest(
            $requestDocument,
            $requestListInsert,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL
        );

        $result = $this->words->insertListOnline($request);
        Assert::assertTrue($result !== NULL);
    }
}