File: validators.rst

package info (click to toggle)
php-ramsey-uuid 4.7.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,124 kB
  • sloc: php: 13,359; xml: 194; python: 54; makefile: 16
file content (34 lines) | stat: -rw-r--r-- 886 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.. _reference.validators:

==========
Validators
==========

.. php:namespace:: Ramsey\Uuid\Validator

.. php:interface:: ValidatorInterface

    .. php:method:: getPattern()

        :returns: The regular expression pattern used by this validator
        :returntype: ``string``

    .. php:method:: validate($uuid)

        :param string $uuid: The string to validate as a UUID
        :returns: True if the provided string represents a UUID, false otherwise
        :returntype: ``bool``

.. php:class:: GenericValidator

    Implements :php:interface:`Ramsey\\Uuid\\Validator\\ValidatorInterface`.

    GenericValidator validates strings as UUIDs of any variant.

.. php:namespace:: Ramsey\Uuid\Rfc4122

.. php:class:: Validator

    Implements :php:interface:`Ramsey\\Uuid\\Validator\\ValidatorInterface`.

    Rfc4122\Validator validates strings as UUIDs of the RFC 4122 variant.