ProtectedPrivates.php in Examples for Developers 3.x

Namespace

Drupal\phpunit_example

File

modules/phpunit_example/src/ProtectedPrivates.php

<?php

namespace Drupal\phpunit_example;


/**
 * A class with features to show how to do unit testing.
 *
 * This class has private and protected methods to demonstrate
 * how to test with reflection and mocking.
 *
 * protectedAdd() and privateAdd() are shim methods to AddClass::add().
 * We do this so we're concentrating on the testing instead of the
 * code being tested.
 *
 * @ingroup phpunit_example
 */
class ProtectedPrivates {

  /**
   * A simple addition method with validity checking.
   *
   * @param int|float $a
   *   A number to add.
   * @param int|float $b
   *   Another number to add.
   *
   * @return int|float
   *   The sum of $a and $b.
   *
   * @throws \InvalidArgumentException
   *   If either $a or $b is non-numeric, we can't add, so we throw.
   */
  protected function protectedAdd($a, $b) {
    $adder = new AddClass();
    return $adder
      ->add($a, $b);
  }

  // phpcs:disable

  /**
   * A simple addition method with validity checking.
   *
   * @param int|float $a
   *   A number to add.
   * @param int|float $b
   *   Another number to add.
   *
   * @return int|float
   *   The sum of $a and $b.
   *
   * @throws \InvalidArgumentException
   *   If either $a or $b is non-numeric, we can't add, so we throw.
   */
  private function privateAdd($a, $b) {
    $adder = new AddClass();
    return $adder
      ->add($a, $b);
  }

}

Classes

Name	Description
ProtectedPrivates	A class with features to show how to do unit testing.