gomoob/php-facebook-messenger

<?php

/**
 * BSD 3-Clause License
 *
 * Copyright (c) 2017, GOMOOB All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 *   disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
namespace Gomoob\FacebookMessenger\Model\Message;

use Gomoob\FacebookMessenger\Exception\FacebookMessengerException;
use Gomoob\FacebookMessenger\Model\TemplateMessageInterface;

/**
 * Class which represents a a Facebook Messenger template message.
 *
 * @author Arnaud Lavallée (arnaud.lavallee@gomoob.com)
 * @see https://developers.facebook.com/docs/messenger-platform/send-api-reference/text-message
 */
class TemplateMessage implements TemplateMessageInterface
{
    /**
     * The attachment to be attached to the template message.
     *
     * @var \Gomoob\FacebookMessenger\Model\AttachmentInterface
     */
    private $attachment;

    /**
     * Utility function used to create a new instance of the <tt>TemplateMessage</tt> class.
     *
     * @return \Gomoob\FacebookMessenger\Model\Message\TemplateMessage the new created instance.
     */
    public static function create()
    {
        return new TemplateMessage();
    }

    /**
     * {@inheritDoc}
     */
    public function getAttachment()
    {
        return $this->attachment;
    }

    /**
     * {@inheritDoc}
     */
    public function jsonSerialize()
    {
        // The 'attachment' property must have been defined
        if (!isset($this->attachment)) {
            throw new FacebookMessengerException('The \'attachment\' property is not set !');
        }

        return [
            'attachment' => $this->attachment->jsonSerialize()
        ];
    }

    /**
     * {@inheritDoc}
     */
    public function setAttachment($attachment)
    {
        $this->attachment = $attachment;

        return $this;
    }
}