The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Data-Object-0.61
River stage one • 1 direct dependent • 1 total dependent
/ Data::Object::Role::Regexp

NAME

Data::Object::Role::Regexp - Regexp Object Role for Perl 5

VERSION

version 0.61

SYNOPSIS

  use Data::Object::Class;

  with 'Data::Object::Role::Regexp';

DESCRIPTION

Data::Object::Role::Regexp provides routines for operating on Perl 5 regular expressions.

METHODS

data

  # given $regexp

  $regexp->data; # original value

The data method returns the original and underlying value contained by the object. This method is an alias to the detract method.

defined

  # given $regexp

  $regexp->defined; # 1

The defined method returns true if the object represents a value that meets the criteria for being defined, otherwise it returns false. This method returns a number object.

detract

  # given $regexp

  $regexp->detract; # original value

The detract method returns the original and underlying value contained by the object.

dump

  # given qr(test)

  $regexp->dump; # qr/(?^u:test)/

The dump method returns returns a string representation of the object. This method returns a string value.

eq

  # given qr(test)

  $regexp->eq(qr(test)); # 1

The eq method returns true if the argument provided is equal to the value represented by the object. This method returns a number value.

ge

  # given qr(test)

  $regexp->ge(qr(test)); # 1

The ge method returns true if the argument provided is greater-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

gt

  # given qr(test)

  $regexp->gt(qr(test)); # 0

The gt method returns true if the argument provided is greater-than the value represented by the object. This method returns a number value.

le

  # given qr(test)

  $regexp->le(qr(test)); # 1

The le method returns true if the argument provided is less-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

lt

  # given qr(test)

  $regexp->lt(qr(test)); # 0

The lt method returns true if the argument provided is less-than the value represented by the object. This method returns a number value.

methods

  # given $regexp

  $regexp->methods;

The methods method returns the list of methods attached to object. This method returns an array value.

ne

  # given qr(test)

  $regexp->ne(qr(test)); # 1

The ne method returns true if the argument provided is not equal to the value represented by the object. This method returns a number value.

new

  # given qr(something to match against)

  my $re = Data::Object::Regexp->new(qr(something to match against));

The new method expects a regular-expression object and returns a new class instance.

print

  # given qr(test)

  $regexp->print; # 'qr/(?^u:test)/'

The print method outputs the value represented by the object to STDOUT and returns true. This method returns a number value.

replace

  # given qr(test)

  $re->replace('this is a test', 'drill');
  $re->replace('test 1 test 2 test 3', 'drill', 'gi');

The replace method performs a regular expression substitution on the given string. The first argument is the string to match against. The second argument is the replacement string. The optional third argument might be a string representing flags to append to the s///x operator, such as 'g' or 'e'. This method will always return a regexp::Result object which can be used to introspect the result of the operation.

roles

  # given $regexp

  $regexp->roles;

The roles method returns the list of roles attached to object. This method returns an array value.

say

  # given qr(test)

  $regexp->say; # 'qr/(?^u:test)/\n'

The say method outputs the value represented by the object appended with a newline to STDOUT and returns true. This method returns a Data::Object::Number object.

  # given qr((test))

  $re->search('this is a test');
  $re->search('this does not match', 'gi');

The search method performs a regular expression match against the given string This method will always return a regexp::Result object which can be used to introspect the result of the operation.

throw

  # given $regexp

  $regexp->throw;

The throw method terminates the program using the core die keyword, passing the object to the Data::Object::Exception class as the named parameter object. If captured this method returns an exception value.

type

  # given $regexp

  $regexp->type; # REGEXP

The type method returns a string representing the internal data type object name. This method returns a string value.

ROLES

This package is comprised of the following roles.

SEE ALSO

AUTHOR

Al Newkirk <al@iamalnewkirk.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Al Newkirk.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.