You are here

Home » API reference » Realistic Dummy Content 8 » Attribute.php

abstract class Attribute in Realistic Dummy Content 8

Represents either a field or a property for an entity.

Fields are for example field_image, or field_body, and attributes are for example the title of a node and the image of a user.

We want to abstract away the differences so we can treat both the same way without using control statements in our code.

Hierarchy

  • class \Drupal\realistic_dummy_content_api\attributes\Attribute

Expanded class hierarchy of Attribute

2 files declare their use of Attribute
Field.php in api/src/attributes/Field.php
Define autoload class.
Property.php in api/src/attributes/Property.php
Define autoload class.

File

api/src/attributes/Attribute.php, line 23
Define autoload class.

Namespace

Drupal\realistic_dummy_content_api\attributes
View source 
abstract class Attribute {

  /**
   * The entity is set on construction and is a subclass of
   * EntityBase. It contains information about the
   * entity to which this field instance is attached.
   */
  private $entity;

  /**
   * The name of this attribuet, for example title, picture, field_image...
   */
  private $name;

  /**
   * Constructor.
   *
   * @param $entity
   *   Subclass of EntityBase.
   * @param $name
   *   The name of the field, for example body or picture or field_image
   */
  function __construct($entity, $name) {
    $this->entity = $entity;
    $this->name = $name;
  }

  /**
   * Getter for $this->name
   *
   * @return
   *   The name of the field, for example body or picture or field_image
   */
  function GetName() {
    return $this->name;
  }

  /**
   * Getter for $this->entity
   */
  function GetEntity() {
    return $this->entity;
  }

  /**
   * Returns a pseudo-random number.
   *
   * The number should be the same for the same entity, so we need to know the
   * entity.
   *
   * @return
   *   A random or sequential number.
   */
  function rand($start, $end) {
    return $this
      ->GetEntity()
      ->rand($start, $end);
  }

  /**
   * Returns the appropriate environment, real or testing.
   */
  function env() {
    return $this
      ->GetEntity()
      ->env();
  }

  /**
   * Gets the bundle of the associated entity.
   *
   * @return
   *   The bundle name.
   */
  function GetBundle() {
    return $this
      ->GetEntity()
      ->GetBundle();
  }

  /**
   * Gets the UID of the associated entity.
   *
   * @return
   *   The UID.
   */
  function GetUid() {
    return $this
      ->GetEntity()
      ->GetUid();
  }

  /**
   * Get the entity type of the associated entity.
   *
   * @return
   *   The entity type as a string, node or user for example.
   */
  function GetEntityType() {
    return $this
      ->GetEntity()
      ->GetType();
  }

  /**
   * Returns the type of this attribute.
   *
   * Drupal uses fields (managed by the field system) and properties to define
   * attributes of entities. Fields include body and field_image; properties include
   * title and the user picture.
   *
   * @return
   *   'property' or 'field_config'
   */
  abstract function GetType();

  /**
   * Changes this attribute by looking for data in files.
   *
   * Any module can define a file hierarchy to determine realistic dummy data
   * for this attribute. See the ./realistic_dummy_content/ folder for an example.
   *
   * This function checks the filesystem for compatible files (for example, only
   * image files are acceptable candidate files for field_image), choose one
   * through the selection mechanism (random or sequential), and then procedes to
   * change the data for the associated field for this class.
   */
  function Change() {
    $files = $this
      ->GetCandidateFiles();
    $this
      ->ChangeFromFiles($files);
  }

  /**
   * Given candidate files, change the value of this attribute based on one of them.
   *
   * @param $files
   *   An array of files.
   */
  function ChangeFromFiles($files) {
    $value = $this
      ->ValueFromFiles($files);
    if ($value === NULL) {

      // NULL indicates we could not find a value with which to replace the
      // current value. The value can still be '', or FALSE, etc.
      return;
    }
    $entity = $this
      ->GetEntity()
      ->GetEntity();
    $entity->{$this
      ->GetName()} = $value;
    $this
      ->GetEntity()
      ->SetEntity($entity);
  }

  /**
   * Get acceptable file extensions which contain data for this attribute.
   *
   * For example, title attributes can be replaced by data in txt files, whereas as
   * picture and field_image attributes require png, jpg, gif.
   *
   * @return
   *   An array of acceptable file extensions.
   */
  function GetExtensions() {

    // By default, use only text files. Other manipulators, say, for image fields
    // or file fields, can specify other extension types.
    return array(
      'txt',
    );
  }

  /**
   * Get all candidate files for a given field for this entity.
   *
   * @return
   *   An empty array if an error occurred, or if there are no files; otherwise an
   *   array of files is returned; the array might not contain all files in case an
   *   error occurred.
   */
  function GetCandidateFiles() {
    $files = array();
    try {
      $moduleHandler = \Drupal::moduleHandler();
      $modules = $moduleHandler
        ->getModuleList();
      foreach ($modules as $module) {
        $filepath = DRUPAL_ROOT . '/' . Environment::drupalGetPath('module', $module
          ->getName()) . '/realistic_dummy_content/fields/' . $this
          ->GetEntityType() . '/' . $this
          ->GetBundle() . '/' . $this
          ->GetName();
        $files = array_merge($files, Environment::GetAllFileGroups($filepath, $this
          ->GetExtensions()));
      }
      return $files;
    } catch (Exception $e) {
      return $files;
    }
  }

  /**
   * Given a FileGroup object, get structured property if extentions ok.
   *
   * The structured property can then be added to the entity.
   *
   * For example, sometimes the appropriate property is array('value' => 'abc',
   * 'text_format' => 'filtered_html'); other times is it just a string. Subclasses
   * will determine what to do with the contents from the file.
   *
   * @param $file
   *   The actual file object.
   *
   * @return
   *   In case of an error or if the value does not apply or is empty, return NULL;
   *   otherwise returns structured data to be added to the entity object.
   */
  function ValueFromFile($file) {
    try {
      if (in_array($file
        ->GetRadicalExtension(), $this
        ->GetExtensions())) {
        return $this
          ->ValueFromFile_($file);
      }
    } catch (\Exception $e) {
      return NULL;
    }
  }

  /**
   * Given a FileGroup object, get a structured property
   *
   * This function is not meant to called directly; rather, call ValueFromFile().
   * This function must be overriden by subclasses.
   *
   * @param $file
   *   An object of type FileGroup.
   *
   * @return
   *   Returns structured data to be added to the entity object, or NULL if such
   *   data can't be creatd.
   *
   * @throws
   *   \Exception.
   */
  protected abstract function ValueFromFile_($file);

  /**
   * Given a list of files, return a value from one of them.
   *
   * @param $files
   *   An array of file objects
   *
   * @return
   *   A file object or array, or an associative array with the keys "value" and
   *   "format", or NULL if there are no files to choose from or the files have
   *   the wrong extension.
   */
  function ValueFromFiles($files) {
    try {
      if (count($files)) {
        $rand_index = $this
          ->rand(0, count($files) - 1);
        $file = $files[$rand_index];
        return $this
          ->ValueFromFile($file);
      }
    } catch (\Exception $e) {
      return NULL;
    }
  }

  /**
   * Return acceptable image file extensions.
   *
   * @return
   *   An array of extension for image files.
   */
  function GetImageExtensions() {
    return array(
      'gif',
      'png',
      'jpg',
    );
  }

  /**
   * Return acceptable text file extensions.
   *
   * @return
   *   An array of extension for text files.
   */
  function GetTextExtensions() {
    return array(
      'txt',
    );
  }

  /**
   * Return an image file object if possible.
   *
   * @param $file
   *   The FileGroup object
   *
   * @return
   *   NULL if the file is not an image, or if an error occurred; otherwise a
   *   Drupal file object.
   */
  function ImageSave($file) {
    try {
      $exists = $file
        ->Value();
      if (!$exists) {
        throw new Exception('Please check if the file exists before attempting to save it');
      }
      $return = NULL;
      if (in_array($file
        ->GetRadicalExtension(), $this
        ->GetImageExtensions())) {
        $return = $this
          ->FileSave($file);
        $alt = $file
          ->Attribute('alt');
        if ($alt) {
          $return->alt = $alt;
        }
      }
      return $return;
    } catch (\Exception $e) {
      return NULL;
    }
  }

  /**
   * Return a file object.
   *
   * @param $file
   *   The original file, a FileGroup object.
   *
   * @return
   *   A file object.
   *
   * @throws
   *   \Exception.
   */
  function FileSave($file) {
    $drupal_file = $file
      ->GetFile();
    if (!$drupal_file) {
      throw new Exception('Please check if the file exists before attempting to save it');
    }
    $uri = $drupal_file->uri;

    //$random = md5($uri) . rand(1000000000, 9999999999);

    // DO NOT RENAME FOR TESTING
    $random = $file
      ->GetRadical();
    $drupal_file = $this
      ->env()
      ->file_save_data($file
      ->Value(), 'public://dummyfile' . $random . '.' . $file
      ->GetRadicalExtension());
    $drupal_file->uid = $this
      ->GetUid();
    $return = $drupal_file
      ->save();
    return $return;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Attribute::$entity private property The entity is set on construction and is a subclass of EntityBase. It contains information about the entity to which this field instance is attached.
Attribute::$name private property The name of this attribuet, for example title, picture, field_image...
Attribute::Change function Changes this attribute by looking for data in files.
Attribute::ChangeFromFiles function Given candidate files, change the value of this attribute based on one of them.
Attribute::env function Returns the appropriate environment, real or testing.
Attribute::FileSave function Return a file object.
Attribute::GetBundle function Gets the bundle of the associated entity.
Attribute::GetCandidateFiles function Get all candidate files for a given field for this entity.
Attribute::GetEntity function Getter for $this->entity
Attribute::GetEntityType function Get the entity type of the associated entity.
Attribute::GetExtensions function Get acceptable file extensions which contain data for this attribute. 2
Attribute::GetImageExtensions function Return acceptable image file extensions.
Attribute::GetName function Getter for $this->name
Attribute::GetTextExtensions function Return acceptable text file extensions.
Attribute::GetType abstract function Returns the type of this attribute. 2
Attribute::GetUid function Gets the UID of the associated entity.
Attribute::ImageSave function Return an image file object if possible.
Attribute::rand function Returns a pseudo-random number.
Attribute::ValueFromFile function Given a FileGroup object, get structured property if extentions ok.
Attribute::ValueFromFiles function Given a list of files, return a value from one of them.
Attribute::ValueFromFile_ abstract protected function Given a FileGroup object, get a structured property 6
Attribute::__construct function Constructor.