DocumentableTrait.php

<?php

/*
 * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
 *
 * Copyright (c) 2016-2024 BigBlueButton Inc. and by respective authors (see below).
 *
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 3.0 of the License, or (at your option) any later
 * version.
 *
 * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along
 * with BigBlueButton; if not, see <https://www.gnu.org/licenses/>.
 */

namespace BigBlueButton\Parameters;

use BigBlueButton\Parameters\Config\DocumentOptionsStore;

trait DocumentableTrait
{
    /**
     * @var array<string, mixed>
     */
    protected array $presentations = [];

    /**
     * @return array<string, mixed>
     */
    public function getPresentations(): array
    {
        return $this->presentations;
    }

    public function addPresentation(string $nameOrUrl, $content = null, ?string $filename = null, ?DocumentOptionsStore $attributes = null): self
    {
        $this->presentations[$nameOrUrl] = [
            'content' => null !== $content ? base64_encode($content) : null,
            'filename' => $filename,
            'attributes' => $attributes
        ];

        return $this;
    }

    public function getPresentationsAsXML(): string
    {
        $result = '';
        if (!empty($this->presentations)) {
            $xml    = new \SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><modules/>');
            $module = $xml->addChild('module');
            $module->addAttribute('name', 'presentation');

            foreach ($this->presentations as $nameOrUrl => $data) {
                $presentation = $module->addChild('document');
                if (0 === mb_strpos($nameOrUrl, 'http')) {
                    $presentation->addAttribute('url', $nameOrUrl);
                } else {
                    $presentation->addAttribute('name', $nameOrUrl);
                }

                if (!empty($data['filename'])) {
                    $presentation->addAttribute('filename', $data['filename']);
                }

                if (!empty($data['content'])) {
                    $presentation[0] = $data['content'];
                }

                // Add attributes using DocumentAttributes class
                if ($data['attributes'] instanceof DocumentOptionsStore) {
                    foreach ($data['attributes']->getAttributes() as $attrName => $attrValue) {
                        $presentation->addAttribute($attrName, $attrValue);
                    }
                }
            }
            $result = $xml->asXML();
        }

        if (!is_string($result)) {
            throw new \RuntimeException('String expected, but ' . gettype($result) . ' received.');
        }

        return $result;
    }
}