1Net::LDAP::Filter(3)  User Contributed Perl Documentation Net::LDAP::Filter(3)
2
3
4

NAME

6       Net::LDAP::Filter - representation of LDAP filters
7

SYNOPSIS

9         use Net::LDAP::Filter;
10
11         $filter = Net::LDAP::Filter->new( $filter_str );
12

DESCRIPTION

14       The Net::LDAP::Filter object lets you directly manipulate LDAP filters
15       without worrying about the string representation and all the associated
16       escaping mechanisms.
17

CONSTRUCTOR

19       new ( FILTER )
20           Create a new object and parse FILTER.
21

METHODS

23       parse ( FILTER )
24           Parse FILTER. The next call to ber will return this filter encoded.
25
26       as_string
27           Return the filter in text form.
28
29       print ( [ FH ] )
30           Print the text representation of the filter to FH, or the currently
31           selected output handle if FH is not given.
32

FILTER SYNTAX

34       Below is the syntax for a filter given in RFC-2254
35       http://www.ietf.org/rfc/rfc2254.txt
36
37        filter       = "(" filtercomp ")"
38        filtercomp   = and / or / not / item
39        and          = "&" filterlist
40        or           = "|" filterlist
41        not          = "!" filter
42        filterlist   = 1*filter
43        item         = simple / present / substring / extensible
44        simple       = attr filtertype value
45        filtertype   = equal / approx / greater / less
46        equal        = "="
47        approx       = "~="
48        greater      = ">="
49        less         = "<="
50        extensible   = attr [":dn"] [":" matchingrule] ":=" value
51                       / [":dn"] ":" matchingrule ":=" value
52        present      = attr "=*"
53        substring    = attr "=" [initial] any [final]
54        initial      = value
55        any          = "*" *(value "*")
56        final        = value
57        attr         = AttributeDescription from Section 4.1.5 of RFC-2251
58        matchingrule = MatchingRuleId from Section 4.1.9 of RFC-2251
59        value        = AttributeValue from Section 4.1.6 of RFC-2251
60
61
62        Special Character encodings
63        ---------------------------
64           *               \2a, \*
65           (               \28, \(
66           )               \29, \)
67           \               \5c, \\
68           NUL             \00
69

SEE ALSO

71       Net::LDAP, Other online documentation
72

ACKNOWLEDGEMENTS

74       This document is based on a document originally written by Russell
75       Fulton <r.fulton@auckland.ac.nz>.
76

AUTHOR

78       Graham Barr <gbarr@pobox.com>
79
80       Please report any bugs, or post any suggestions, to the perl-ldap
81       mailing list <perl-ldap@perl.org>.
82

84       Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program
85       is free software; you can redistribute it and/or modify it under the
86       same terms as Perl itself.
87
88
89
90perl v5.12.0                      2008-06-30              Net::LDAP::Filter(3)
Impressum