.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Filter 3"
.TH Net::LDAP::Filter 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Filter \- representation of LDAP filters
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::LDAP::Filter;
\&
\&  $filter = Net::LDAP::Filter\->new( $filter_str );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBNet::LDAP::Filter\fR object lets you directly manipulate LDAP
filters without worrying about the string representation and all the
associated escaping mechanisms.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.IP "new ( [ FILTER ] )" 4
.IX Item "new ( [ FILTER ] )"
Create a new object.
If FILTER is given, parse it.
.SH METHODS
.IX Header "METHODS"
.IP "parse ( FILTER )" 4
.IX Item "parse ( FILTER )"
Parse FILTER, updating the object to represent it.
.IP as_string 4
.IX Item "as_string"
Return the filter in text form.
.IP "print ( [ FH ] )" 4
.IX Item "print ( [ FH ] )"
Print the text representation of the filter to FH, or the currently
selected output handle if FH is not given.
.IP "negate ( )" 4
.IX Item "negate ( )"
Logically negate/invert the filter object so that it matches the opposite
set of entries as the original.
.Sp
Instead of simply negating the text form by surrounding it with the \fBnot\fR
operator, the negation is done by recursively applying \fIDe Morgan's law\fR.
.Sp
Here is an example:
.Sp
.Vb 1
\& (|(&(cn=A)(cn=B))(|(!(cn=C))(cn=D)))
.Ve
.Sp
gets negated to
.Sp
.Vb 1
\& (&(|(!(cn=A))(!(cn=B)))(&(cn=C)(!(cn=D))))
.Ve
.SH "FILTER SYNTAX"
.IX Header "FILTER SYNTAX"
Below is the syntax for a filter given in RFC 4515
http://www.ietf.org/rfc/rfc4515.txt
.PP
.Vb 10
\& filter       = "(" filtercomp ")"
\& filtercomp   = and / or / not / item
\& and          = "&" filterlist
\& or           = "|" filterlist
\& not          = "!" filter
\& filterlist   = 1*filter
\& item         = simple / present / substring / extensible
\& simple       = attr filtertype value
\& filtertype   = equal / approx / greater / less
\& equal        = "="
\& approx       = "~="
\& greater      = ">="
\& less         = "<="
\& extensible   = attr [":dn"] [":" matchingrule] ":=" value
\&                / [":dn"] ":" matchingrule ":=" value
\& present      = attr "=*"
\& substring    = attr "=" [initial] any [final]
\& initial      = value
\& any          = "*" *(value "*")
\& final        = value
\& attr         = AttributeDescription from Section 4.1.4 of RFC 4511
\& matchingrule = MatchingRuleId from Section 4.1.8 of RFC 4511
\& value        = AttributeValue from Section 4.1.5 of RFC 4511
\&
\&
\& Special Character encodings
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    *               \e2a, \e*
\&    (               \e28, \e(
\&    )               \e29, \e)
\&    \e               \e5c, \e\e
\&    NUL             \e00
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Other online documentation
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
This document is based on a document originally written by Russell Fulton
<r.fulton@auckland.ac.nz>.
.SH AUTHOR
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl\-ldap@perl.org>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 1997\-2004 Graham Barr. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.