Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Extension;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for classes that parses Drupal's info.yml files.
Chris@0:  */
Chris@0: interface InfoParserInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Parses Drupal module, theme and profile .info.yml files.
Chris@0:    *
Chris@0:    * Info files are NOT for placing arbitrary theme and module-specific
Chris@0:    * settings. Use Config::get() and Config::set()->save() for that. Info files
Chris@0:    * are formatted as YAML. If the 'version' key is set to 'VERSION' in any info
Chris@0:    * file, then the value will be substituted with the current version of Drupal
Chris@0:    * core.
Chris@0:    *
Chris@0:    * Information stored in all .info.yml files:
Chris@0:    * - name: The real name of the module for display purposes. (Required)
Chris@0:    * - description: A brief description of the module.
Chris@0:    * - type: whether it is for a module or theme. (Required)
Chris@0:    *
Chris@0:    * Information stored in a module .info.yml file:
Chris@0:    * - dependencies: An array of dependency strings. Each is in the form
Chris@0:    *   'project:module (versions)'; with the following meanings:
Chris@0:    *   - project: (optional) Project shortname, recommended to ensure
Chris@0:    *     uniqueness, if the module is part of a project hosted on drupal.org.
Chris@0:    *     If omitted, also omit the : that follows. The project name is currently
Chris@0:    *     ignored by Drupal core but is used for automated testing.
Chris@0:    *   - module: (required) Module shortname within the project.
Chris@0:    *   - (versions): Version information, consisting of one or more
Chris@0:    *     comma-separated operator/value pairs or simply version numbers, which
Chris@0:    *     can contain "x" as a wildcard. Examples: (>=8.22, <8.28), (8.x-3.x).
Chris@0:    * - package: The name of the package of modules this module belongs to.
Chris@0:    *
Chris@0:    * See forum.info.yml for an example of a module .info.yml file.
Chris@0:    *
Chris@0:    * Information stored in a theme .info.yml file:
Chris@0:    * - screenshot: Path to screenshot relative to the theme's .info.yml file.
Chris@0:    * - engine: Theme engine; typically twig.
Chris@0:    * - base theme: Name of a base theme, if applicable.
Chris@0:    * - regions: Listed regions.
Chris@0:    * - features: Features available.
Chris@0:    * - stylesheets: Theme stylesheets.
Chris@0:    * - scripts: Theme scripts.
Chris@0:    *
Chris@0:    * See bartik.info.yml for an example of a theme .info.yml file.
Chris@0:    *
Chris@17:    * For information stored in a profile .info.yml file see
Chris@17:    * install_profile_info().
Chris@17:    *
Chris@0:    * @param string $filename
Chris@0:    *   The file we are parsing. Accepts file with relative or absolute path.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The info array.
Chris@0:    *
Chris@0:    * @throws \Drupal\Core\Extension\InfoParserException
Chris@0:    *   Exception thrown if there is a parsing error or the .info.yml file does
Chris@0:    *   not contain a required key.
Chris@17:    *
Chris@17:    * @see install_profile_info()
Chris@0:    */
Chris@0:   public function parse($filename);
Chris@0: 
Chris@0: }