plugins/OMB/extlib/libomb/xrds_writer.php

   1 <?php
   2 /**
   3  * This file is part of libomb
   4  *
   5  * PHP version 5
   6  *
   7  * LICENSE: This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * @package OMB
  21  * @author  Adrian Lang <mail@adrianlang.de>
  22  * @license http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
  23  * @version 0.1a-20090828
  24  * @link    http://adrianlang.de/libomb
  25  */
  26
  27 /**
  28  * Write OMB-specific XRDS
  29  *
  30  * This interface specifies classes which write the XRDS file announcing
  31  * the OMB server. An instance of an implementing class should be passed to
  32  * OMB_Service_Provider->writeXRDS.
  33  */
  34 interface OMB_XRDS_Writer
  35 {
  36     /**
  37      * Write XRDS
  38      *
  39      * Outputs a XRDS document specifying an OMB service.
  40      *
  41      * @param OMB_profile     $user   The target user for the OMB service
  42      * @param OMB_XRDS_Mapper $mapper An OMB_XRDS_Mapper providing endpoint URLs
  43      */
  44     public function writeXRDS($user, $mapper);
  45 }
  46 ?>