class ScaffoldFileInfo in Drupal 9

Data object that keeps track of one scaffold file.

Scaffold files are identified primarily by their destination path. Each scaffold file also has an 'operation' object that controls how the scaffold file will be placed (e.g. via copy or symlink, or maybe by appending multiple files together). The operation may have one or more source files.

@internal

Hierarchy

• class \Drupal\Composer\Plugin\Scaffold\ScaffoldFileInfo

1 file declares its use of ScaffoldFileInfo

ScaffoldFileCollection.php in composer/Plugin/Scaffold/Operations/ScaffoldFileCollection.php

File

composer/Plugin/Scaffold/ScaffoldFileInfo.php, line 18

Namespace

Drupal\Composer\Plugin\Scaffold

class ScaffoldFileInfo {

  /**
   * The path to the destination.
   *
   * @var \Drupal\Composer\Plugin\Scaffold\ScaffoldFilePath
   */
  protected $destination;

  /**
   * The operation used to create the destination.
   *
   * @var \Drupal\Composer\Plugin\Scaffold\Operations\OperationInterface
   */
  protected $op;

  /**
   * Constructs a ScaffoldFileInfo object.
   *
   * @param \Drupal\Composer\Plugin\Scaffold\ScaffoldFilePath $destination
   *   The full and relative paths to the destination file and the package
   *   defining it.
   * @param \Drupal\Composer\Plugin\Scaffold\Operations\OperationInterface $op
   *   Operations object that will handle scaffolding operations.
   */
  public function __construct(ScaffoldFilePath $destination, OperationInterface $op) {
    $this->destination = $destination;
    $this->op = $op;
  }

  /**
   * Gets the Scaffold operation.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\Operations\OperationInterface
   *   Operations object that handles scaffolding (copy, make symlink, etc).
   */
  public function op() {
    return $this->op;
  }

  /**
   * Gets the package name.
   *
   * @return string
   *   The name of the package this scaffold file info was collected from.
   */
  public function packageName() {
    return $this->destination
      ->packageName();
  }

  /**
   * Gets the destination.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\ScaffoldFilePath
   *   The scaffold path to the destination file.
   */
  public function destination() {
    return $this->destination;
  }

  /**
   * Determines if this scaffold file has been overridden by another package.
   *
   * @param string $providing_package
   *   The name of the package that provides the scaffold file at this location,
   *   as returned by self::findProvidingPackage()
   *
   * @return bool
   *   Whether this scaffold file if overridden or removed.
   */
  public function overridden($providing_package) {
    return $this
      ->packageName() !== $providing_package;
  }

  /**
   * Replaces placeholders in a message.
   *
   * @param string $message
   *   Message with placeholders to fill in.
   * @param array $extra
   *   Additional data to merge with the interpolator.
   * @param mixed $default
   *   Default value to use for missing placeholders, or FALSE to keep them.
   *
   * @return string
   *   Interpolated string with placeholders replaced.
   */
  public function interpolate($message, array $extra = [], $default = FALSE) {
    $interpolator = $this->destination
      ->getInterpolator();
    return $interpolator
      ->interpolate($message, $extra, $default);
  }

  /**
   * Moves a single scaffold file from source to destination.
   *
   * @param \Composer\IO\IOInterface $io
   *   The scaffold file to be processed.
   * @param \Drupal\Composer\Plugin\Scaffold\ScaffoldOptions $options
   *   Assorted operational options, e.g. whether the destination should be a
   *   symlink.
   *
   * @return \Drupal\Composer\Plugin\Scaffold\Operations\ScaffoldResult
   *   The scaffold result.
   */
  public function process(IOInterface $io, ScaffoldOptions $options) {
    return $this
      ->op()
      ->process($this->destination, $io, $options);
  }

  /**
   * Returns TRUE if the target does not exist or has changed.
   *
   * @return bool
   */
  public final function hasChanged() {
    $path = $this
      ->destination()
      ->fullPath();
    if (!file_exists($path)) {
      return TRUE;
    }
    return $this
      ->op()
      ->contents() !== file_get_contents($path);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ScaffoldFileInfo::$destination	protected	property	The path to the destination.
ScaffoldFileInfo::$op	protected	property	The operation used to create the destination.
ScaffoldFileInfo::destination	public	function	Gets the destination.
ScaffoldFileInfo::hasChanged	final public	function	Returns TRUE if the target does not exist or has changed.
ScaffoldFileInfo::interpolate	public	function	Replaces placeholders in a message.
ScaffoldFileInfo::op	public	function	Gets the Scaffold operation.
ScaffoldFileInfo::overridden	public	function	Determines if this scaffold file has been overridden by another package.
ScaffoldFileInfo::packageName	public	function	Gets the package name.
ScaffoldFileInfo::process	public	function	Moves a single scaffold file from source to destination.
ScaffoldFileInfo::__construct	public	function	Constructs a ScaffoldFileInfo object.