[libnet-ldap-filterbuilder-perl.git] 07/11: new upstream

dom at earth.li dom at earth.li
Sun Aug 28 23:39:52 UTC 2016


This is an automated email from the git hooks/post-receive script.

dom pushed a commit to branch master
in repository libnet-ldap-filterbuilder-perl.git.

commit faedc72e60155e410ef3e56d3dd4e5a45ae30940
Author: Dominic Hargreaves <dom at earth.li>
Date:   Sun Oct 25 15:39:01 2009 +0000

    new upstream
---
 Changes                       |  6 ++++++
 META.yml                      |  2 +-
 README                        | 29 +++++++++++++++++++++++++---
 debian/changelog              |  7 +++++++
 lib/Net/LDAP/FilterBuilder.pm | 45 +++++++++++++++++++++++++++++++++++++------
 5 files changed, 79 insertions(+), 10 deletions(-)

diff --git a/Changes b/Changes
index e0632df..b5f8562 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,9 @@
+libnet-ldap-filterbuilder (1.0003-1) UNRELEASED; urgency=low
+
+  * Add docs patch from Tom Jones to expose as_str and other methods.
+
+ -- Oliver Gorwits <oliver.gorwits at oucs.ox.ac.uk>  Tue, 20 Oct 2009 08:21:49 +0100
+
 libnet-ldap-filterbuilder (1.0002-1) UNRELEASED; urgency=low
 
   * Add example and pod tests 
diff --git a/META.yml b/META.yml
index ae80d87..1421404 100644
--- a/META.yml
+++ b/META.yml
@@ -22,4 +22,4 @@ requires:
   perl: 5.8.1
 resources:
   license: http://dev.perl.org/licenses/
-version: 1.0002
+version: 1.0003
diff --git a/README b/README
index 9709e5d..9e4e2ae 100644
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     Net::LDAP::FilterBuilder - Build LDAP filter statements
 
 VERSION
-    This document refers to version 1.0002 of Net::LDAP::FilterBuilder
+    This document refers to version 1.0003 of Net::LDAP::FilterBuilder
 
 PURPOSE
     Use this module to construct LDAP filter statments which are compliant
@@ -66,7 +66,7 @@ USAGE
 
     However you can refine the filter statement using three additional
     methods for the logical operations "and", "or" and "not", as shown in
-    the "SYOPSIS" section, above.
+    the "SYOPSIS" section, above, and the "METHODS" section below.
 
     There are two ways to refine a filter. Either call the logic method with
     a new attribute and value, or call a logic method and pass another
@@ -90,7 +90,7 @@ USAGE
     special significance to LDAP filter statments in your value argument,
     then those characters will be escaped. The list of characters is:
 
-     ( ) * \ NUL 
+     ( ) * \ NUL
 
     To avoid this pass in a scalar reference as the value argument. For
     example to enable a wildcard (substring) match on a value:
@@ -98,6 +98,29 @@ USAGE
      my $filter = Net::LDAP::FilterBuilder->new( sn => \'foo*bar' );
      # (sn=foo*bar)
 
+METHODS
+    as_str
+        Returns the string representation of the LDAP filter. Note that the
+        object will stringify to this value in string context, too.
+
+    and(FILTERSPEC)
+        Logically conjoins this filter with the one specified by FILTERSPEC.
+        FILTERSPEC may be a Net::LDAP::FilterBuilder object, or a hash
+        representation of the filter as taken by new.
+
+        Returns the newly-conjoined Net::LDAP::FilterBuilder.
+
+    or(FILTERSPEC)
+        Logically disjoins this filter with the one specified by FILTERSPEC.
+        FILTERSPEC may be a Net::LDAP::FilterBuilder object, or a hash
+        representation of the filter as taken by new.
+
+        Returns the newly-disjoined Net::LDAP::FilterBuilder.
+
+    not Logically complements this filter.
+
+        Returns the newly-negated Net::LDAP::FilterBuilder.
+
 AUTHOR
     Originally written by Ray Miller.
 
diff --git a/debian/changelog b/debian/changelog
index 5816b97..042ec65 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+libnet-ldap-filterbuilder-perl (1.0003-1) UNRELEASED; urgency=low
+
+  * New upstream release
+    - improved docs
+
+ -- Dominic Hargreaves <dom at earth.li>  Sun, 25 Oct 2009 15:38:45 +0000
+
 libnet-ldap-filterbuilder-perl (1.0002-1) unstable; urgency=low
 
   * New upstream release
diff --git a/lib/Net/LDAP/FilterBuilder.pm b/lib/Net/LDAP/FilterBuilder.pm
index 6c88720..0f23a0c 100644
--- a/lib/Net/LDAP/FilterBuilder.pm
+++ b/lib/Net/LDAP/FilterBuilder.pm
@@ -1,7 +1,7 @@
 #
-# $HeadURL: https://svn.oucs.ox.ac.uk/people/oliver/pub/cpan/libnet-ldap-filterbuilder/trunk/lib/Net/LDAP/FilterBuilder.pm $
-# $LastChangedRevision: 282 $
-# $LastChangedDate: 2008-11-08 17:34:38 +0000 (Sat, 08 Nov 2008) $
+# $HeadURL: https://svn.oucs.ox.ac.uk/people/oliver/pub/cpan/libnet-ldap-filterbuilder-perl/trunk/lib/Net/LDAP/FilterBuilder.pm $
+# $LastChangedRevision: 567 $
+# $LastChangedDate: 2009-10-20 08:27:24 +0100 (Tue, 20 Oct 2009) $
 # $LastChangedBy: oliver $
 #
 package Net::LDAP::FilterBuilder;
@@ -9,7 +9,7 @@ package Net::LDAP::FilterBuilder;
 use strict;
 use warnings FATAL => 'all';
 
-our $VERSION = '1.0002';
+our $VERSION = '1.0003';
 $VERSION = eval $VERSION; # numify for warning-free dev releases
 
 use overload '""' => \&as_str;
@@ -102,7 +102,7 @@ Net::LDAP::FilterBuilder - Build LDAP filter statements
 
 =head1 VERSION
 
-This document refers to version 1.0002 of Net::LDAP::FilterBuilder
+This document refers to version 1.0003 of Net::LDAP::FilterBuilder
 
 =head1 PURPOSE
 
@@ -168,7 +168,7 @@ The value returned is an object, but stringifies to the current query:
 
 However you can refine the filter statement using three additional methods for
 the logical operations C<and>, C<or> and C<not>, as shown in the L<"SYOPSIS">
-section, above.
+section, above, and the L<"METHODS"> section below.
 
 There are two ways to refine a filter. Either call the logic method with a new
 attribute and value, or call a logic method and pass another
@@ -201,6 +201,39 @@ enable a wildcard (substring) match on a value:
  my $filter = Net::LDAP::FilterBuilder->new( sn => \'foo*bar' );
  # (sn=foo*bar)
 
+=head1 METHODS
+
+=over 4
+
+=item B<as_str>
+
+Returns the string representation of the LDAP filter.  Note that the
+object will stringify to this value in string context, too.
+
+=item B<and>(FILTERSPEC)
+
+Logically conjoins this filter with the one specified by FILTERSPEC.
+FILTERSPEC may be a L<Net::LDAP::FilterBuilder> object, or a
+hash representation of the filter as taken by L<B<new>>.
+
+Returns the newly-conjoined L<Net::LDAP::FilterBuilder>.
+
+=item B<or>(FILTERSPEC)
+
+Logically disjoins this filter with the one specified by FILTERSPEC.
+FILTERSPEC may be a L<Net::LDAP::FilterBuilder> object, or a
+hash representation of the filter as taken by L<B<new>>.
+
+Returns the newly-disjoined L<Net::LDAP::FilterBuilder>.
+
+=item B<not>
+
+Logically complements this filter.
+
+Returns the newly-negated L<Net::LDAP::FilterBuilder>.
+
+=back
+
 =head1 AUTHOR
 
 Originally written by Ray Miller.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libnet-ldap-filterbuilder-perl.git.git



More information about the Pkg-perl-cvs-commits mailing list