Source for file ServiceEndpoint.php

Documentation is available at ServiceEndpoint.php

  1. <?php
  2. /**
  3.  * OpenID_ServiceEndpoint
  4.  *
  5.  * PHP Version 5.2.0+
  6.  *
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Rich Schumacher <rich.schu@gmail.com>
  10.  * @copyright 2009 Rich Schumacher
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Required files
  17.  */
  18. require_once 'Validate.php';
  19. require_once 'OpenID/Discover.php';
  20.  
  21. /**
  22.  * OpenID_ServiceEndpoint
  23.  *
  24.  * A simple class that represents a single OpenID provider service endpoint.
  25.  *
  26.  * @category  Auth
  27.  * @package   OpenID
  28.  * @author    Rich Schumacher <rich.schu@gmail.com>
  29.  * @copyright 2009 Rich Schumacher
  30.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  31.  * @link      http://pearopenid.googlecode.com
  32.  */
  33. class OpenID_ServiceEndpoint
  34. {
  35.     /**
  36.      * An array of URIs for this endpoint
  37.      *
  38.      * @var array 
  39.      */
  40.     protected $uris = array();
  41.  
  42.     /**
  43.      * An array of service types
  44.      *
  45.      * @var array 
  46.      */
  47.     protected $types = array();
  48.  
  49.     /**
  50.      * The local ID represented by this endpoint
  51.      *
  52.      * @var string 
  53.      */
  54.     protected $localID = null;
  55.  
  56.     /**
  57.      * The source of discovery
  58.      *
  59.      * @var string 
  60.      */
  61.     protected $source = null;
  62.  
  63.     /**
  64.      * The version of the OpenID protocol this endpoint supports
  65.      *
  66.      * @var string 
  67.      */
  68.     protected $version = null;
  69.  
  70.     /**
  71.      * Sets the endpoint URIs
  72.      *
  73.      * @param array $uris The endpoint URIs
  74.      *
  75.      * @return void 
  76.      */
  77.     public function setURIs(array $uris)
  78.     {
  79.         foreach ($uris as $key => $uri) {
  80.             if (!Validate::uri($uri)) {
  81.                 unset($uris[$key]);
  82.             }
  83.         }
  84.  
  85.         $this->uris = $uris;
  86.     }
  87.  
  88.     /**
  89.      * Returns the URIs for this endpoint
  90.      *
  91.      * @return array 
  92.      */
  93.     public function getURIs()
  94.     {
  95.         return $this->uris;
  96.     }
  97.  
  98.     /**
  99.      * Sets the service type
  100.      *
  101.      * @param array $types The service types
  102.      *
  103.      * @return void 
  104.      */
  105.     public function setTypes(array $types)
  106.     {
  107.         $this->types = $types;
  108.     }
  109.  
  110.     /**
  111. /**
  112.      * Returns the service types
  113.      *
  114.      * @return array 
  115.      */
  116.     public function getTypes()
  117.     {
  118.         return $this->types;
  119.     }
  120.  
  121.     /**
  122.      * Sets the local ID
  123.      *
  124.      * @param string $localID Local ID for this endpoint
  125.      *
  126.      * @return void 
  127.      */
  128.     public function setLocalID($localID)
  129.     {
  130.         $this->localID = $localID;
  131.     }
  132.  
  133.     /**
  134.      * Returns the local ID
  135.      *
  136.      * @return string 
  137.      */
  138.     public function getLocalID()
  139.     {
  140.         return $this->localID;
  141.     }
  142.  
  143.     /**
  144.      * Sets the source of discovery
  145.      *
  146.      * @param string $source The source of discovery
  147.      *
  148.      * @return void 
  149.      */
  150.     public function setSource($source)
  151.     {
  152.         if (in_array($source, OpenID_Discover::$discoveryOrder)) {
  153.             $this->source = $source;
  154.         }
  155.     }
  156.  
  157.     /**
  158.      * Returns the discovery source
  159.      *
  160.      * @return string 
  161.      */
  162.     public function getSource()
  163.     {
  164.         return $this->source;
  165.     }
  166.  
  167.     /**
  168.      * Sets the OpenID protocol version this endpoint supports
  169.      *
  170.      * @param string $version The OpenID version
  171.      *
  172.      * @return void 
  173.      */
  174.     public function setVersion($version)
  175.     {
  176.         if (array_key_exists($version, OpenID::$versionMap)) {
  177.             $this->version = $version;
  178.         }
  179.     }
  180.  
  181.     /**
  182.      * Returns the OpenID protocol version this endpoint supports
  183.      *
  184.      * @return string 
  185.      */
  186.     public function getVersion()
  187.     {
  188.         return $this->version;
  189.     }
  190.  
  191.     /**
  192.      * Determines if this service endpoint is valid
  193.      *
  194.      * Only checks to ensure that there is at least one valid service URI set
  195.      * for this endpoint.
  196.      *
  197.      * @return bool 
  198.      */
  199.     public function isValid()
  200.     {
  201.         return count($this->getURIs()) > 0;
  202.     }
  203. }
  204.  
  205. ?>

Documentation generated on Tue, 15 Dec 2009 19:00:59 -0800 by phpDocumentor 1.4.3