net::ldap::filter(3) [mojave man page]

Net::LDAP::Filter(3)					User Contributed Perl Documentation				      Net::LDAP::Filter(3)

NAME

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

SYNOPSIS

	 use Net::LDAP::Filter;

	 $filter = Net::LDAP::Filter->new( $filter_str );

DESCRIPTION

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

CONSTRUCTOR

       new ( [ FILTER ] )
	   Create a new object.  If FILTER is given, parse it.

METHODS

       parse ( FILTER )
	   Parse FILTER, updating the object to represent it.

       as_string
	   Return the filter in text form.

       print ( [ FH ] )
	   Print the text representation of the filter to FH, or the currently selected output handle if FH is not given.

       negate ( )
	   Logically negate/invert the filter object so that it matches the opposite set of entries as the original.

	   Instead of simply negating the text form by surrounding it with the not operator, the negation is done by recursively applying De
	   Morgan's law.

	   Here is an example:

	    (|(&(cn=A)(cn=B))(|(!(cn=C))(cn=D)))

	   gets negated to

	    (&(|(!(cn=A))(!(cn=B)))(&(cn=C)(!(cn=D))))

FILTER SYNTAX

       Below is the syntax for a filter given in RFC 4515 http://www.ietf.org/rfc/rfc4515.txt

	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
	---------------------------
	   *		   2a, *
	   (		   28, (
	   )		   29, )
	   		   5c, \
	   NUL		   0

SEE ALSO

       Net::LDAP, Other online documentation

ACKNOWLEDGEMENTS

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

AUTHOR

       Graham Barr <gbarr@pobox.com>

       Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@perl.org>.

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.

perl v5.18.2							    2013-12-23						      Net::LDAP::Filter(3)

Check Out this Related Man Page

Net::LDAP::FilterMatch(3)				User Contributed Perl Documentation				 Net::LDAP::FilterMatch(3)

NAME

       Net::LDAP::FilterMatch - LDAP entry matching

SYNOPSIS

	 use Net::LDAP::Entry;
	 use Net::LDAP::Filter;
	 use Net::LDAP::FilterMatch;

	 my $entry = new Net::LDAP::Entry;
	 $entry->dn("cn=dummy entry");
	 $entry->add (
	  'cn' => 'dummy entry',
	  'street' => [ '1 some road','nowhere' ] );

	 my @filters = (qw/(cn=dummy*)
			(ou=*)
			(&(cn=dummy*)(street=*road))
			(&(cn=dummy*)(!(street=nowhere)))/);

	 for (@filters) {
	   my $filter = Net::LDAP::Filter->new($_);
	   print $_,' : ', $filter->match($entry) ? 'match' : 'no match' ,"
";
	 }

ABSTRACT

       This extension of the class Net::LDAP::Filter provides entry matching functionality on the Perl side.

       Given an entry it will tell whether the entry matches the filter object.

       It can be used on its own or as part of a Net::LDAP::Server based LDAP server.

METHOD

       match ( ENTRY [ ,SCHEMA ] )
	   Return whether ENTRY matches the filter object. If a schema object is provided, the selection of matching algorithms will be derived
	   from schema.

	   In case of error undef is returned.

       For approximate matching like (cn~=Schmidt) there are several modules that can be used. By default the following modules will be tried in
       this order:

	 String::Approx
	 Text::Metaphone
	 Text::Soundex

       If none of these modules is found it will fall back on a simple regexp algorithm.

       If you want to specifically use one implementation only, simply do

	 use Net::LDAP::FilterMatch qw(Text::Soundex);

SEE ALSO

       Net::LDAP::Filter

COPYRIGHT

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

AUTHORS

       Hans Klunder <hans.klunder@bigfoot.com> Peter Marschall <peter@adpm.de>

perl v5.18.2							    2013-07-21						 Net::LDAP::FilterMatch(3)

Linux and UNIX Man Pages

net::ldap::filter(3) [mojave man page]

Check Out this Related Man Page