ArrayOrTraversableGuardTrait.php 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. <?php
  2. declare(strict_types=1);
  3. namespace Laminas\Stdlib\Guard;
  4. use Exception;
  5. use Laminas\Stdlib\Exception\InvalidArgumentException;
  6. use Traversable;
  7. use function get_debug_type;
  8. use function is_array;
  9. use function sprintf;
  10. /**
  11. * Provide a guard method for array or Traversable data
  12. */
  13. trait ArrayOrTraversableGuardTrait
  14. {
  15. /**
  16. * Verifies that the data is an array or Traversable
  17. *
  18. * @param mixed $data the data to verify
  19. * @param string $dataName the data name
  20. * @param string $exceptionClass FQCN for the exception
  21. * @return void
  22. * @throws Exception
  23. */
  24. protected function guardForArrayOrTraversable(
  25. mixed $data,
  26. $dataName = 'Argument',
  27. $exceptionClass = InvalidArgumentException::class
  28. ) {
  29. if (! is_array($data) && ! $data instanceof Traversable) {
  30. $message = sprintf(
  31. "%s must be an array or Traversable, [%s] given",
  32. $dataName,
  33. get_debug_type($data)
  34. );
  35. throw new $exceptionClass($message);
  36. }
  37. }
  38. }