Source for file links.php

Documentation is available at links.php

  1. <?php
  2. /**
  3.  * @package     FrameworkOnFramework
  4.  * @subpackage  hal
  5.  * @copyright   Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. defined('_JEXEC') or die;
  9.  
  10. /**
  11.  * Implementation of the Hypertext Application Language links in PHP. This is
  12.  * actually a collection of links.
  13.  *
  14.  * @package  FrameworkOnFramework
  15.  * @since    2.1
  16.  */
  17. class FOFHalLinks
  18. {
  19.     /**
  20.      * The collection of links, sorted by relation
  21.      *
  22.      * @var array 
  23.      */
  24.     private $_links = array();
  25.  
  26.     /**
  27.      * Add a single link to the links collection
  28.      *
  29.      * @param   string      $rel        The relation of the link to the document. See RFC 5988
  30.      *                                   http://tools.ietf.org/html/rfc5988#section-6.2.2 A document
  31.      *                                   MUST always have a "self" link.
  32.      * @param   FOFHalLink  $link       The actual link object
  33.      * @param   boolean     $overwrite  When false and a link of $rel relation exists, an array of
  34.      *                                   links is created. Otherwise the existing link is overwriten
  35.      *                                   with the new one
  36.      *
  37.      * @return  boolean  True if the link was added to the collection
  38.      */
  39.     public function addLink($rel, FOFHalLink $link, $overwrite = true)
  40.     {
  41.         if (!$link->check())
  42.         {
  43.             return false;
  44.         }
  45.  
  46.         if (!array_key_exists($rel, $this->_links) || !$overwrite)
  47.         {
  48.             $this->_links[$rel] = $link;
  49.         }
  50.         elseif (array_key_exists($rel, $this->_links) && !$overwrite)
  51.         {
  52.             if (!is_array($this->_links[$rel]))
  53.             {
  54.                 $this->_links[$rel] = array($this->_links[$rel]);
  55.             }
  56.  
  57.             $this->_links[$rel][] = $link;
  58.         }
  59.         else
  60.         {
  61.             return false;
  62.         }
  63.     }
  64.  
  65.     /**
  66.      * Add multiple links to the links collection
  67.      *
  68.      * @param   string   $rel        The relation of the links to the document. See RFC 5988.
  69.      * @param   array    $links      An array of FOFHalLink objects
  70.      * @param   boolean  $overwrite  When false and a link of $rel relation exists, an array
  71.      *                                of links is created. Otherwise the existing link is
  72.      *                                overwriten with the new one
  73.      *
  74.      * @return  boolean  True if the link was added to the collection
  75.      */
  76.     public function addLinks($rel, array $links, $overwrite = true)
  77.     {
  78.         if (empty($links))
  79.         {
  80.             return false;
  81.         }
  82.  
  83.         foreach ($links as $link)
  84.         {
  85.             if ($link instanceof FOFHalLink)
  86.             {
  87.                 $this->addLink($rel, $link, $overwrite);
  88.             }
  89.         }
  90.     }
  91.  
  92.     /**
  93.      * Returns the collection of links
  94.      *
  95.      * @param   string  $rel  Optional; the relation to return the links for
  96.      *
  97.      * @return  array|FOFHalLink
  98.      */
  99.     public function getLinks($rel = null)
  100.     {
  101.         if (empty($rel))
  102.         {
  103.             return $this->_links;
  104.         }
  105.         elseif (isset($this->_links[$rel]))
  106.         {
  107.             return $this->_links[$rel];
  108.         }
  109.         else
  110.         {
  111.             return array();
  112.         }
  113.     }
  114. }

Documentation generated on Tue, 19 Nov 2013 15:07:10 +0100 by phpDocumentor 1.4.3