RegExMatch.php 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. <?php
  2. /* Copyright (c) 2019 Geert Bergman (geert@scrivo.nl), highlight.php
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions are met:
  6. *
  7. * 1. Redistributions of source code must retain the above copyright notice,
  8. * this list of conditions and the following disclaimer.
  9. * 2. Redistributions in binary form must reproduce the above copyright notice,
  10. * this list of conditions and the following disclaimer in the documentation
  11. * and/or other materials provided with the distribution.
  12. * 3. Neither the name of "highlight.js", "highlight.php", nor the names of its
  13. * contributors may be used to endorse or promote products derived from this
  14. * software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26. * POSSIBILITY OF SUCH DAMAGE.
  27. */
  28. namespace Highlight;
  29. /**
  30. * @internal
  31. *
  32. * @implements \ArrayAccess<int, string|null>
  33. * @implements \IteratorAggregate<int, string|null>
  34. *
  35. * @since 9.16.0.0
  36. */
  37. class RegExMatch implements \ArrayAccess, \Countable, \IteratorAggregate
  38. {
  39. /** @var array<int, string|null> */
  40. private $data;
  41. /** @var int */
  42. public $index;
  43. /** @var string */
  44. public $input;
  45. /** @var string */
  46. public $type;
  47. /** @var Mode|string */
  48. public $rule;
  49. /**
  50. * @param array<int, string|null> $results
  51. */
  52. public function __construct(array $results)
  53. {
  54. $this->data = $results;
  55. }
  56. /**
  57. * {@inheritdoc}
  58. */
  59. #[\ReturnTypeWillChange]
  60. public function getIterator()
  61. {
  62. return new \ArrayIterator($this->data);
  63. }
  64. /**
  65. * {@inheritdoc}
  66. */
  67. #[\ReturnTypeWillChange]
  68. public function offsetExists($offset)
  69. {
  70. return isset($this->data[$offset]);
  71. }
  72. /**
  73. * {@inheritdoc}
  74. */
  75. #[\ReturnTypeWillChange]
  76. public function offsetGet($offset)
  77. {
  78. return $this->data[$offset];
  79. }
  80. /**
  81. * {@inheritdoc}
  82. */
  83. #[\ReturnTypeWillChange]
  84. public function offsetSet($offset, $value)
  85. {
  86. throw new \LogicException(__CLASS__ . ' instances are read-only.');
  87. }
  88. /**
  89. * {@inheritdoc}
  90. */
  91. #[\ReturnTypeWillChange]
  92. public function offsetUnset($offset)
  93. {
  94. throw new \LogicException(__CLASS__ . ' instances are read-only.');
  95. }
  96. /**
  97. * {@inheritdoc}
  98. *
  99. * @return int
  100. */
  101. #[\ReturnTypeWillChange]
  102. public function count()
  103. {
  104. return count($this->data);
  105. }
  106. }