Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
/.idea/
/.idea/
composer.lock
public/
vendor/
.phpunit.result.cache
app/
15 changes: 12 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@
"description": "Allows complex menu management to be handled through the CMS when a simple tree structure is not enough.",
"license": "MIT",
"require": {
"silverstripe/cms": "^5",
"symbiote/silverstripe-gridfieldextensions": "^4.0"
"silverstripe/cms": "^6",
"symbiote/silverstripe-gridfieldextensions": "^5",
"silverstripe/asset-admin": "^3"
},
"require-dev": {
"phpunit/phpunit": "^11.5",
"squizlabs/php_codesniffer": "^3.7.2"
},
"autoload": {
"psr-4": {
"Heyday\\MenuManager\\": "src/"
"Heyday\\MenuManager\\": "src/",
"Heyday\\MenuManager\\Test\\": "tests/"
}
},
"extra": {
Expand All @@ -28,5 +31,11 @@
"composer/installers": true,
"silverstripe/vendor-plugin": true
}
},
"scripts": {
"test": "phpunit -d memory_limit=512M -d flush=1",
"test-with-coverage": [
"phpunit --coverage-html coverage/php --coverage-clover coverage/php/clover.xml"
]
}
}
14 changes: 14 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd">
<testsuite name="Default">
<directory>tests/</directory>
</testsuite>
<source>
<include>
<directory suffix=".php">src/</directory>
</include>
<exclude>
<directory suffix=".php">tests/</directory>
</exclude>
</source>
</phpunit>
7 changes: 4 additions & 3 deletions src/Extensions/MenuSubsiteExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
namespace Heyday\MenuManager\Extensions;

use Heyday\MenuManager\MenuSet;
use SilverStripe\Core\Extension;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HiddenField;
use SilverStripe\ORM\DataExtension;

if (!class_exists('\SilverStripe\Subsites\Model\Subsite') || !class_exists('\SilverStripe\Subsites\State\SubsiteState')) {
if (!class_exists('\SilverStripe\Subsites\Model\Subsite') ||
!class_exists('\SilverStripe\Subsites\State\SubsiteState')) {
return;
}

class MenuSubsiteExtension extends DataExtension
class MenuSubsiteExtension extends Extension
{
private static $has_one = [
'Subsite' => 'SilverStripe\Subsites\Model\Subsite'
Expand Down
8 changes: 4 additions & 4 deletions src/Extensions/SubsiteExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

use Heyday\MenuManager\MenuSet;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HiddenField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\Core\Extension;

if (!class_exists('\SilverStripe\Subsites\Model\Subsite') || !class_exists('\SilverStripe\Subsites\State\SubsiteState')) {
if (!class_exists('\SilverStripe\Subsites\Model\Subsite') ||
!class_exists('\SilverStripe\Subsites\State\SubsiteState')) {
return;
}

class SubsiteExtension extends DataExtension
class SubsiteExtension extends Extension
{
private static $has_many = [
'MenuSets' => MenuSet::class
Expand Down
2 changes: 1 addition & 1 deletion src/MenuItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ public function Parent()
* @param string $field
* @return mixed
*/
public function __get($field)
public function __get(string $field): mixed
{
$default = parent::__get($field);

Expand Down
4 changes: 2 additions & 2 deletions src/MenuSet.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Core\Validation\ValidationResult;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
Expand Down Expand Up @@ -65,7 +65,7 @@ public function providePermissions(): array
*
* {@inheritDoc}
*/
public function validate()
public function validate(): ValidationResult
{
$result = parent::validate();

Expand Down
31 changes: 31 additions & 0 deletions tests/MenuAdminTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace Heyday\MenuManager\Test;

use Heyday\MenuManager\MenuAdmin;
use Heyday\MenuManager\MenuSet;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\Session;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\GridField\GridField;

class MenuAdminTest extends SapphireTest
{
protected static $fixture_file = 'MenuTest.yml';

public function testEditForm(): void
{
$menuSetName = str_replace('\\', '-', MenuSet::class);
$admin = Injector::inst()->get(MenuAdmin::class);
$request = Injector::inst()->get(HTTPRequest::class, true, ['GET', '']);
$request->setSession(new Session([]));
$request->setRouteParams(['ModelClass' => $menuSetName]);
$admin->setRequest($request);
$admin->doInit();

$form = $admin->getEditForm()->Fields();
$this->assertInstanceOf(GridField::class, $form->dataFieldByName($menuSetName));
}

}
48 changes: 48 additions & 0 deletions tests/MenuItemTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

namespace Heyday\MenuManager\Test;

use Heyday\MenuManager\MenuItem;
use Heyday\MenuManager\MenuSet;
use SilverStripe\AssetAdmin\Forms\UploadField;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\OptionsetField;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\TreeDropdownField;

class MenuItemTest extends SapphireTest
{
protected static $fixture_file = 'MenuTest.yml';

public function testPermission(): void
{
$this->logInWithPermission('MANAGE_MENU_SETS');
$item = $this->objFromFixture(MenuItem::class, 'header-1');
$this->assertFalse($item->canCreate());
$this->assertFalse($item->canEdit());
$this->assertFalse($item->canView());
$this->assertFalse($item->canDelete());

$this->logInWithPermission('MANAGE_MENU_ITEMS');
$this->assertTrue($item->canCreate());
$this->assertTrue($item->canEdit());
$this->assertTrue($item->canView());
$this->assertTrue($item->canDelete());
}

public function testCmsFields(): void
{
$item = $this->objFromFixture(MenuItem::class, 'header-1');
$fields = $item->getCMSFields();

$this->assertInstanceOf(OptionsetField::class, $fields->dataFieldByName('LinkType'));
$this->assertInstanceOf(TextField::class, $fields->dataFieldByName('MenuTitle'));
$this->assertInstanceOf(TreeDropdownField::class, $fields->dataFieldByName('PageID'));
$this->assertInstanceOf(TextField::class, $fields->dataFieldByName('Link'));
$this->assertInstanceOf(TextField::class, $fields->dataFieldByName('Anchor'));
$this->assertInstanceOf(CheckboxField::class, $fields->dataFieldByName('IsNewWindow'));
$this->assertInstanceOf(UploadField::class, $fields->dataFieldByName('File'));
}

}
50 changes: 50 additions & 0 deletions tests/MenuSetTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace Heyday\MenuManager\Test;

use Heyday\MenuManager\MenuSet;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\TextField;

class MenuSetTest extends SapphireTest
{
protected static $fixture_file = 'MenuTest.yml';

public function testPermission(): void
{
$this->logOut();
$menu = $this->objFromFixture(MenuSet::class, 'header');
$this->assertFalse($menu->canCreate());
$this->assertFalse($menu->canEdit());
$this->assertFalse($menu->canView());
$this->assertFalse($menu->canDelete());

$this->logInWithPermission('MANAGE_MENU_SETS');
$this->assertTrue($menu->canCreate());
$this->assertTrue($menu->canEdit());
$this->assertTrue($menu->canView());
$this->assertTrue($menu->canDelete());

Config::inst()->merge(MenuSet::class, null, ['default_sets' => [
'Header'
]]);
$this->assertFalse($menu->canDelete());
}

public function testCmsFields(): void
{
$menu = $this->objFromFixture(MenuSet::class, 'header');
$fields = $menu->getCMSFields();

$this->assertInstanceOf(GridField::class, $fields->dataFieldByName('MenuItems'));
$this->assertNull($fields->dataFieldByName('Name'));

$this->assertInstanceOf(
TextField::class,
MenuSet::create()->getCMSFields()->dataFieldByName('Name')
);
}

}
36 changes: 36 additions & 0 deletions tests/MenuTest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Page:
home:
Title: 'Home'
URLSegment: 'home'

Heyday\MenuManager\MenuSet:
header:
Name: Header
footer:
Name: Footer 1

Heyday\MenuManager\MenuItem:
header-1:
MenuTitle: Header 1
Page: =>Page.home
MenuSet: =>Heyday\MenuManager\MenuSet.header
header-2:
MenuTitle: Header 2
Link: '#'
MenuSet: =>Heyday\MenuManager\MenuSet.header
header-3:
MenuTitle: Header 3
Link: '#'
MenuSet: =>Heyday\MenuManager\MenuSet.header
footer-item-1:
MenuTitle: Footer 1
Link: '#'
MenuSet: =>Heyday\MenuManager\MenuSet.footer
footer-item-2:
MenuTitle: Footer 2
Link: '#'
MenuSet: =>Heyday\MenuManager\MenuSet.footer
footer-item-3:
MenuTitle: Footer 3
Link: '#'
MenuSet: =>Heyday\MenuManager\MenuSet.footer
Loading