interface RefineableCompilerContextInterface in Compiler 1.0.x

A refineable compiler context interface.

Copyright (C) 2021 Library Solutions, LLC (et al.).

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Hierarchy

• interface \Drupal\compiler\CompilerContextInterface
  • interface \Drupal\compiler\RefineableCompilerContextInterface extends \Drupal\compiler\ArrayAccess

File

src/RefineableCompilerContextInterface.php, line 15

Namespace

Drupal\compiler

interface RefineableCompilerContextInterface extends \ArrayAccess, CompilerContextInterface {

  /**
   * Set the machine name of the compiler plugin to use for this context.
   *
   * @param string $compiler
   *   The machine name of the compiler plugin to use for this context.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setCompiler(string $compiler) : self;

  /**
   * Set the user-defined data to use for this context.
   *
   * @param mixed $data
   *   The user-defined data to use for this context.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setData($data) : self;

  /**
   * Set a specific option to use for this context.
   *
   * @param string $name
   *   The name of the option to set.
   * @param mixed $value
   *   The value to set for the option.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setOption(string $name, $value) : self;

  /**
   * Set the options to use for this context.
   *
   * @param array $options
   *   The options to use for this context.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setOptions(array $options) : self;

}

Members

Name	Modifiers	Type	Description	Overrides
CompilerContextInterface::getCompiler	public	function	Get the machine name of the compiler plugin to use.	1
CompilerContextInterface::getData	public	function	Get arbitrary user-defined data to provide to the compiler.	1
CompilerContextInterface::getInputs	public	function	Get an interator containing the compiler inputs.	1
CompilerContextInterface::getOption	public	function	Get a specific compiler plugin configuration option.	1
CompilerContextInterface::getOptions	public	function	Get an associative array of compiler plugin configuration options.	1
RefineableCompilerContextInterface::setCompiler	public	function	Set the machine name of the compiler plugin to use for this context.	1
RefineableCompilerContextInterface::setData	public	function	Set the user-defined data to use for this context.	1
RefineableCompilerContextInterface::setOption	public	function	Set a specific option to use for this context.	1
RefineableCompilerContextInterface::setOptions	public	function	Set the options to use for this context.	1