Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Extension;
Chris@0: 
Chris@0: /**
Chris@0:  * Manages the list of available themes.
Chris@0:  */
Chris@0: interface ThemeHandlerInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Installs a given list of themes.
Chris@0:    *
Chris@0:    * @param array $theme_list
Chris@0:    *   An array of theme names.
Chris@0:    * @param bool $install_dependencies
Chris@0:    *   (optional) If TRUE, dependencies will automatically be installed in the
Chris@0:    *   correct order. This incurs a significant performance cost, so use FALSE
Chris@0:    *   if you know $theme_list is already complete and in the correct order.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   Whether any of the given themes have been installed.
Chris@0:    *
Chris@0:    * @throws \Drupal\Core\Extension\ExtensionNameLengthException
Chris@0:    *   Thrown when the theme name is to long.
Chris@0:    *
Chris@0:    * @deprecated in Drupal 8.0.x-dev and will be removed before Drupal 9.0.0.
Chris@0:    *   Use the theme_installer service instead.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Extension\ThemeInstallerInterface::install
Chris@0:    */
Chris@0:   public function install(array $theme_list, $install_dependencies = TRUE);
Chris@0: 
Chris@0:   /**
Chris@0:    * Uninstalls a given list of themes.
Chris@0:    *
Chris@0:    * Uninstalling a theme removes all related configuration (like blocks) and
Chris@0:    * invokes the 'themes_uninstalled' hook.
Chris@0:    *
Chris@0:    * @param array $theme_list
Chris@0:    *   The themes to uninstall.
Chris@0:    *
Chris@17:    * @throws \Drupal\Core\Extension\Exception\UninstalledExtensionException
Chris@17:    *   Thrown when you try to uninstall a theme that wasn't installed.
Chris@0:    *
Chris@0:    * @see hook_themes_uninstalled()
Chris@0:    *
Chris@0:    * @deprecated in Drupal 8.0.x-dev and will be removed before Drupal 9.0.0.
Chris@0:    *   Use the theme_installer service instead.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Extension\ThemeInstallerInterface::uninstall
Chris@0:    */
Chris@0:   public function uninstall(array $theme_list);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a list of currently installed themes.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Extension\Extension[]
Chris@0:    *   An associative array of the currently installed themes. The keys are the
Chris@18:    *   themes' machine names and the values are Extension objects having the
Chris@18:    *   following properties:
Chris@0:    *   - filename: The filepath and name of the .info.yml file.
Chris@0:    *   - name: The machine name of the theme.
Chris@0:    *   - status: 1 for installed, 0 for uninstalled themes.
Chris@0:    *   - info: The contents of the .info.yml file.
Chris@0:    *   - stylesheets: A two dimensional array, using the first key for the
Chris@0:    *     media attribute (e.g. 'all'), the second for the name of the file
Chris@0:    *     (e.g. style.css). The value is a complete filepath (e.g.
Chris@0:    *     themes/bartik/style.css). Not set if no stylesheets are defined in the
Chris@0:    *     .info.yml file.
Chris@0:    *   - scripts: An associative array of JavaScripts, using the filename as key
Chris@0:    *     and the complete filepath as value. Not set if no scripts are defined
Chris@0:    *     in the .info.yml file.
Chris@0:    *   - prefix: The base theme engine prefix.
Chris@0:    *   - engine: The machine name of the theme engine.
Chris@0:    *   - base_theme: If this is a sub-theme, the machine name of the base theme
Chris@0:    *     defined in the .info.yml file. Otherwise, the element is not set.
Chris@0:    *   - base_themes: If this is a sub-theme, an associative array of the
Chris@0:    *     base-theme ancestors of this theme, starting with this theme's base
Chris@0:    *     theme, then the base theme's own base theme, etc. Each entry has an
Chris@0:    *     array key equal to the theme's machine name, and a value equal to the
Chris@0:    *     human-readable theme name; if a theme with matching machine name does
Chris@0:    *     not exist in the system, the value will instead be NULL (and since the
Chris@0:    *     system would not know whether that theme itself has a base theme, that
Chris@0:    *     will end the array of base themes). This is not set if the theme is not
Chris@0:    *     a sub-theme.
Chris@0:    *   - sub_themes: An associative array of themes on the system that are
Chris@0:    *     either direct sub-themes (that is, they declare this theme to be
Chris@0:    *     their base theme), direct sub-themes of sub-themes, etc. The keys are
Chris@0:    *     the themes' machine names, and the values are the themes'
Chris@0:    *     human-readable names. This element is not set if there are no themes on
Chris@0:    *     the system that declare this theme as their base theme.
Chris@0:    */
Chris@0:   public function listInfo();
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds a theme extension to the internal listing.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Extension\Extension $theme
Chris@0:    *   The theme extension.
Chris@0:    */
Chris@0:   public function addTheme(Extension $theme);
Chris@0: 
Chris@0:   /**
Chris@0:    * Refreshes the theme info data of currently installed themes.
Chris@0:    *
Chris@0:    * Modules can alter theme info, so this is typically called after a module
Chris@0:    * has been installed or uninstalled.
Chris@0:    */
Chris@0:   public function refreshInfo();
Chris@0: 
Chris@0:   /**
Chris@0:    * Resets the internal state of the theme handler.
Chris@0:    */
Chris@0:   public function reset();
Chris@0: 
Chris@0:   /**
Chris@0:    * Scans and collects theme extension data and their engines.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Extension\Extension[]
Chris@0:    *   An associative array of theme extensions.
Chris@0:    */
Chris@0:   public function rebuildThemeData();
Chris@0: 
Chris@0:   /**
Chris@0:    * Finds all the base themes for the specified theme.
Chris@0:    *
Chris@0:    * Themes can inherit templates and function implementations from earlier
Chris@0:    * themes.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Extension\Extension[] $themes
Chris@0:    *   An array of available themes.
Chris@0:    * @param string $theme
Chris@0:    *   The name of the theme whose base we are looking for.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Returns an array of all of the theme's ancestors; the first element's
Chris@0:    *   value will be NULL if an error occurred.
Chris@0:    */
Chris@0:   public function getBaseThemes(array $themes, $theme);
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the human readable name of a given theme.
Chris@0:    *
Chris@0:    * @param string $theme
Chris@0:    *   The machine name of the theme which title should be shown.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   Returns the human readable name of the theme.
Chris@17:    *
Chris@17:    * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
Chris@17:    *   When the specified theme does not exist.
Chris@0:    */
Chris@0:   public function getName($theme);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the default theme.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The default theme.
Chris@0:    */
Chris@0:   public function getDefault();
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets a new default theme.
Chris@0:    *
Chris@0:    * @param string $theme
Chris@0:    *   The new default theme.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    *
Chris@0:    * @deprecated in Drupal 8.2.x-dev and will be removed before Drupal 9.0.0.
Chris@0:    *   Use
Chris@0:    *   @code
Chris@0:    *     \Drupal::configFactory()
Chris@0:    *       ->getEditable('system.theme')
Chris@0:    *       ->set('default', $theme)
Chris@0:    *       ->save();
Chris@0:    *   @endcode
Chris@0:    */
Chris@0:   public function setDefault($theme);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns an array of directories for all installed themes.
Chris@0:    *
Chris@0:    * Useful for tasks such as finding a file that exists in all theme
Chris@0:    * directories.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    */
Chris@0:   public function getThemeDirectories();
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines whether a given theme is installed.
Chris@0:    *
Chris@0:    * @param string $theme
Chris@0:    *   The name of the theme (without the .theme extension).
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the theme is installed.
Chris@0:    */
Chris@0:   public function themeExists($theme);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a theme extension object from the currently active theme list.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The name of the theme to return.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Extension\Extension
Chris@0:    *   An extension object.
Chris@0:    *
Chris@17:    * @throws \Drupal\Core\Extension\Extension\UnknownExtensionException
Chris@0:    *   Thrown when the requested theme does not exist.
Chris@0:    */
Chris@0:   public function getTheme($name);
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines if a theme should be shown in the user interface.
Chris@0:    *
Chris@0:    * To be shown in the UI the theme has to be installed. If the theme is hidden
Chris@0:    * it will not be shown unless it is the default or admin theme.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The name of the theme to check.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the theme should be shown in the UI, FALSE if not.
Chris@0:    */
Chris@0:   public function hasUi($name);
Chris@0: 
Chris@0: }