Skip to content

Latest commit

 

History

History
157 lines (93 loc) · 3.87 KB

Link.pod

File metadata and controls

157 lines (93 loc) · 3.87 KB

NAME

Catalyst::Link

SYNOPSIS

Include the Plugin in your application class:

package MyApp;
use Catalyst qw/
    Link
/;

Then add the following to any controllers you want to use link

with 'Catalyst::Controller::Role::Link';

Alternatively if you want to use it throughout your controllers Create a base...

package MyApp::Controller;
use Moose;

BEGIN { extends 'Catalyst::Contoller' };
with 'Catalyst::Controller::Role::Link';

obviously not forgetting to switch out the BEGIN in each of your controllers.

package DemoApp::Controller::Book';
BEGIN { extends 'MyApp::Controller' };

Finally you now have an option, link needs to associate capturedArgs with a key Its default behaviour is to use the actions PathPart, however not every capture has a PathPart so for these occasion you can set a Name attribute.

sub chain :Chained('base') :PathPart('') :CapturedArgs(1) :Name('author'){}

basic usage $c->link($action, @||%captured_args, %query_params),

# if you are in a controller say book/list we need a capture to get to edit 
# if you have an object and you're lazy like me
$c->link('edit', { book => $book }); 
# if you just have an id
$c->link('edit', { book_id => $id }); 
# but then again why not just do this
$c->link('edit', [$id]);
# sometimes you may want to be a little more specific on the desired controller
$c->controller('Book')->link($c, 'edit', [$book->id]),

you can also use this in your templates

[% c.link('edit', [book.id]) %]

DESCRIPTION

Link allows you to build dynamic links... which leads to extendable controllers.

Currently I do not think there is a way of building a uri for a relative path.

For example if I wanted the same functionality in several places accross my web app, I could build my controllers at the root and then simply extend them as stub controllers in the relevant places, Alternatively you can do similar with controller roles.

However what I discovered was uri_for_action can get very messy very quickly (for a newb). It's currently not smart enough to understand where the user is in the chain and where they should be linked to next.

link uses the dispatcher to lookup a pre-processed action_path. We then loop through each action in that dispatcher chain to check whether any CapturedArgs are associated. Once we have that its simple to build the correct uri_for_action call without all the mess.

METHODS

link

There are two ways of calling link

$c->link($action_name, $args, $query_values)
$c->controller('Book')->link($c, $action_name, $args, $query_values);

action_name

root
# http://localhost/
$c->link('/');
link within the controller
$c->link('view')
from the root
# http://localhost/book/list
$c->link('/book/list');
relatively down the chain
# start url http://localhost/author/1/view 
# http://localhost/author/1/book/list
$c->link('book/list');
relatively up the chain droping one capture
# start url http://localhost/author/1/book/1/view 
# http://localhost/author/1/view
$c->link('</view');

'<' tells link that we are going up the chain

relatively up the chain and then down again
# start url http://localhost/author/1/book/1/view 
# http://localhost/book/list
$c->link('<../../book/list');

'..' tells link that we need to drop a capture, you can drop as many as you like '<../../..'

args

object
$c->link('edit', { capture => $object });
id
$c->link('edit', { capture_id => $id });
array
$c->link('edit', [ $id ]);

query_params

Exactly the same as you would for uri_for_action

# http://localhost/author/1/edit?this=thing
$c->link('edit', [$id], { this => 'thing' });

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 94:

'=item' outside of any '=over'

Around line 134:

You forgot a '=back' before '=head3'

Around line 136:

'=item' outside of any '=over'

Around line 148:

You forgot a '=back' before '=head3'