Open Journal Systems  3.3.0
RedirectAction Class Reference
Inheritance diagram for RedirectAction:
LinkActionRequest PostAndRedirectAction

Public Member Functions

 __construct ($url, $name='_self', $specs='')
 
 getJSLinkActionRequest ()
 
 getLocalizedOptions ()
 
 getName ()
 
 getSpecs ()
 
 getUrl ()
 
- Public Member Functions inherited from LinkActionRequest
 __construct ()
 

Data Fields

 $_name
 
 $_specs
 
 $_url
 

Detailed Description

This action request redirects to another page.

Definition at line 18 of file RedirectAction.inc.php.

Constructor & Destructor Documentation

◆ __construct()

RedirectAction::__construct (   $url,
  $name = '_self',
  $specs = '' 
)

Constructor

Parameters
$urlstring Target URL
$namestring Name of window to direct (defaults to current window)
$specsstring Optional set of window specs (see window.open JS reference)

Definition at line 43 of file RedirectAction.inc.php.

Member Function Documentation

◆ getJSLinkActionRequest()

RedirectAction::getJSLinkActionRequest ( )
See also
LinkActionRequest::getJSLinkActionRequest()

Reimplemented from LinkActionRequest.

Reimplemented in PostAndRedirectAction.

Definition at line 87 of file RedirectAction.inc.php.

◆ getLocalizedOptions()

RedirectAction::getLocalizedOptions ( )
See also
LinkActionRequest::getLocalizedOptions()

Reimplemented from LinkActionRequest.

Reimplemented in PostAndRedirectAction.

Definition at line 94 of file RedirectAction.inc.php.

References getName(), getSpecs(), and getUrl().

◆ getName()

RedirectAction::getName ( )

Get the target name. See JS reference for the name parameter to "window.open".

Returns
string

Definition at line 67 of file RedirectAction.inc.php.

References $_name.

Referenced by getLocalizedOptions().

◆ getSpecs()

RedirectAction::getSpecs ( )

Get the target specifications. See JS reference for the specs parameter to "window.open".

Returns
string

Definition at line 76 of file RedirectAction.inc.php.

References $_specs.

Referenced by getLocalizedOptions().

◆ getUrl()

RedirectAction::getUrl ( )

Get the target URL.

Returns
string

Definition at line 58 of file RedirectAction.inc.php.

References $_url.

Referenced by getLocalizedOptions().

Field Documentation

◆ $_name

string RedirectAction::$_name

The name of the window

Definition at line 29 of file RedirectAction.inc.php.

Referenced by getName().

◆ $_specs

string RedirectAction::$_specs

The specifications of the window

Definition at line 35 of file RedirectAction.inc.php.

Referenced by getSpecs().

◆ $_url

string RedirectAction::$_url

The URL this action will invoke

Definition at line 23 of file RedirectAction.inc.php.

Referenced by getUrl().


The documentation for this class was generated from the following file: