[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\Updater;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Data object representing a download source given as part of an update's `<downloads>` element
  18   *
  19   * @since  3.8.3
  20   */
  21  class DownloadSource
  22  {
  23      /**
  24       * Defines a BZIP2 download package
  25       *
  26       * @var    string
  27       * @since  3.8.4
  28       */
  29      public const FORMAT_TAR_BZIP = 'bz2';
  30  
  31      /**
  32       * Defines a TGZ download package
  33       *
  34       * @var    string
  35       * @since  3.8.4
  36       */
  37      public const FORMAT_TAR_GZ = 'gz';
  38  
  39      /**
  40       * Defines a ZIP download package
  41       *
  42       * @var    string
  43       * @since  3.8.3
  44       */
  45      public const FORMAT_ZIP = 'zip';
  46  
  47      /**
  48       * Defines a full package download type
  49       *
  50       * @var    string
  51       * @since  3.8.3
  52       */
  53      public const TYPE_FULL = 'full';
  54  
  55      /**
  56       * Defines a patch package download type
  57       *
  58       * @var    string
  59       * @since  3.8.4
  60       */
  61      public const TYPE_PATCH = 'patch';
  62  
  63      /**
  64       * Defines an upgrade package download type
  65       *
  66       * @var    string
  67       * @since  3.8.4
  68       */
  69      public const TYPE_UPGRADE = 'upgrade';
  70  
  71      /**
  72       * The download type
  73       *
  74       * @var    string
  75       * @since  3.8.3
  76       */
  77      public $type = self::TYPE_FULL;
  78  
  79      /**
  80       * The download file's format
  81       *
  82       * @var    string
  83       * @since  3.8.3
  84       */
  85      public $format = self::FORMAT_ZIP;
  86  
  87      /**
  88       * The URL to retrieve the package from
  89       *
  90       * @var    string
  91       * @since  3.8.3
  92       */
  93      public $url;
  94  }