class Math in Realistic Dummy Content 8.2

Everything having to do with numbers and calculations.

Hierarchy

• class \Drupal\realistic_dummy_content_api\includes\Math

2 files declare their use of Math

MathTest.php in api/src/test/includes/MathTest.php

realistic_dummy_content_api.module in api/realistic_dummy_content_api.module

API code allowing other modules to generate realistic dummy content.

File

api/src/includes/Math.php, line 8

Namespace

Drupal\realistic_dummy_content_api\includes

class Math {

  /**
   * Generate sequential number based on a hash.
   *
   * Returns the starting number on every call until the hash is changed, in
   * which case it returns the second number, and so on.
   *
   * The idea behind this is that for a single node, we might want to retrieve
   * the 3rd file for each field (they go together).
   *
   * In the above example, if the 3rd file does not exist, we will return the
   * first file, in order to never return a number which is outside the range of
   * start to end.
   *
   * @param int $start
   *   The first possible number in the range.
   * @param int $end
   *   The last possible number in the range.
   * @param string $hash
   *   The number returned by this function will be in sequence: each call to
   *   realistic_dummy_content_api_sequential()'s return is incremented by
   *   one, unless $hash is the same as in the last call, in which case the
   *   return will be the same as in the last call.
   *
   * @return int
   *   A sequential number based on the $hash.
   *   Please see the description of the $hash parameter, above.
   */
  public function sequential($start, $end, $hash) {
    static $static_hash = NULL;
    if (!$static_hash) {
      $static_hash = $hash;
    }
    static $current = NULL;
    if (!$current) {
      $current = $start;
    }
    if ($static_hash != $hash) {
      $static_hash = $hash;
      $current -= $start;
      $current++;
      $current %= $end - $start + 1;
      $current += $start;
    }
    if ($current > $end) {
      $return = $end;
    }
    elseif ($current < $start) {
      $return = $start;
    }
    else {
      $return = $current;
    }
    return $return;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Math::sequential	public	function	Generate sequential number based on a hash.