Changeset 2100 for lang/perl/Class-Hookable

Timestamp:

11/28/07 12:30:04 (14 months ago)

Author:

nyarla

Message:

lang/perl/Class-Hookable: I implemented hookable_call_filter method.

Location:

lang/perl/Class-Hookable/trunk

Files:

• lib/Class/Hookable.pm (modified) (2 diffs)
• t/01_filter/02_hookable_call_filter.t (added)

lang/perl/Class-Hookable/trunk/lib/Class/Hookable.pm

@@ -79 +79 @@
         return $self->hookable_stash->{'filter_prefix'};
     }
+}
+
+sub hookable_call_filter {
+    my ( $self, $name, @args ) = @_;
+
+    Carp::croak "Filter name is not specified."
+        if ( ! $name );
+
+    my $prefix = $self->hookable_filter_prefix
+              || 'hookable_filter';
+
+    my $filter   = $self->hookable_stash->{'filters'}->{$name};
+       $filter ||= $self->can("${prefix}_${name}");
+       $filter ||= sub { return 1 };
+
+    return $filter->( $self, $name, @args );
 }
 
@@ -476 +492 @@
 =head2 hookable_call_filter
 
+  my $bool = $hook->hookable_call_filter( $name => @args );
+
+This method calls a specified filter.
+
+A filter name is specified as the first argument
+and an argument to a filter is specified as an argument after that.
+
+B<Search of filter>:
+
+This method searches for a filter from several places.
+
+First, when a specified filter is specified by C<$hook-E<gt>hookable_set_filter> method, 
+the filter is used.
+
+Next when C<$hook-E<gt>can("${prefix}_${filter_name}")> is defined,
+its method is used as a filter.
+
+C<${prefix}> is return value of $hook->hookable_filter_prefix,
+and C<${filter_name}> is the filter name specified as this method.
+
+When C<$hook-E<gt>hookble_filter_perfix> is not specified, 
+C<${prefix}> will be C<'hookable_filter'>.
+
+Please see L<"hookable_filter_prefix"> about C<$hook-E<gt>hookable_filter_prefix>.
+
+When a filter wasn't found, this method uses the filter to which truth is just always returned.
+
 B<Arguments of filter>:
 
+  $hook->hookable_set_filter(
+      'run_hook' => sub {
+          my ( $hook, $filter, @args ) = @_;
+      },
+  );
+
 =over 3
 
-=item register_hook / register_method
-
-=item run_hook (run_hook_once)
-
-=item call_method
+=item C<$hook>
+
+Instance of Class::Hookable (or the class inheriting to Class::Hookable).
+
+=item C<$filter>
+
+The filter name called in C<$hook-E<gt>hookable_call_filter>.
+
+=item C<@args>
+
+Arguments to the filter to which it was passed by C<$hook-E<gt>hookable_call_filter>.
 
 =back