vendor/symfony/intl/Symfony/Component/Intl/ResourceBundle/Reader/StructuredBundleReaderInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Intl\ResourceBundle\Reader;
  13
  14 /**
  15  * Reads individual entries of a resource file.
  16  *
  17  * @author Bernhard Schussek <bschussek@gmail.com>
  18  */
  19 interface StructuredBundleReaderInterface extends BundleReaderInterface
  20 {
  21     /**
  22      * Reads an entry from a resource bundle.
  23      *
  24      * An entry can be selected from the resource bundle by passing the path
  25      * to that entry in the bundle. For example, if the bundle is structured
  26      * like this:
  27      *
  28      *     TopLevel
  29      *         NestedLevel
  30      *             Entry: Value
  31      *
  32      * Then the value can be read by calling:
  33      *
  34      *     $reader->readEntry('...', 'en', array('TopLevel', 'NestedLevel', 'Entry'));
  35      *
  36      * @param string   $path     The path to the resource bundle.
  37      * @param string   $locale   The locale to read.
  38      * @param string[] $indices  The indices to read from the bundle.
  39      * @param Boolean  $fallback Whether to merge the value with the value from
  40      *                           the fallback locale (e.g. "en" for "en_GB").
  41      *                           Only applicable if the result is multivalued
  42      *                           (i.e. array or \ArrayAccess) or cannot be found
  43      *                           in the requested locale.
  44      *
  45      * @return mixed Returns an array or {@link \ArrayAccess} instance for
  46      *               complex data, a scalar value for simple data and NULL
  47      *               if the given path could not be accessed.
  48      */
  49     public function readEntry($path, $locale, array $indices, $fallback = true);
  50 }