class FileGroup in Realistic Dummy Content 8

Represents files as groups.

For example:

1.txt 2.txt 3.txt

will be represented as three files, but

1.txt 2.txt 2.attribute.txt 2.attribute1.txt 3.txt

will also be represented as three files, but the second one will have two attributes, attribute and attribute1.

This allows us to defined attributes or metadata for certain file types, for example:

realistic_dummy_content/fields/node/article/

• body/
  • ipsum.txt
  • ipsum.format.txt
  • lorem.txt

• field_image/
  • 1.jpg
  • 2.jpg
  • 2.alt.txt

In the above example, `realistic_dummy_content` sees two possible body values, _one of which with a specific input format_; and two possible images, _one of which with a specific alt text_. Attributes are never compulsory, and in the case where an attribute is needed, a reasonable fallback value is used, for example `filtered_html` will be used if no format is specified for the body.

Hierarchy

• class \Drupal\realistic_dummy_content_api\environments\FileGroup

1 file declares its use of FileGroup

Environment.php in api/src/environments/Environment.php

Define autoload class.

File

api/src/environments/FileGroup.php, line 53

Define autoload class.

Namespace

Drupal\realistic_dummy_content_api\environments

class FileGroup {
  private $radical;
  private $file;
  private $attributes;

  /**
   * Constructor for a file object
   *
   * Several actual files can reside in the same file object if their names have
   * the same radical, for example:
   *
   *   a.b.c
   *   a.c
   *
   * have the same radical, a.c.
   *
   * @param $radical
   *   The radical file name, which may or may not exist on the filesystem.
   *   For example, if the file is called a.b.c, the radical is a.c, even though
   *   a.c does not exist on the filesystem.
   * @param $file
   *   The radical drupal file object, or NULL if it does not exist on the file system.
   * @param $attributes
   *   An array in the format:
   *    array(
   *     'attribute_name' => [file object],
   *   ),
   *   (where attribute_name can be "b" as in the above example.)
   *
   * @throws
   *   Exception
   */
  function __construct($radical, $file, $attributes) {
    if (!is_string($radical)) {
      throw new Exception('Please use string for radical');
    }
    if ($file && !is_object($file)) {
      throw new Exception('Please use NULL or object for file');
    }
    if (!is_array($attributes)) {
      throw new Exception('Please use array for attributes');
    }
    $this->radical = $radical;
    $this->file = $file;
    $this->attributes = $attributes;
  }

  /**
   * Getter for radical.
   */
  public function GetRadical() {
    return $this->radical;
  }

  /**
   * Getter for file.
   */
  public function GetFile() {
    return $this->file;
  }

  /**
   * Getter for attributes.
   */
  public function GetAttributes() {
    return $this->attributes;
  }

  /**
   * Returns the value of the radical file if one exists.
   *
   * @return
   *   NULL if a radical file does not exist, if it does not have contents, or
   *   if an error occurred. Otherwise returns the contents of the file.
   */
  function Value() {
    try {
      $file = $this
        ->GetFile();
      if (isset($file->uri)) {
        return trim(Environment::Get()
          ->file_get_contents($file->uri));
      }
      else {
        return NULL;
      }
    } catch (\Exception $e) {
      return NULL;
    }
  }

  /**
   * Return the value for an attribute name if possible
   *
   * @param $name
   *   The attribute name to fetch
   *
   * @param $default
   *
   * @return
   *   The default value if the attribute does not exist, if it's empty or if an error
   *   occurred, otherwise the contents of the attributes file.
   */
  function Attribute($name, $default = NULL) {
    try {
      $attributes = $this
        ->GetAttributes();
      if (isset($attributes[$name]->uri)) {
        $return = trim(Environment::Get()
          ->file_get_contents($attributes[$name]->uri));
        return $return;
      }
      else {
        return $default;
      }
    } catch (\Exception $e) {
      return $default;
    }
  }

  /**
   * Returns the extension of the radical filename.
   *
   * @return
   *   An extension, can be empty.
   */
  function GetRadicalExtension() {
    $filename = $this
      ->GetRadical();
    $extension = pathinfo($filename, PATHINFO_EXTENSION);
    if (!$extension) {
      throw new Exception('Files require extensions.');
    }
    return $extension;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileGroup::$attributes	private	property
FileGroup::$file	private	property
FileGroup::$radical	private	property
FileGroup::Attribute		function	Return the value for an attribute name if possible
FileGroup::GetAttributes	public	function	Getter for attributes.
FileGroup::GetFile	public	function	Getter for file.
FileGroup::GetRadical	public	function	Getter for radical.
FileGroup::GetRadicalExtension		function	Returns the extension of the radical filename.
FileGroup::Value		function	Returns the value of the radical file if one exists.
FileGroup::__construct		function	Constructor for a file object