class FileOperations in AT Tools 8

Hierarchy

• class \Drupal\at_theme_generator\File\FileOperations

1 file declares its use of FileOperations

GenerateForm.php in at_theme_generator/src/Form/GenerateForm.php

Generator form.

File

at_theme_generator/src/File/FileOperations.php, line 12

Contains \Drupal\at_theme_generator\File\FileOperations

Namespace

Drupal\at_theme_generator\File

class FileOperations {

  /**
   * Rename old file to new file.
   *
   * @param string $old_file
   *   Source file to be renamed.
   * @param string $new_file
   *   The new file name.
   */
  public function fileRename($old_file, $new_file) {
    if (file_exists($old_file)) {
      rename($old_file, $new_file);
    }
  }

  /**
   * Replace strings in a file.
   *
   * @param $file_path
   *   The file to be processed (haystack).
   * @param $find
   *   The target string (needle).
   * @param $replace
   *   The replacement string.
   */
  public function fileStrReplace($file_path, $find, $replace) {
    if (file_exists($file_path)) {
      $file_contents = file_get_contents($file_path);
      $file_contents = str_replace($find, $replace, $file_contents);
      file_put_contents($file_path, $file_contents);
    }
  }

  /**
   * Copy and rename a file.
   *
   * @param array $file_paths
   *   Associative array:
   *    - copy_source => "path to the source file"
   *    - copy_dest => "the destination path"
   *    - rename_oldname => "the old file name"
   *    - rename_newname => "the new file name"
   */
  public function fileCopyRename($file_paths) {
    if (file_exists($file_paths['copy_source'])) {
      copy($file_paths['copy_source'], $file_paths['copy_dest']);
    }
    if (file_exists($file_paths['rename_oldname'])) {
      rename($file_paths['rename_oldname'], $file_paths['rename_newname']);
    }
  }

  /**
   * Replace old file content with new content.
   *
   * @param string $data
   *   Content to replace old file contents.
   * @param string $file_path
   *   Path to file to be replaced.
   */
  public function fileReplace($data, $file_path) {
    if (file_exists($file_path)) {
      file_unmanaged_save_data($data, $file_path, FILE_EXISTS_REPLACE);
    }
  }

  /**
   * Generate an .info.yml file that can be parsed by drupal_parse_info_file().
   *
   * @param array $data
   *   The associative array data to build the .info.yml file.
   * @return string
   *   A string corresponding to $data encoded in the .yml format.
   *
   * @see drupal_parse_info_file()
   */
  public function fileBuildInfoYml(array $data) {
    $info = Yaml::encode($data);
    return $info;
  }

  /**
   * Compare two files. First compare file size, then
   * compare their contents. Return true if the files
   * are the same, otherwise false.
   *
   * @param string $afile
   *   Path to 'a' file.
   * @param string $bfile
   *   Path to 'b' file.
   * @return array $results
   */
  public function fileCompare($afile, $bfile) {

    // Check if filesize is different
    if (filesize($afile) !== filesize($bfile)) {
      return false;
    }

    // Check if content is different
    $aopen = fopen($afile, 'rb');
    $bopen = fopen($bfile, 'rb');
    $result = true;
    while (!feof($aopen)) {
      if (fread($aopen, 8192) != fread($bopen, 8192)) {
        $result = false;
        break;
      }
    }
    fclose($aopen);
    fclose($bopen);
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileOperations::fileBuildInfoYml	public	function	Generate an .info.yml file that can be parsed by drupal_parse_info_file().
FileOperations::fileCompare	public	function	Compare two files. First compare file size, then compare their contents. Return true if the files are the same, otherwise false.
FileOperations::fileCopyRename	public	function	Copy and rename a file.
FileOperations::fileRename	public	function	Rename old file to new file.
FileOperations::fileReplace	public	function	Replace old file content with new content.
FileOperations::fileStrReplace	public	function	Replace strings in a file.