[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/se3-unattended/var/se3/unattended/install/linuxaux/opt/perl/lib/site_perl/5.10.0/Net/LDAP/ -> Filter.pod (source)

   1  =head1 NAME
   2  
   3  Net::LDAP::Filter - representation of LDAP filters
   4  
   5  =head1 SYNOPSIS
   6  
   7    use Net::LDAP::Filter;
   8  
   9    $filter = Net::LDAP::Filter->new( $filter_str );
  10  
  11  =head1 DESCRIPTION
  12  
  13  The B<Net::LDAP::Filter> object lets you directly manipulate LDAP
  14  filters without worrying about the string representation and all the
  15  associated escaping mechanisms.
  16  
  17  =head1 CONSTRUCTOR
  18  
  19  =over 4
  20  
  21  =item new ( FILTER )
  22  
  23  Create a new object and parse FILTER. 
  24  
  25  =back
  26  
  27  =head1 METHODS
  28  
  29  =over 4
  30  
  31  =item parse ( FILTER )
  32  
  33  Parse FILTER. The next call to ber will return this filter encoded.
  34  
  35  =item as_string
  36  
  37  Return the filter in text form.
  38  
  39  =item print ( [ FH ] )
  40  
  41  Print the text representation of the filter to FH, or the currently
  42  selected output handle if FH is not given.
  43  
  44  =back
  45  
  46  =head1 FILTER SYNTAX
  47  
  48  Below is the syntax for a filter given in
  49  RFC-2254 http://www.ietf.org/rfc/rfc2254.txt
  50  
  51   filter       = "(" filtercomp ")"
  52   filtercomp   = and / or / not / item
  53   and          = "&" filterlist
  54   or           = "|" filterlist
  55   not          = "!" filter
  56   filterlist   = 1*filter
  57   item         = simple / present / substring / extensible
  58   simple       = attr filtertype value
  59   filtertype   = equal / approx / greater / less
  60   equal        = "="
  61   approx       = "~="
  62   greater      = ">="
  63   less         = "<="
  64   extensible   = attr [":dn"] [":" matchingrule] ":=" value
  65                  / [":dn"] ":" matchingrule ":=" value
  66   present      = attr "=*"
  67   substring    = attr "=" [initial] any [final]
  68   initial      = value
  69   any          = "*" *(value "*")
  70   final        = value
  71   attr         = AttributeDescription from Section 4.1.5 of RFC-2251
  72   matchingrule = MatchingRuleId from Section 4.1.9 of RFC-2251
  73   value        = AttributeValue from Section 4.1.6 of RFC-2251
  74  
  75  
  76   Special Character encodings
  77   ---------------------------
  78      *               \2a, \*
  79      (               \28, \(
  80      )               \29, \)
  81      \               \5c, \\
  82      NUL             \00
  83  
  84  =head1 SEE ALSO
  85  
  86  L<Net::LDAP>,
  87  L<Other online documentation|Net::LDAP::RFC>
  88  
  89  =head1 ACKNOWLEDGEMENTS
  90  
  91  This document is based on a document originally written by Russell Fulton
  92  E<lt>r.fulton@auckland.ac.nzE<gt>.
  93  
  94  =head1 AUTHOR
  95  
  96  Graham Barr E<lt>gbarr@pobox.comE<gt>
  97  
  98  Please report any bugs, or post any suggestions, to the perl-ldap mailing list
  99  E<lt>perl-ldap@perl.orgE<gt>.
 100  
 101  =head1 COPYRIGHT
 102  
 103  Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program is
 104  free software; you can redistribute it and/or modify it under the same
 105  terms as Perl itself.
 106  
 107  =cut


Generated: Tue Mar 17 22:47:18 2015 Cross-referenced by PHPXref 0.7.1