NotificationHandlerInterface.php

<?php

/*
 * This file is part of the Hearsay PubSubHubbub bundle.
 *
 * The Hearsay PubSubHubbub bundle 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 of the
 * License, or (at your option) any later version.
 *
 * The Hearsay PubSubHubbub bundle 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 the Hearsay PubSubHubbub bundle.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

namespace Hearsay\PubSubHubbubBundle\Handler;

use Hearsay\PubSubHubbubBundle\Topic\TopicInterface;
use Symfony\Component\HttpFoundation\HeaderBag;

/**
 * Interface for objects which can handle hub push notifications.
 * @package HearsayPubSubHubbubBundle
 * @subpackage Handler
 * @author Kevin Montag <kevin@hearsay.it>
 */
interface NotificationHandlerInterface {

    /**
     * Respond to a push notification.  As per the PubSubHubbub spec,
     * implementing classes should avoid performing time-consuming operations
     * inside this function.
     * @param TopicInterface $topic The topic related to the push.
     * @param HeaderBag $headers The headers sent along with the request.
     * @param string $content The body of the notification request.
     */
    public function handle(TopicInterface $topic, HeaderBag $headers, $content);
}