Return URL after submitting entry

[cpaschen]

In JCB I created an admin view for a table and using that as the basis for a front-end edit form.
I've added a link on a dashboard screen that allows the user to edit their record (this is a custom 'user profile' type record - one per user).

The URL to open the edit (on front end) is:
http:///component/<component_name>/reviewer_profile/reviewer_profile/28?task=reviewer_profile.edit

When the user saves the record, they are taken to:
http:///dashboards-and-profiles/new-reviewer-profile/dashboard

I'm guessing that I SOMEHOW got the edit form to redirect to that URL; but now I can't for anything remember (or figure out) where/how the return value should be set

Anybody know how to manually set/change return values for a form (different for front-end than admin)?

[cpaschen]

OK ... I THINK I found where the return is being set.
In the Controller's __construct() function it sets:

$this->view_list = 'dashboard';

I need to change this to something else for the front-end; however, somewhere it is automatically getting pre-pended with the component name, turning it into 'component//dashbaord'

I see that this might be being processed in the controller's save function with this line:
$return = $this->input->get('return', null, 'base64');

But I can't find where this '$this->view_list' value is being further processed (pre-pended) to turn it into the return value.

I realize this isn't specifically a JCB issue, but I've searched all the Joomla code locations I can find with no results.

Anyone else ever need to have a front-end JCB-created form return to a different-than-standard location when it is saved?

[SimonvanDoorne]

A while ago i posted a simmilar question, my solution was the following. If you use a form to save and quit you can create a hidden field with the name return and the value (if i recall correctly) a base_64 encoded full joomla url. From what i've seen the controllers automatically find this value should set this value as the return value. This might not be the best way but at least you get the correct return.

[Llewellynvdm]

Watching the JUG, it sounds like my explanations are not very helpful 😄

So lets try again...

It is not that there is not away to do this, it is in fact that it is extremely easy. You see me doing it all over JCB where you can open linked-to or other related items. So you could just look at how we are doing this on many places. Sure you will need to pull in the JCB-JCB-Package then in Custom Code search for used:

Then open these custom code snippets and you will see some code that you can adapt, like this one:

// get input
$jinput = JFactory::getApplication()->input;
$return_here = $jinput->get('return_here', null, 'base64');
// set the return here value if not found
if ([[[Component]]]Helper::checkString($return_here))
{
	$return_here =  '&return=' . $return_here;
}
else
{
	$return_here = '&ref=[[[arg2]]]&refid=' . (int) $id;
}
$[[[arg0]]] = array();
foreach ($bucket as $editId => $values)
{
	if (($button = [[[Component]]]Helper::getEditTextButton($values['name'], $editId, $target['table'], $target['views'], $return_here, 'com_[[[component]]]', false, ''))
		&& [[[Component]]]Helper::checkString($button))
	{
		$[[[arg0]]][] = $button. ' (' . implode(', ', $values['fields']) . ')';
	}
}

To setup the return value the following code will work:

$return_here = urlencode(base64_encode((string) JUri::getInstance()));

Then you have this method getEditTextButton which I use allover the place and here is the code of that:

/**
* Get an edit button
* 
* @param  int      $item       The item to edit
* @param  string   $view       The type of item to edit
* @param  string   $views      The list view controller name
* @param  string   $ref        The return path
* @param  string   $component  The component these views belong to
* @param  string   $headsup    The message to show on click of button
*
* @return  string    On success the full html link
* 
*/
public static function getEditButton(&$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $headsup = 'COM_COMPONENTBUILDER_ALL_UNSAVED_WORK_ON_THIS_PAGE_WILL_BE_LOST_ARE_YOU_SURE_YOU_WANT_TO_CONTINUE')
{
	// get URL
	$url = self::getEditURL($item, $view, $views, $ref, $component);
	// check if we found any
	if (self::checkString($url))
	{
		// get the global settings
		if (!self::checkObject(self::$params))
		{
			self::$params = JComponentHelper::getParams('com_componentbuilder');
		}
		// get UIKIT version
		$uikit = self::$params->get('uikit_version', 2);
		// check that we have the ID
		if (self::checkObject($item) && isset($item->id))
		{
			// check if the checked_out is available
			if (isset($item->checked_out))
			{
				$checked_out = (int) $item->checked_out;
			}
			else
			{
				$checked_out = self::getVar($view, $item->id, 'id', 'checked_out', '=', str_replace('com_', '', $component));
			}
		}
		elseif (self::checkArray($item) && isset($item['id']))
		{
			// check if the checked_out is available
			if (isset($item['checked_out']))
			{
				$checked_out = (int) $item['checked_out'];
			}
			else
			{
				$checked_out = self::getVar($view, $item['id'], 'id', 'checked_out', '=', str_replace('com_', '', $component));
			}
		}
		elseif (is_numeric($item) && $item > 0)
		{
			$checked_out = self::getVar($view, $item, 'id', 'checked_out', '=', str_replace('com_', '', $component));
		}
		// set the link title
		$title = self::safeString(JText::_('COM_COMPONENTBUILDER_EDIT') . ' ' . $view, 'W');
		// check that there is a check message
		if (self::checkString($headsup))
		{
			if (3 == $uikit)
			{
				$href = 'onclick="UIkit.modal.confirm(\''.JText::_($headsup).'\').then( function(){ window.location.href = \'' . $url . '\' } )"  href="javascript:void(0)"';
			}
			else
			{
				$href = 'onclick="UIkit2.modal.confirm(\''.JText::_($headsup).'\', function(){ window.location.href = \'' . $url . '\' })"  href="javascript:void(0)"';
			}
		}
		else
		{
			$href = 'href="' . $url . '"';
		}
		// return UIKIT version 3
		if (3 == $uikit)
		{
			// check if it is checked out
			if (isset($checked_out) && $checked_out > 0)
			{
				// is this user the one who checked it out
				if ($checked_out == JFactory::getUser()->id)
				{
					return ' <a ' . $href . ' uk-icon="icon: lock" title="' . $title . '"></a>';
				}
				return ' <a href="#" disabled uk-icon="icon: lock" title="' . JText::sprintf('COM_COMPONENTBUILDER__HAS_BEEN_CHECKED_OUT_BY_S', self::safeString($view, 'W'), JFactory::getUser($checked_out)->name) . '"></a>'; 
			}
			// return normal edit link
			return ' <a ' . $href . ' uk-icon="icon: pencil" title="' . $title . '"></a>';
		}
		// check if it is checked out (return UIKIT version 2)
		if (isset($checked_out) && $checked_out > 0)
		{
			// is this user the one who checked it out
			if ($checked_out == JFactory::getUser()->id)
			{
				return ' <a ' . $href . ' class="uk-icon-lock" title="' . $title . '"></a>';
			}
			return ' <a href="#" disabled class="uk-icon-lock" title="' . JText::sprintf('COM_COMPONENTBUILDER__HAS_BEEN_CHECKED_OUT_BY_S', self::safeString($view, 'W'), JFactory::getUser($checked_out)->name) . '"></a>'; 
		}
		// return normal edit link
		return ' <a ' . $href . ' class="uk-icon-pencil" title="' . $title . '"></a>';
	}
	return '';
}

/**
* Get an edit text button
* 
* @param  string   $text       The button text
* @param  int      $item       The item to edit
* @param  string   $view       The type of item to edit
* @param  string   $views      The list view controller name
* @param  string   $ref        The return path
* @param  string   $component  The component these views belong to
* @param  string   $headsup    The message to show on click of button
*
* @return  string    On success the full html link
* 
*/
public static function getEditTextButton($text, &$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $jRoute = true, $class = 'uk-button', $headsup = 'COM_COMPONENTBUILDER_ALL_UNSAVED_WORK_ON_THIS_PAGE_WILL_BE_LOST_ARE_YOU_SURE_YOU_WANT_TO_CONTINUE')
{
	// make sure we have text
	if (!self::checkString($text))
	{
		return self::getEditButton($item, $view, $views, $ref, $component, $headsup);
	}
	// get URL
	$url = self::getEditURL($item, $view, $views, $ref, $component, $jRoute);
	// check if we found any
	if (self::checkString($url))
	{
		// get the global settings
		if (!self::checkObject(self::$params))
		{
			self::$params = JComponentHelper::getParams('com_componentbuilder');
		}
		// get UIKIT version
		$uikit = self::$params->get('uikit_version', 2);
		// check that we have the ID
		if (self::checkObject($item) && isset($item->id))
		{
			// check if the checked_out is available
			if (isset($item->checked_out))
			{
				$checked_out = (int) $item->checked_out;
			}
			else
			{
				$checked_out = self::getVar($view, $item->id, 'id', 'checked_out', '=', str_replace('com_', '', $component));
			}
		}
		elseif (self::checkArray($item) && isset($item['id']))
		{
			// check if the checked_out is available
			if (isset($item['checked_out']))
			{
				$checked_out = (int) $item['checked_out'];
			}
			else
			{
				$checked_out = self::getVar($view, $item['id'], 'id', 'checked_out', '=', str_replace('com_', '', $component));
			}
		}
		elseif (is_numeric($item) && $item > 0)
		{
			$checked_out = self::getVar($view, $item, 'id', 'checked_out', '=', str_replace('com_', '', $component));
		}
		// set the link title
		$title = self::safeString(JText::_('COM_COMPONENTBUILDER_EDIT') . ' ' . $view, 'W');
		// check that there is a check message
		if (self::checkString($headsup))
		{
			if (3 == $uikit)
			{
				$href = 'onclick="UIkit.modal.confirm(\''.JText::_($headsup).'\').then( function(){ window.location.href = \'' . $url . '\' } )"  href="javascript:void(0)"';
			}
			else
			{
				$href = 'onclick="UIkit2.modal.confirm(\''.JText::_($headsup).'\', function(){ window.location.href = \'' . $url . '\' })"  href="javascript:void(0)"';
			}
		}
		else
		{
			$href = 'href="' . $url . '"';
		}
		// return UIKIT version 3
		if (3 == $uikit)
		{
			// check if it is checked out
			if (isset($checked_out) && $checked_out > 0)
			{
				// is this user the one who checked it out
				if ($checked_out == JFactory::getUser()->id)
				{
					return ' <a class="' . $class . '" ' . $href . ' title="' . $title . '">' . $text . '</a>';
				}
				return ' <a class="' . $class . '" href="#" disabled title="' . JText::sprintf('COM_COMPONENTBUILDER__HAS_BEEN_CHECKED_OUT_BY_S', self::safeString($view, 'W'), JFactory::getUser($checked_out)->name) . '">' . $text . '</a>'; 
			}
			// return normal edit link
			return ' <a class="' . $class . '" ' . $href . ' title="' . $title . '">' . $text . '</a>';
		}
		// check if it is checked out (return UIKIT version 2)
		if (isset($checked_out) && $checked_out > 0)
		{
			// is this user the one who checked it out
			if ($checked_out == JFactory::getUser()->id)
			{
				return ' <a class="' . $class . '" ' . $href . ' title="' . $title . '">' . $text . '</a>';
			}
			return ' <a class="' . $class . '" href="#" disabled title="' . JText::sprintf('COM_COMPONENTBUILDER__HAS_BEEN_CHECKED_OUT_BY_S', self::safeString($view, 'W'), JFactory::getUser($checked_out)->name) . '">' . $text . '</a>'; 
		}
		// return normal edit link
		return ' <a class="' . $class . '" ' . $href . ' title="' . $title . '">' . $text . '</a>';
	}
	return '';
}

/**
* Get the edit URL
* 
* @param  int      $item        The item to edit
* @param  string   $view        The type of item to edit
* @param  string   $views       The list view controller name
* @param  string   $ref         The return path
* @param  string   $component   The component these views belong to
* @param  bool     $jRoute      The switch to add use JRoute or not
*
* @return  string    On success the edit url
* 
*/
public static function getEditURL(&$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $jRoute = true)
{
	// build record
	$record = new stdClass();
	// check if user can edit
	if (self::canEditItem($record, $item, $view, $views, $component))
	{
		// set the edit link
		if ($jRoute)
		{
			return JRoute::_("index.php?option=" . $component . "&view=" . $views . "&task=" . $view . ".edit&id=" . $record->id . $ref);
		}
		return "index.php?option=" . $component . "&view=" . $views . "&task=" . $view . ".edit&id=" . $record->id . $ref;
	}
	return false;
}

/**
* Can Edit (either any, or own)
* 
* @param  int      $item        The item to edit
* @param  string   $view        The type of item to edit
* @param  string   $views       The list view controller name
* @param  string   $component   The component these views belong to
*
* @return  bool    if user can edit returns true els
* 
*/
public static function allowEdit(&$item, $view, $views, $component = 'com_componentbuilder')
{
	// build record
	$record = new stdClass();
	return self::canEditItem($record, $item, $view, $views, $component);
}


/**
* Can Edit (either any, or own)
* 
* @param  int      $item        The item to edit
* @param  string   $view        The type of item to edit
* @param  string   $views       The list view controller name
* @param  string   $component   The component these views belong to
*
* @return  bool    if user can edit returns true els
* 
*/
protected static function canEditItem(&$record, &$item, $view, $views, $component = 'com_componentbuilder')
{
	// make sure the user has access to view
	if (!JFactory::getUser()->authorise($view. '.access', $component))
	{
		return false;
	}
	// we start with false.
	$can_edit = false;
	// check that we have the ID
	if (self::checkObject($item) && isset($item->id))
	{
		$record->id = (int) $item->id;
		// check if created_by is available
		if (isset($item->created_by) && $item->created_by > 0)
		{
			$record->created_by = (int) $item->created_by;
		}
	}
	elseif (self::checkArray($item) && isset($item['id']))
	{
		$record->id = (int) $item['id'];
		// check if created_by is available
		if (isset($item['created_by']) && $item['created_by'] > 0)
		{
			$record->created_by = (int) $item['created_by'];
		}
	}
	elseif (is_numeric($item))
	{
		$record->id = (int) $item;
	}
	// check ID
	if (isset($record->id) && $record->id > 0)
	{
		// get user action permission to edit
		$action = self::getActions($view, $record, $views, 'edit', str_replace('com_', '', $component));
		// check if the view permission is set
		if (($can_edit = $action->get($view . '.edit', 'none-set')) === 'none-set')
		{
			// fall back on the core permission then (this can be an issue)
			$can_edit = ($action->get('core.edit', false) || $action->get('core.edit.own', false));
		}
	}
	return $can_edit;
}

Let me know if this explains enough...?