[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Database Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Database;
  10  
  11  /**
  12   * Class defining the fetch mode for prepared statements
  13   *
  14   * The values of the constants in this class match the `PDO::FETCH_*` constants.
  15   *
  16   * @since  2.0.0
  17   */
  18  final class FetchMode
  19  {
  20      /**
  21       * Specifies that the fetch method shall return each row as an array indexed by column name as returned in the corresponding result set.
  22       *
  23       * If the result set contains multiple columns with the same name, the statement returns only a single value per column name.
  24       *
  25       * @var    integer
  26       * @since  2.0.0
  27       * @see    \PDO::FETCH_ASSOC
  28       */
  29      public const ASSOCIATIVE = 2;
  30  
  31      /**
  32       * Specifies that the fetch method shall return each row as an array indexed by column number as returned in the corresponding result set,
  33       * starting at column 0.
  34       *
  35       * @var    integer
  36       * @since  2.0.0
  37       * @see    \PDO::FETCH_NUM
  38       */
  39      public const NUMERIC = 3;
  40  
  41      /**
  42       * Specifies that the fetch method shall return each row as an array indexed by both column name and number as returned in the corresponding
  43       * result set, starting at column 0.
  44       *
  45       * @var    integer
  46       * @since  2.0.0
  47       * @see    \PDO::FETCH_BOTH
  48       */
  49      public const MIXED = 4;
  50  
  51      /**
  52       * Specifies that the fetch method shall return each row as an object with property names that correspond to the column names returned in the
  53       * result set.
  54       *
  55       * @var    integer
  56       * @since  2.0.0
  57       * @see    \PDO::FETCH_OBJ
  58       */
  59      public const STANDARD_OBJECT = 5;
  60  
  61      /**
  62       * Specifies that the fetch method shall return only a single requested column from the next row in the result set.
  63       *
  64       * @var    integer
  65       * @since  2.0.0
  66       * @see    \PDO::FETCH_COLUMN
  67       */
  68      public const COLUMN = 7;
  69  
  70      /**
  71       * Specifies that the fetch method shall return a new instance of the requested class, mapping the columns to named properties in the class.
  72       *
  73       * @var    integer
  74       * @since  2.0.0
  75       * @see    \PDO::FETCH_CLASS
  76       */
  77      public const CUSTOM_OBJECT = 8;
  78  
  79      /**
  80       * Private constructor to prevent instantiation of this class
  81       *
  82       * @since   2.0.0
  83       */
  84  	private function __construct()
  85      {
  86      }
  87  }