Version.php 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?php
  2. /*
  3. * Copyright 2018 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. class Version
  37. {
  38. /**
  39. * @var ?string
  40. */
  41. private static $version = null;
  42. /**
  43. * @return string The version of the ApiCore library.
  44. */
  45. public static function getApiCoreVersion()
  46. {
  47. if (is_null(self::$version)) {
  48. $versionFile = implode(DIRECTORY_SEPARATOR, [__DIR__, '..', 'VERSION']);
  49. self::$version = self::readVersionFile($versionFile);
  50. }
  51. return self::$version;
  52. }
  53. /**
  54. * Reads a VERSION file and returns the contents. If the file does not
  55. * exist, returns "".
  56. *
  57. * @param string $file
  58. * @return string
  59. */
  60. public static function readVersionFile(string $file)
  61. {
  62. $versionString = file_exists($file)
  63. ? (string) file_get_contents($file)
  64. : "";
  65. return trim($versionString);
  66. }
  67. /**
  68. * Private constructor.
  69. */
  70. private function __construct()
  71. {
  72. }
  73. }