88 lines
1.9 KiB
YAML
88 lines
1.9 KiB
YAML
name: BundleEntryReaderInterface
|
|
class_comment: null
|
|
dependencies:
|
|
- name: MissingResourceException
|
|
type: class
|
|
source: Symfony\Component\Intl\Exception\MissingResourceException
|
|
properties: []
|
|
methods:
|
|
- name: readEntry
|
|
visibility: public
|
|
parameters:
|
|
- name: path
|
|
- name: locale
|
|
- name: indices
|
|
- name: fallback
|
|
default: 'true'
|
|
comment: '# * Reads individual entries of a resource file.
|
|
|
|
# *
|
|
|
|
# * @author Bernhard Schussek <bschussek@gmail.com>
|
|
|
|
# *
|
|
|
|
# * @internal
|
|
|
|
# */
|
|
|
|
# interface BundleEntryReaderInterface extends BundleReaderInterface
|
|
|
|
# {
|
|
|
|
# /**
|
|
|
|
# * Reads an entry from a resource bundle.
|
|
|
|
# *
|
|
|
|
# * An entry can be selected from the resource bundle by passing the path
|
|
|
|
# * to that entry in the bundle. For example, if the bundle is structured
|
|
|
|
# * like this:
|
|
|
|
# *
|
|
|
|
# * TopLevel
|
|
|
|
# * NestedLevel
|
|
|
|
# * Entry: Value
|
|
|
|
# *
|
|
|
|
# * Then the value can be read by calling:
|
|
|
|
# *
|
|
|
|
# * $reader->readEntry(''...'', ''en'', [''TopLevel'', ''NestedLevel'', ''Entry'']);
|
|
|
|
# *
|
|
|
|
# * @param string $path The path to the resource bundle
|
|
|
|
# * @param string[] $indices The indices to read from the bundle
|
|
|
|
# * @param bool $fallback Whether to merge the value with the value from
|
|
|
|
# * the fallback locale (e.g. "en" for "en_GB").
|
|
|
|
# * Only applicable if the result is multivalued
|
|
|
|
# * (i.e. array or \ArrayAccess) or cannot be found
|
|
|
|
# * in the requested locale.
|
|
|
|
# *
|
|
|
|
# * @return mixed returns an array or {@link \ArrayAccess} instance for
|
|
|
|
# * complex data and a scalar value for simple data
|
|
|
|
# *
|
|
|
|
# * @throws MissingResourceException If the indices cannot be accessed'
|
|
traits:
|
|
- Symfony\Component\Intl\Exception\MissingResourceException
|
|
interfaces: []
|