class IngredientUnitFuzzymatch in Recipe 8.2

Provides the ingredient.fuzzymatch service.

Hierarchy

• class \Drupal\ingredient\Utility\IngredientUnitFuzzymatch

1 string reference to 'IngredientUnitFuzzymatch'

ingredient.services.yml in modules/ingredient/ingredient.services.yml

modules/ingredient/ingredient.services.yml

1 service uses IngredientUnitFuzzymatch

ingredient.fuzzymatch in modules/ingredient/ingredient.services.yml

Drupal\ingredient\Utility\IngredientUnitFuzzymatch

File

modules/ingredient/src/Utility/IngredientUnitFuzzymatch.php, line 10

Namespace

Drupal\ingredient\Utility

class IngredientUnitFuzzymatch {

  /**
   * The ingredient.units configuration.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $ingredientUnitConfig;

  /**
   * Constructs a new IngredientUnitUtility object.
   *
   * @param \Drupal\Core\Config\ConfigFactory $config_factory
   *   The config.factory service.
   */
  public function __construct(ConfigFactory $config_factory) {
    $this->ingredientUnitConfig = $config_factory
      ->get('ingredient.units');
  }

  /**
   * Returns a best-guess matched unit key for a unit of measure.
   *
   * @param string $subject
   *   The unit of measure for which the function will search.
   *
   * @return string|false
   *   The unit's key from configuration or FALSE if there was no match.
   */
  public function getUnitFuzzymatch($subject) {
    $unit_sets = $this->ingredientUnitConfig
      ->get('unit_sets');

    // Merge the unit sets into a single array for simplicity.
    $units = [];
    foreach ($unit_sets as $set) {
      $units = array_merge($units, $set['units']);
    }

    // Empty strings should use the default non-printing 'unit'.
    if (empty($subject)) {
      $subject = 'unit';
    }

    // First pass unit case must match exactly( T=Tbsp, t=tsp ).
    foreach ($units as $unit_key => $unit) {
      $patterns = [];

      // Add name pattern.
      $patterns[] = '^' . $unit['name'] . 's{0,1}$';
      if (isset($unit['plural'])) {

        // Add plural name pattern.
        $patterns[] = '^' . $unit['plural'] . 's{0,1}$';
      }
      if (isset($unit['abbreviation'])) {

        // Add abbreviation pattern.
        $patterns[] = '^' . $unit['abbreviation'] . 's{0,1}\\.{0,1}$';
      }
      if (isset($unit['aliases'])) {

        // Add alias patterns.
        foreach ($unit['aliases'] as $alias) {
          $patterns[] = '^' . trim($alias) . 's{0,1}\\.{0,1}$';
        }
      }
      if (preg_match("/" . implode('|', $patterns) . "/", $subject)) {
        return $unit_key;
      }
    }

    // Second pass unit case doesn't matter.
    foreach ($units as $unit_key => $unit) {
      $patterns = [];

      // Add name pattern.
      $patterns[] = '^' . $unit['name'] . 's{0,1}$';
      if (isset($unit['plural'])) {

        // Add plural name pattern.
        $patterns[] = '^' . $unit['plural'] . 's{0,1}$';
      }
      if (isset($unit['abbreviation'])) {

        // Add abbreviation pattern.
        $patterns[] = '^' . $unit['abbreviation'] . 's{0,1}\\.{0,1}$';
      }
      if (isset($unit['aliases'])) {

        // Add alias patterns.
        foreach ($unit['aliases'] as $alias) {
          $patterns[] = '^' . trim($alias) . 's{0,1}\\.{0,1}$';
        }
      }
      if (preg_match("/" . implode('|', $patterns) . "/i", $subject)) {
        return $unit_key;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
IngredientUnitFuzzymatch::$ingredientUnitConfig	protected	property	The ingredient.units configuration.
IngredientUnitFuzzymatch::getUnitFuzzymatch	public	function	Returns a best-guess matched unit key for a unit of measure.
IngredientUnitFuzzymatch::__construct	public	function	Constructs a new IngredientUnitUtility object.