[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Document;
  11  
  12  use Psr\Link\EvolvableLinkProviderInterface;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('_JEXEC') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Joomla! Preload Manager Interface
  20   *
  21   * @since  4.0.0
  22   */
  23  interface PreloadManagerInterface
  24  {
  25      /**
  26       * Get the link provider
  27       *
  28       * @return  EvolvableLinkProviderInterface
  29       *
  30       * @since   4.0.0
  31       */
  32      public function getLinkProvider(): EvolvableLinkProviderInterface;
  33  
  34      /**
  35       * Set the link provider
  36       *
  37       * @param   EvolvableLinkProviderInterface  $linkProvider  The link provider
  38       *
  39       * @return  $this
  40       *
  41       * @since   4.0.0
  42       */
  43      public function setLinkProvider(EvolvableLinkProviderInterface $linkProvider);
  44  
  45      /**
  46       * Preloads a resource.
  47       *
  48       * @param   string  $uri         A public path
  49       * @param   array   $attributes  The attributes of this link (e.g. "array('as' => true)", "array('crossorigin' => 'use-credentials')")
  50       *
  51       * @return  void
  52       *
  53       * @since   4.0.0
  54       */
  55      public function preload(string $uri, array $attributes = []);
  56  
  57      /**
  58       * Resolves a resource origin as early as possible.
  59       *
  60       * @param   string  $uri         A public path
  61       * @param   array   $attributes  The attributes of this link (e.g. "array('as' => true)", "array('pr' => 0.5)")
  62       *
  63       * @return  void
  64       *
  65       * @since   4.0.0
  66       */
  67      public function dnsPrefetch(string $uri, array $attributes = []);
  68  
  69      /**
  70       * Initiates an early connection to a resource (DNS resolution, TCP handshake, TLS negotiation).
  71       *
  72       * @param   string  $uri         A public path
  73       * @param   array   $attributes  The attributes of this link (e.g. "array('as' => true)", "array('pr' => 0.5)")
  74       *
  75       * @return  void
  76       *
  77       * @since   4.0.0
  78       */
  79      public function preconnect(string $uri, array $attributes = []);
  80  
  81      /**
  82       * Indicates to the client that it should prefetch this resource.
  83       *
  84       * @param   string  $uri         A public path
  85       * @param   array   $attributes  The attributes of this link (e.g. "array('as' => true)", "array('pr' => 0.5)")
  86       *
  87       * @return  void
  88       *
  89       * @since   4.0.0
  90       */
  91      public function prefetch(string $uri, array $attributes = []);
  92  
  93      /**
  94       * Indicates to the client that it should prerender this resource.
  95       *
  96       * @param   string  $uri         A public path
  97       * @param   array   $attributes  The attributes of this link (e.g. "array('as' => true)", "array('pr' => 0.5)")
  98       *
  99       * @return  void
 100       *
 101       * @since   4.0.0
 102       */
 103      public function prerender(string $uri, array $attributes = []);
 104  }