tonyair/silverstripe-betternavigator
1
0
Fork 0
mirror of https://github.com/jonom/silverstripe-betternavigator.git synced 2024-10-22 14:05:51 +02:00
Code Issues Projects Releases Wiki Activity

Fix conditional rendering

Browse Source 
Ensure scripts and css are only loaded with navigator markup is present, and support HTTPResponse as input. Fixes #46
This commit is contained in:
Jonathon Menz 2020-03-11 16:37:45 -07:00
parent d037dc8ebd
commit 02e84d7b99
2 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
src/Extension/BetterNavigatorExtension.php
View File

@ -6,9 +6,10 @@ use SilverStripe\CMS\Controllers\SilverStripeNavigator;
use SilverStripe\CMS\Model\SiteTree; use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller; use SilverStripe\Control\Controller;
use SilverStripe\Control\Director; use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Core\Config\Config; use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\ORM\DataExtension; use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\Security\LogoutForm; use SilverStripe\Security\LogoutForm;
use SilverStripe\Security\Member; use SilverStripe\Security\Member;
use SilverStripe\Security\Permission; use SilverStripe\Security\Permission;
@ -26,35 +27,26 @@ class BetterNavigatorExtension extends DataExtension
*/ */
private $shouldDisplay = null; private $shouldDisplay = null;
/**
* Load requirements in before final render. When the next extension point is called, it's too late.
* @return void
*/
public function beforeCallActionHandler()
{
if ($this->shouldDisplay()) {
Requirements::javascript('jonom/silverstripe-betternavigator: javascript/betternavigator.js');
Requirements::css('jonom/silverstripe-betternavigator: css/betternavigator.css');
}
}
/** /**
* @param $request * @param $request
* @param $action * @param $action
* @param DBHTMLText $result * @param DBHTMLText|HTTPResponse $result (actually could be anything such as a string, controller or object)
* @return DBHTMLText * @return DBHTMLText|HTTPResponse
*/ */
public function afterCallActionHandler($request, $action, $result) public function afterCallActionHandler($request, $action, $result)
{ {
if (!$this->shouldDisplay()) { // Known issue: if $result is a Controller then BetterNavigator won't be rendered.
// See https://github.com/jonom/silverstripe-betternavigator/issues/47#issuecomment-682120739
// Check that we're dealing with HTML
$isHtmlResponse = $result instanceof DBHTMLText ||
$result instanceof HTTPResponse && strpos($result->getHeader('content-type'), 'text/html') !== false;
if (!$isHtmlResponse || !$this->shouldDisplay()) {
return $result; return $result;
} }
if (!($result instanceof DBHTMLText)) { $html = $result instanceof DBHTMLText ? $result->getValue() : $result->getBody();
return $result;
}
$html = $result->getValue();
$navigatorHTML = $this->generateNavigator()->getValue(); $navigatorHTML = $this->generateNavigator()->getValue();
// Inject the NavigatorHTML before the closing </body> tag // Inject the NavigatorHTML before the closing </body> tag
@ -63,7 +55,11 @@ class BetterNavigatorExtension extends DataExtension
$navigatorHTML . '\\1', $navigatorHTML . '\\1',
$html $html
); );
$result->setValue($html); if ($result instanceof DBHTMLText) {
$result->setValue($html);
} else {
$result->setBody($html);
}
return $result; return $result;
} }
@ -107,7 +103,7 @@ class BetterNavigatorExtension extends DataExtension
} }
// Only show edit link if user has permission to edit this page // Only show edit link if user has permission to edit this page
$editLink = array_key_exists('CMSLink', $nav) $editLink = array_key_exists('CMSLink', $nav)
&& ($isDev || $this->owner->dataRecord->canEdit() && Permission::check('CMS_ACCESS_CMSMain')) && ($isDev || $this->owner->dataRecord->canEdit() && Permission::check('CMS_ACCESS_CMSMain'))
? $nav['CMSLink']['Link'] : false; ? $nav['CMSLink']['Link'] : false;
// Is the logged in member nominated as a developer? // Is the logged in member nominated as a developer?
@ -120,6 +116,7 @@ class BetterNavigatorExtension extends DataExtension
$backURL = '?BackURL=' . urlencode($this->owner->Link()); $backURL = '?BackURL=' . urlencode($this->owner->Link());
$logoutForm = LogoutForm::create($this->owner)->setName('BetterNavigatorLogoutForm'); $logoutForm = LogoutForm::create($this->owner)->setName('BetterNavigatorLogoutForm');
$logoutForm->Fields()->fieldByName('BackURL')->setValue($this->owner->Link()); $logoutForm->Fields()->fieldByName('BackURL')->setValue($this->owner->Link());
$bnModule = ModuleLoader::getModule('jonom/silverstripe-betternavigator');
$bNData = array_merge($nav, [ $bNData = array_merge($nav, [
'Member' => $member, 'Member' => $member,
'Stage' => Versioned::get_stage(), 'Stage' => Versioned::get_stage(),
@ -129,7 +126,9 @@ class BetterNavigatorExtension extends DataExtension
'LogoutForm' => $logoutForm, 'LogoutForm' => $logoutForm,
'EditLink' => $editLink, 'EditLink' => $editLink,
'Mode' => Director::get_environment_type(), 'Mode' => Director::get_environment_type(),
'IsDeveloper' => $isDeveloper 'IsDeveloper' => $isDeveloper,
'ScriptUrl' => $bnModule->getResource('javascript/betternavigator.js')->getURL(),
'CssUrl' => $bnModule->getResource('css/betternavigator.css')->getURL(),
]); ]);
// Merge with page data, send to template and render // Merge with page data, send to template and render

3
templates/BetterNavigator/BetterNavigator.ss
View File

@ -86,3 +86,6 @@
</div> </div>
</div> </div>
<script type="application/javascript" src="$ScriptUrl"></script>
<link rel="stylesheet" href="$CssUrl" />