WebexMessageFile.php

<?php

namespace NotificationChannels\Webex;

use GuzzleHttp\Psr7\Utils;
use Illuminate\Contracts\Support\Arrayable;

/**
 * This class provides a fluent interface for creating a Webex Message File representation.
 */
class WebexMessageFile implements Arrayable
{
    /**
     * The path for the file.
     */
    public string $path;

    /**
     * The user provided name for the file.
     */
    public ?string $name = null;

    /**
     * The user provided MIME type for the file.
     */
    public ?string $type = null;

    /**
     * Set the path for the file.
     */
    public function path(string $path): WebexMessageFile
    {
        $this->path = $path;

        return $this;
    }

    /**
     * Set the user provided name for the file.
     */
    public function name(string $name): WebexMessageFile
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Set the user provided MIME type for the file.
     */
    public function type(string $type): WebexMessageFile
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Get the instance as an array suitable for `multipart/form-data` request.
     *
     * This function assumes that the {@see $path} can be read.
     *
     * @return array an associative array with name, contents, headers (optional), and filename
     *               (optional) as keys
     *
     * @internal
     */
    public function toArray(): array
    {
        $arr = [
            'name' => 'files',
            'contents' => Utils::tryFopen($this->path, 'r'),
        ];

        if (isset($this->name)) {
            $arr['filename'] = $this->name;
        }

        if (isset($this->type)) {
            $arr['headers'] = ['Content-Type' => $this->type];
        }

        return $arr;
    }
}