ValidationTrait.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <?php
  2. /*
  3. * Copyright 2017 Google LLC
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without
  7. * modification, are permitted provided that the following conditions are
  8. * met:
  9. *
  10. * * Redistributions of source code must retain the above copyright
  11. * notice, this list of conditions and the following disclaimer.
  12. * * Redistributions in binary form must reproduce the above
  13. * copyright notice, this list of conditions and the following disclaimer
  14. * in the documentation and/or other materials provided with the
  15. * distribution.
  16. * * Neither the name of Google Inc. nor the names of its
  17. * contributors may be used to endorse or promote products derived from
  18. * this software without specific prior written permission.
  19. *
  20. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. */
  32. namespace Google\ApiCore;
  33. /**
  34. * @internal
  35. */
  36. trait ValidationTrait
  37. {
  38. /**
  39. * @param array $arr Associative array
  40. * @param array $requiredKeys List of keys to check for in $arr
  41. * @return array Returns $arr for fluent use
  42. */
  43. public static function validate(array $arr, array $requiredKeys)
  44. {
  45. return self::validateImpl($arr, $requiredKeys, true);
  46. }
  47. /**
  48. * @param array $arr Associative array
  49. * @param array $requiredKeys List of keys to check for in $arr
  50. * @return array Returns $arr for fluent use
  51. */
  52. public static function validateNotNull(array $arr, array $requiredKeys)
  53. {
  54. return self::validateImpl($arr, $requiredKeys, false);
  55. }
  56. private static function validateImpl($arr, $requiredKeys, $allowNull)
  57. {
  58. foreach ($requiredKeys as $requiredKey) {
  59. $valid = array_key_exists($requiredKey, $arr)
  60. && ($allowNull || !is_null($arr[$requiredKey]));
  61. if (!$valid) {
  62. throw new ValidationException("Missing required argument $requiredKey");
  63. }
  64. }
  65. return $arr;
  66. }
  67. /**
  68. * @param string $filePath
  69. * @throws ValidationException
  70. */
  71. private static function validateFileExists(string $filePath)
  72. {
  73. if (!file_exists($filePath)) {
  74. throw new ValidationException("Could not find specified file: $filePath");
  75. }
  76. }
  77. }