How to make a Screen perform Actions - Revision history

Alan.stiles@open.ac.uk: /* Where to go after the action completes */ Added details about redirecting to an absolute url and changed pre tags to source tags on this section

2016-05-11T09:06:06Z

Where to go after the action completes: Added details about redirecting to an absolute url and changed pre tags to source tags on this section

← Older revision		Revision as of 09:06, 11 May 2016
Line 146:		Line 146:
	By default, the EPrints processor will then render whatever's in the render routine for the package that the action routines are in.		By default, the EPrints processor will then render whatever's in the render routine for the package that the action routines are in.
	If you want the EPrints processor to use a different package to render something to the page, then:		If you want the EPrints processor to use a different package to render something to the page, then:
	<~~pre~~>		<source lang="perl">
	sub action_cancel		sub action_cancel
	{		{
Line 154:		Line 154:
	$self->{processor}->{screenid} = "My::Package";		$self->{processor}->{screenid} = "My::Package";
	}		}
	</~~pre~~>		</source>
	will call the <code>render</code> routine in the package <code>EPrints::Plugin::Screen::My::Package</code>		will call the <code>render</code> routine in the package <code>EPrints::Plugin::Screen::My::Package</code> whilst:
			<source lang="perl">
			sub action_cancel
			{
			my( $self ) = @_;

			# Do stuff
			$self->{processor}->{redirect} = "http://wiki.eprints.org";
			}
			</source>
			will redirect the page to the url specified (in this case to the wiki homepage)

	Return to the main [[Screen_Plugins]] page.		Return to the main [[Screen_Plugins]] page.

2011-04-13T14:33:51Z

← Older revision		Revision as of 14:33, 13 April 2011
Line 1:		Line 1:
			[[Category:Howto]][[Category:Plugins]]

	Works in EPrints 3.2+		Works in EPrints 3.2+

2010-04-23T08:41:44Z

@@ Line 4: / Line 4: @@
   NOTE: in this page, $s is the ''session'' or ''repository'' object, and $f is the (x)html DOM fragment
 ===What's happening===
@@ Line 16: / Line 20: @@
 ### These routines could be spread out over several packages
 # Where to go after the ''action'' completes
 ===Making the buttons===
-The action buttons are the functionality that make the work... well, flow.
+The Buttons are the form submit buttons, the things that make the work flow to the next stage.
 The <code>$s->render_action_buttons</code> function takes a hash, which describes the set of buttons to display:
@@ Line 60: / Line 84: @@
 ===Processing the actions===
 The EPrints processor system calls a specified action in a named package (as detailed above)
 For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action''</code>... where ''action'' is the key given in the buttons hash above.

2010-04-23T08:38:28Z

What's happening

← Older revision		Revision as of 08:38, 23 April 2010
Line 8:		Line 8:

	The process has four parts:		The process has four parts:
			# Register the ''actions'' with the EPrints system
	# Some ''action'' buttons		# Some ''action'' buttons
	# Some ''action'' routines		# Some ''action'' routines

2010-04-23T08:36:14Z

Getting actions recognised

← Older revision		Revision as of 08:36, 23 April 2010
Line 80:		Line 80:

	</pre>		</pre>
			Note that the terms listed in the <code>$self->{actions}</code> array are the same terms as keys in the action buttons.

	For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action''</code>... where ''action'' is the key given in the buttons hash above.		For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action''</code>... where ''action'' is the key given in the buttons hash above.

2010-04-23T08:35:01Z

Getting actions recognised

← Older revision		Revision as of 08:35, 23 April 2010
Line 81:		Line 81:
	</pre>		</pre>

	For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action</code>... where ''action'' is the key given in the buttons hash above.		For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action''</code>... where ''action'' is the key given in the buttons hash above.

	====The ''allow'' test====		====The ''allow'' test====

2010-04-23T08:33:43Z

Getting actions recognised

← Older revision		Revision as of 08:33, 23 April 2010
Line 81:		Line 81:
	</pre>		</pre>

			For each possible action, two functions needed: <code>allow_''action''</code> and <code>action_''action</code>... where ''action'' is the key given in the buttons hash above.
	~~There are~~ two functions needed: <code>allow_''action''</code> and <code>action_''action</code>... where ''action'' is the key given in the buttons hash above.

	====The ''allow'' test====		====The ''allow'' test====

2010-04-23T08:31:29Z

Getting actions recognised

← Older revision		Revision as of 08:31, 23 April 2010
Line 72:		Line 72:
	= [qw/new edit cancel view netunlink netlink repounlink repolink/];		= [qw/new edit cancel view netunlink netlink repounlink repolink/];

	$self->{appears} = [		$self->{appears} = .....
	~~{ place => "admin_actions_editorial",~~
	~~position => 1000,~~
	},
	];

			## any other code.....

	return $self;		return $self;
	} ## end sub new		} ## end sub new

2010-04-23T08:30:47Z

Processing the actions

@@ Line 59: / Line 59: @@
 ===Processing the actions===
 The EPrints processor system calls a specified action in a named package (as detailed above)
 There are two functions needed: <code>allow_''action''</code> and <code>action_''action</code>... where ''action'' is the key given in the buttons hash above.

2010-04-15T13:56:41Z

The allow test

← Older revision		Revision as of 13:56, 15 April 2010
Line 66:		Line 66:
	A "True" return will permit the action.		A "True" return will permit the action.
	<pre>		<pre>
	sub allow_cancel {		sub allow_cancel
			{
	return 1; # everyone can do this "cancel" action		return 1; # everyone can do this "cancel" action
	}		}