1 package Reaction::UI::ViewPort::Role::Actions;
4 use Reaction::UI::ViewPort::URI;
6 use namespace::clean -except => [ qw(meta) ];
13 has action_filter => (
14 isa => 'CodeRef', is => 'ro',
17 has action_prototypes => (
24 has computed_action_order => (
30 sub _filter_action_list {
32 my $actions = [keys %{$self->action_prototypes}];
33 return $self->has_action_filter ?
34 $self->action_filter->($actions, $self->model)
38 sub _build_computed_action_order {
40 my $ordered = $self->sort_by_spec(
41 ($self->has_action_order ? $self->action_order : []),
42 $self->_filter_action_list
51 my $loc = $self->location;
52 my $target = $self->model;
53 my $valid_actions = $self->has_action_filter ?
54 $self->action_filter->($self->computed_action_order, $self->model)
55 : $self->computed_action_order;
57 foreach my $proto_name ( @$valid_actions ) {
58 my $proto = $self->action_prototypes->{$proto_name};
59 my $uri = $proto->{uri} or confess('uri is required in prototype action');
60 my $label = exists $proto->{label} ? $proto->{label} : $proto_name;
61 my $layout = exists $proto->{layout} ? $proto->{layout} : 'uri';
63 my $action = Reaction::UI::ViewPort::URI->new(
64 location => join ('-', $loc, 'action', $i++),
65 uri => ( ref($uri) eq 'CODE' ? $uri->($target, $ctx) : $uri ),
66 display => ( ref($label) eq 'CODE' ? $label->($target, $ctx) : $label ),
67 layout => ( ref($layout) eq 'CODE' ? $layout->($target, $ctx) : $layout ),
80 Reaction::UI::ViewPort::Role::Actions
84 A role to ease attaching actions to L<Reaction::InterfaceModel::Object>s
90 Read-only, lazy-building ArrayRef of URI objects pointing to actions.
92 =head2 action_prototypes
94 A HashRef of prototypes for building the Action links. The prototypes should be
97 my %action_prototypes = (
98 example_action => { label => 'Example Action', uri => $uri_obj },
101 #or you can get fancy and do something like what is below:
103 my($im, $ctx) = @_; #InterfaceModel::Object/Collection, Catalyst Context
107 my($im, $ctx) = @_; #InterfaceModel::Object/Collection, Catalyst Context
108 return return $ctx->uri_for('some_action');
110 my %action_prototypes = (
111 example_action => { label => \&make_label, uri => \&make_uri },
116 User-provided ArrayRef with how the actions should be ordered eg
118 action_order => [qw/view edit delete/]
120 =head2 computed_action_order
122 Read-only lazy-building ARRAY ref. The final computed action order. This may
123 differ from the C<action_order> provided if you any actions were not included
128 =head2 _build_actions
130 Cycle through the C<computed_action_order> and create a new
131 L<ViewPort::URI|Reaction::UI::ViewPort::URI> object for each action using the
134 =head2 _build_computed_action_order
136 Compute the final action ordering by using the provided C<action_order> as a
137 spec to order all the present actions (the keys of C<action_prototypes>)
139 =head1 ACTION PROTOTYPES
141 Action prototypes are simply hashrefs that must contain a C<uri> key and may
142 contain a C<label> key. The label can be anything that the display attribute of
143 L<ViewPort::URI|Reaction::UI::ViewPort::URI> will accept, usually a scalar or a
144 ViewPort. The value for C<uri> may be either a scalar, a L<URI> object (or
145 anything that C<ISA URI>).
147 Additionally, both C<label> and C<uri> can be CODE refs. In this case, the code
148 will be executed at C<_build_actions> time and will recieve two arguments, the
149 value returned by C<model> and the value returned by C<ctx> in that order. Both
150 of these methods should be implemented in the consuming class. By convention,
151 model refers to the target of the action, an C<InterfaceModel::Object> in the
152 case of a member action and an C<InterfaceModel::Collection> in the case of a
153 Collection action. C<ctx> should be the current Catalyst context.
157 See L<Reaction::Class> for authors.
161 See L<Reaction::Class> for the license.