interface TargetInterface in Drupal 7 to 8/9 Module Upgrader 8

Represents a Drupal 7 module being run through the DMU.

Hierarchy

• interface \Drupal\drupalmoduleupgrader\TargetInterface

99 files declare their use of TargetInterface

Blocks.php in src/Plugin/DMU/Converter/Blocks.php

CacheGet.php in src/Plugin/DMU/Converter/Functions/CacheGet.php

CacheSet.php in src/Plugin/DMU/Converter/Functions/CacheSet.php

CommentLoad.php in src/Plugin/DMU/Converter/Functions/CommentLoad.php

ContentRoute.php in src/Plugin/DMU/Routing/ContentRoute.php

... See full list

File

src/TargetInterface.php, line 10

Namespace

Drupal\drupalmoduleupgrader

interface TargetInterface {

  /**
   * Returns the machine name of the target module.
   *
   * @return string
   */
  public function id();

  /**
   * Returns the base path of the target module.
   *
   * @return string
   */
  public function getBasePath();

  /**
   * Returns the path to a particular file, relative to the CWD.
   *
   * @param string $file
   *   The file, relative to the module root. If $file begins with a period,
   *   it will be prefixed with the module name (.module --> MODULE.module)
   *
   * @return string
   */
  public function getPath($file);

  /**
   * Returns a fully configured Finder which can iterate over the target
   * module's code files. Any file type which doesn't contain PHP code
   * should be ignored.
   *
   * @return \Symfony\Component\Finder\Finder
   */
  public function getFinder();

  /**
   * Returns an indexer for this target.
   *
   * @param string $which
   *   The type of indexer to get. Should be the ID of an indexer plugin.
   *
   * @return IndexerInterface
   */
  public function getIndexer($which);

  /**
   * Returns services defined by the target module.
   *
   * @return \Doctrine\Common\Collections\ArrayCollection
   */
  public function getServices();

  /**
   * Returns if the target module implements a particular hook.
   *
   * @param string $hook
   *   The hook to look for, without the hook_ prefix.
   *
   * @return bool
   */
  public function implementsHook($hook);

  /**
   * Executes a hook implementation and returns the result.
   *
   * @param string $hook
   *   The hook to execute, without the hook_ prefix.
   * @param array $arguments
   *   Additional parameters to pass to the hook implementation.
   *
   * @return mixed
   *
   * @throws
   *  \InvalidArgumentException if the module doesn't implement the hook.
   *  \LogicException if the hook contains non-executable logic.
   */
  public function executeHook($hook, array $arguments = []);

  /**
   * Parses a file into a syntax tree, keeping a reference to it, and
   * returns it.
   *
   * @param string $file
   *   The path of the file to open, relative to the CWD.
   *
   * @return \Pharborist\RootNode|null
   */
  public function open($file);

  /**
   * Saves the file in which a particular node appears.
   *
   * @param \Pharborist\Node|null $node
   *   The node to save. This can be positioned anywhere in the
   *   syntax tree. If NULL, all open files will be saved.
   *
   * @throws \Drupal\drupalmoduleupgrader\IOException
   */
  public function save(Node $node = NULL);

  /**
   * Creates a new, empty document.
   *
   * @param string $file
   *   The path of the file to create, relative to the CWD.
   *
   * @return \Pharborist\RootNode
   */
  public function create($file);

  /**
   * Clears internal references to all open documents, discarding changes.
   */
  public function flush();

}

Members

Name	Modifiers	Type	Description	Overrides
TargetInterface::create	public	function	Creates a new, empty document.	1
TargetInterface::executeHook	public	function	Executes a hook implementation and returns the result.	1
TargetInterface::flush	public	function	Clears internal references to all open documents, discarding changes.	1
TargetInterface::getBasePath	public	function	Returns the base path of the target module.	1
TargetInterface::getFinder	public	function	Returns a fully configured Finder which can iterate over the target module's code files. Any file type which doesn't contain PHP code should be ignored.	1
TargetInterface::getIndexer	public	function	Returns an indexer for this target.	1
TargetInterface::getPath	public	function	Returns the path to a particular file, relative to the CWD.	1
TargetInterface::getServices	public	function	Returns services defined by the target module.	1
TargetInterface::id	public	function	Returns the machine name of the target module.	1
TargetInterface::implementsHook	public	function	Returns if the target module implements a particular hook.	1
TargetInterface::open	public	function	Parses a file into a syntax tree, keeping a reference to it, and returns it.	1
TargetInterface::save	public	function	Saves the file in which a particular node appears.	1