├── .coveralls.yml
├── .editorconfig
├── .gitignore
├── .travis.yml
├── API.md
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── composer.json
├── config
    ├── cms-api.php
    ├── cms-core.php
    └── cms-modules.php
├── documentation
    ├── Development.md
    ├── Development
    │   ├── CreatingModules.md
    │   └── ViewsAndScripts.md
    ├── Menu.md
    ├── Modules.md
    ├── StandardInstallation.md
    └── Troubleshooting.md
├── phpunit.xml.dist
├── src
    ├── Api
    │   ├── ApiCore.php
    │   ├── Response
    │   │   ├── RestResponseBuilder.php
    │   │   └── TransformContainer.php
    │   └── Transformers
    │   │   ├── ModuleTransformer.php
    │   │   └── VersionTransformer.php
    ├── Auth
    │   └── AclRepository.php
    ├── Console
    │   └── Commands
    │   │   ├── CacheMenu.php
    │   │   ├── ClearMenuCache.php
    │   │   ├── CmsMigrationContextTrait.php
    │   │   ├── MigrateCommand.php
    │   │   ├── MigrateInstallCommand.php
    │   │   ├── MigrateRefreshCommand.php
    │   │   ├── MigrateResetCommand.php
    │   │   ├── MigrateRollbackCommand.php
    │   │   ├── MigrateStatusCommand.php
    │   │   ├── ShowMenu.php
    │   │   └── ShowModules.php
    ├── Contracts
    │   ├── Api
    │   │   ├── ApiCoreInterface.php
    │   │   └── Response
    │   │   │   ├── ResponseBuilderInterface.php
    │   │   │   └── TransformContainerInterface.php
    │   ├── Auth
    │   │   ├── AclRepositoryInterface.php
    │   │   ├── AuthApiRoutingInterface.php
    │   │   ├── AuthRepositoryInterface.php
    │   │   ├── AuthRoutingInterface.php
    │   │   ├── AuthenticatorInterface.php
    │   │   ├── RoleInterface.php
    │   │   ├── UserAuthenticationInterface.php
    │   │   ├── UserInterface.php
    │   │   └── UserManagementInterface.php
    │   ├── Core
    │   │   ├── BootCheckerInterface.php
    │   │   ├── CacheInterface.php
    │   │   ├── CoreInterface.php
    │   │   └── NotifierInterface.php
    │   ├── Menu
    │   │   ├── MenuConfigInterpreterInterface.php
    │   │   ├── MenuModulesInterpreterInterface.php
    │   │   ├── MenuPermissionsFilterInterface.php
    │   │   └── MenuRepositoryInterface.php
    │   ├── Modules
    │   │   ├── Data
    │   │   │   ├── AclPresenceInterface.php
    │   │   │   └── MenuPresenceInterface.php
    │   │   ├── ModuleGeneratorInterface.php
    │   │   ├── ModuleInterface.php
    │   │   └── ModuleManagerInterface.php
    │   └── Support
    │   │   ├── Data
    │   │       ├── DataClearInterface.php
    │   │       ├── MenuConfiguredModulesDataInterface.php
    │   │       ├── MenuLayoutDataInterface.php
    │   │       └── MenuPermissionsIndexDataInterface.php
    │   │   ├── Localization
    │   │       └── LocaleRepositoryInterface.php
    │   │   └── View
    │   │       └── AssetManagerInterface.php
    ├── Core
    │   ├── BasicNotifier.php
    │   ├── BootChecker.php
    │   ├── Cache.php
    │   └── Core.php
    ├── Events
    │   ├── AbstractCmsEvent.php
    │   ├── Auth
    │   │   ├── CmsRolesChanged.php
    │   │   ├── CmsUserCreated.php
    │   │   ├── CmsUserDeleted.php
    │   │   ├── CmsUserLoggedIn.php
    │   │   ├── CmsUserLoggedOut.php
    │   │   └── CmsUserPermissionsChanged.php
    │   ├── CmsHasBooted.php
    │   └── CmsHasRegistered.php
    ├── Exceptions
    │   ├── ExtendingHandler.php
    │   └── Handler.php
    ├── Facades
    │   ├── AuthenticatorFacade.php
    │   ├── CacheFacade.php
    │   └── CoreFacade.php
    ├── Http
    │   ├── Controllers
    │   │   ├── Api
    │   │   │   ├── MenuController.php
    │   │   │   ├── ModulesController.php
    │   │   │   └── VersionController.php
    │   │   ├── Controller.php
    │   │   ├── DefaultController.php
    │   │   └── LocaleController.php
    │   ├── Middleware
    │   │   ├── Api
    │   │   │   └── Authenticate.php
    │   │   ├── Authenticate.php
    │   │   ├── CheckPermission.php
    │   │   ├── InitializeMenu.php
    │   │   ├── RedirectIfAuthenticated.php
    │   │   ├── SetLocale.php
    │   │   └── VerifyCsrfToken.php
    │   ├── Requests
    │   │   ├── Request.php
    │   │   └── SetLocaleRequest.php
    │   └── ViewComposers
    │   │   └── LocaleComposer.php
    ├── Menu
    │   ├── MenuConfigInterpreter.php
    │   ├── MenuModulesInterpreter.php
    │   ├── MenuPermissionsFilter.php
    │   └── MenuRepository.php
    ├── Modules
    │   └── ModuleManager.php
    ├── Providers
    │   ├── Api
    │   │   ├── ApiRouteServiceProvider.php
    │   │   └── CmsCoreApiServiceProvider.php
    │   ├── CmsCoreServiceProvider.php
    │   ├── EventServiceProvider.php
    │   ├── LogServiceProvider.php
    │   ├── MiddlewareServiceProvider.php
    │   ├── MigrationServiceProvider.php
    │   ├── ModuleManagerServiceProvider.php
    │   ├── RouteServiceProvider.php
    │   ├── TranslationServiceProvider.php
    │   └── ViewServiceProvider.php
    └── Support
    │   ├── Data
    │       ├── AbstractDataObject.php
    │       ├── AclPresence.php
    │       ├── Menu
    │       │   ├── ConfiguredModulesData.php
    │       │   ├── LayoutData.php
    │       │   ├── LayoutGroupData.php
    │       │   └── PermissionsIndexData.php
    │       └── MenuPresence.php
    │   ├── Database
    │       └── CmsMigration.php
    │   ├── Enums
    │       ├── AclPresenceType.php
    │       ├── CmsMiddleware.php
    │       ├── Component.php
    │       ├── FlashLevel.php
    │       ├── MenuPresenceMode.php
    │       ├── MenuPresenceType.php
    │       └── NamedRoute.php
    │   ├── Exception
    │       └── TraceParser.php
    │   ├── Localization
    │       └── LocaleRepository.php
    │   ├── Logging
    │       ├── CmsCustomizeFormatter.php
    │       ├── CmsFormatterDecorator.php
    │       └── CmsLogManager.php
    │   ├── Translation
    │       └── CmsTranslator.php
    │   ├── View
    │       └── AssetManager.php
    │   └── helpers.php
└── tests
    ├── Api
        ├── MenuTest.php
        ├── ModulesTest.php
        ├── Response
        │   ├── RestResponseBuilderTest.php
        │   └── TransformContainerTest.php
        └── VersionsTest.php
    ├── ApiTestCase.php
    ├── Auth
        └── AclRepositoryTest.php
    ├── CmsBootTestCase.php
    ├── Console
        ├── CacheMenuTest.php
        ├── ClearMenuCacheTest.php
        ├── MigrateCommandTest.php
        ├── MigrateInstallCommandTest.php
        ├── MigrateRefreshCommandTest.php
        ├── MigrateResetCommandTest.php
        ├── MigrateRollbackCommandTest.php
        ├── MigrateStatusCommandTest.php
        ├── ShowMenuTest.php
        └── ShowModulesTest.php
    ├── Core
        ├── BasicNotifierTest.php
        ├── BootCheckerTest.php
        ├── CacheTest.php
        └── CoreTest.php
    ├── Helpers
        ├── Api
        │   └── TestTransformer.php
        ├── Core
        │   ├── MockApiBootChecker.php
        │   └── MockWebBootChecker.php
        ├── Exceptions
        │   ├── WithGetStatusCodeException.php
        │   └── WithStatusCodePropertyException.php
        ├── Http
        │   ├── KernelWithRemoveMiddlewareMethod.php
        │   ├── MockRequest.php
        │   └── NullMiddleware.php
        ├── Listeners
        │   └── TestEventListener.php
        ├── Modules
        │   ├── SimpleAssociatedTestModule.php
        │   ├── SimpleTestModule.php
        │   ├── SimpleTestModuleGenerator.php
        │   ├── SimpleTestModuleWithSameServiceProvider.php
        │   ├── SimpleTestModuleWithServiceProviders.php
        │   └── TestModuleWithRoutes.php
        ├── NonInstantiableClassWithDependency.php
        ├── NonInstantiableInterface.php
        ├── Providers
        │   └── TestViewsServiceProvider.php
        ├── Spies
        │   ├── CacheSpy.php
        │   └── SessionSpy.php
        ├── Support
        │   ├── AnotherTestDataObject.php
        │   ├── BasicDataObject.php
        │   └── TestDataObject.php
        ├── migrations
        │   ├── DatabaseSeeder.php
        │   ├── alt
        │   │   └── 2017_01_01_300000_create_test_alternative_records_table.php
        │   └── cms
        │   │   ├── 2017_01_01_100000_create_test_records_table.php
        │   │   └── 2017_01_01_200000_create_more_test_records_table.php
        └── resources
        │   └── views
        │       ├── blade_cms_script.blade.php
        │       ├── blade_cms_scriptasset.blade.php
        │       ├── blade_cms_scriptassethead.blade.php
        │       ├── blade_cms_scriptonce.blade.php
        │       └── blade_cms_style.blade.php
    ├── Http
        ├── Controllers
        │   ├── DefaultControllerTest.php
        │   └── LocaleControllerTest.php
        ├── Middleware
        │   ├── Api
        │   │   └── AuthenticateTest.php
        │   ├── AuthenticateTest.php
        │   ├── CheckPermissionTest.php
        │   ├── InitializeMenuTest.php
        │   ├── RedirectIfAuthenticatedTest.php
        │   └── SetLocaleTest.php
        └── ViewComposers
        │   └── LocaleComposerTest.php
    ├── Menu
        ├── MenuConfigInterpreterTest.php
        ├── MenuModulesInterpreterTest.php
        ├── MenuPermissionsFilterTest.php
        └── MenuRepositoryTest.php
    ├── Modules
        └── ModuleManagerTest.php
    ├── Providers
        ├── Api
        │   └── CmsCoreApiServiceProviderTest.php
        ├── BladeDirectivesTest.php
        ├── EventServiceProviderTest.php
        ├── MiddlewareServiceProviderTest.php
        ├── RouteServiceProviderTest.php
        └── TranslationServiceProviderTest.php
    ├── SimpleDbTestCase.php
    ├── Support
        ├── Data
        │   ├── AclPresenceTest.php
        │   ├── DataObjectTest.php
        │   ├── Menu
        │   │   ├── LayoutDataTest.php
        │   │   ├── LayoutGroupDataTest.php
        │   │   └── PermissionIndexDataTest.php
        │   └── MenuPresenceTest.php
        ├── HelpersTest.php
        ├── Localization
        │   └── LocaleRepositoryTest.php
        ├── Logging
        │   └── CmsFormatterDecoratorTest.php
        ├── Translation
        │   └── CmsTranslatorTest.php
        └── View
        │   └── AssetManagerTest.php
    ├── TestCase.php
    └── WebTestCase.php


/.coveralls.yml:
--------------------------------------------------------------------------------
1 | coverage_clover: build/logs/clover.xml
2 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | ; This file is for unifying the coding style for different editors and IDEs.
 2 | ; More information at http://editorconfig.org
 3 | 
 4 | root = true
 5 | 
 6 | [*]
 7 | charset = utf-8
 8 | indent_size = 4
 9 | indent_style = space
10 | end_of_line = lf
11 | insert_final_newline = true
12 | trim_trailing_whitespace = true
13 | 
14 | [*.md]
15 | trim_trailing_whitespace = true
16 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | composer.lock
3 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | 
 3 | php:
 4 |   - 7.2
 5 |   - 7.3
 6 | 
 7 | install: composer install
 8 | 
 9 | script:
10 |   - mkdir -p build/logs
11 |   - vendor/bin/phpunit --coverage-clover build/logs/clover.xml
12 | 
13 | after_script:
14 |   - vendor/bin/coveralls -v
15 | 
16 | notifications:
17 |   email:
18 |     on_success: never
19 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | ## Laravel 6.0 and up
 4 | 
 5 | ### [3.0.0] - 2020-05-14
 6 | 
 7 | Support for Laravel 7.0 (only).
 8 | 
 9 | ### [2.0.0] - 2019-09-22
10 | 
11 | Support for Laravel 6.0 and PHP 7.2+ only.
12 | Added strict return types and scalar typehints.
13 | 
14 | ## Laravel 5.8 and below
15 | 
16 | [3.0.0]: https://github.com/czim/laravel-cms-core/compare/2.0.0...3.0.0
17 | 
18 | [2.0.0]: https://github.com/czim/laravel-cms-core/compare/1.8.0...2.0.0
19 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | Contributions are **welcome** and will be fully **credited**.
 4 | 
 5 | We accept contributions via Pull Requests on [Github](https://github.com/czim/laravel-cms-core).
 6 | 
 7 | 
 8 | ## Pull Requests
 9 | 
10 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)**.
11 | 
12 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13 | 
14 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15 | 
16 | - **Create feature branches** - Don't ask us to pull from your master branch.
17 | 
18 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
19 | 
20 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
21 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | # The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2019 Coen Zimmerman <coen@pixelindustries.com>
 4 | 
 5 | > Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | > of this software and associated documentation files (the "Software"), to deal
 7 | > in the Software without restriction, including without limitation the rights
 8 | > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | > copies of the Software, and to permit persons to whom the Software is
10 | > furnished to do so, subject to the following conditions:
11 | >
12 | > The above copyright notice and this permission notice shall be included in
13 | > all copies or substantial portions of the Software.
14 | >
15 | > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | > THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "czim/laravel-cms-core",
 3 |     "description": "Laravel CMS - Core",
 4 |     "authors": [
 5 |         {
 6 |             "name": "Coen Zimmerman",
 7 |             "email": "coen@pxlwidgets.com",
 8 |             "homepage": "https://github.com/czim"
 9 |         }
10 |     ],
11 |     "keywords": [ "cms", "laravel" ],
12 |     "require": {
13 |         "php": ">=7.2",
14 |         "czim/laravel-dataobject": "~2.0",
15 |         "laravel/framework": "^7.0",
16 |         "league/fractal": ">=0.13",
17 |         "myclabs/php-enum": "^1.4"
18 |     },
19 |     "require-dev": {
20 |         "phpunit/phpunit": "^8.0|^9.0",
21 |         "mockery/mockery": "^1.0",
22 |         "orchestra/testbench": "^5.0",
23 |         "orchestra/database": "^5.0",
24 |         "php-coveralls/php-coveralls": "^2.1"
25 |     },
26 |     "autoload": {
27 |         "psr-4": {
28 |             "Czim\\CmsCore\\": "src"
29 |         },
30 |         "files": [
31 |             "src/Support/helpers.php"
32 |         ]
33 |     },
34 |     "autoload-dev": {
35 |         "psr-4": {
36 |             "Czim\\CmsCore\\Test\\": "tests"
37 |         },
38 |         "files": [
39 |             "tests/Helpers/migrations/DatabaseSeeder.php",
40 |             "tests/Helpers/migrations/cms/2017_01_01_100000_create_test_records_table.php",
41 |             "tests/Helpers/migrations/cms/2017_01_01_200000_create_more_test_records_table.php"
42 |         ]
43 |     },
44 |     "scripts": {
45 |         "test": "phpunit"
46 |     },
47 |     "minimum-stability": "dev",
48 |     "prefer-stable": true
49 | }
50 | 


--------------------------------------------------------------------------------
/config/cms-modules.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Modules
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | The CMS is set up to be modular. Custom modules may be defined here.
11 |     | This list may include FQNs for implementations of either the
12 |     | ModuleInterface or the ModuleGeneratorInterface.
13 |     |
14 |     | The order in which modules will be processed for dispay (in the menu)
15 |     | is determined by their order in the list. Any modules not present in
16 |     | this list will be drawn below/after these, in their natural order.
17 |     |
18 |     */
19 | 
20 |     'modules' => [
21 |     ],
22 | 
23 |     /*
24 |     |--------------------------------------------------------------------------
25 |     | Service Providers
26 |     |--------------------------------------------------------------------------
27 |     |
28 |     | For those loaded modules that have their own service providers, they
29 |     | may be added here. The CMS will automatically register them.
30 |     |
31 |     */
32 | 
33 |     'providers' => [
34 |     ],
35 | 
36 |     /*
37 |     |--------------------------------------------------------------------------
38 |     | Menu
39 |     |--------------------------------------------------------------------------
40 |     |
41 |     | The menu is composed of module presences, which may be configured,
42 |     | ordered, or even assigned in a specific nested, grouped layout.
43 |     |
44 |     */
45 | 
46 |     'menu' => [
47 | 
48 |         // A menu layout with groups may be defined here, along with the order in which they appear.
49 |         // Groups are represented by arrays. Menu items for modules are referenced by module key.
50 |         //
51 |         // Example:
52 |         //
53 |         //  'layout' => [
54 |         //      [
55 |         //          'label' => 'Group label for display',
56 |         //          'children' => [
57 |         //              'another.module-key',
58 |         //              'yet-another.module-key',
59 |         //          ]
60 |         //      ],
61 |         //      'some.module-key',
62 |         //  ]
63 | 
64 |         'layout' => [
65 |         ],
66 | 
67 |         // Module menu presence configuration and default order of appearance.
68 |         //
69 |         // Entries in this array may be either module keys, or key value pairs with
70 |         // further configuration for a module's menu presence.
71 |         //
72 |         // Note that the order of appearance defined in the layout key above overrules
73 |         // the order of the module keys below.
74 |         //
75 |         // Example:
76 |         //
77 |         //  'modules' => [
78 |         //      'first-module-key',
79 |         //      'second-module-key',
80 |         //      'third-module-key' => [
81 |         //          'label' => 'Custom Label',
82 |         //          'icon'  => 'home',
83 |         //      ],
84 |         //      'some.module-key',
85 |         //  ]
86 | 
87 |         'modules' => [
88 |         ],
89 | 
90 |     ],
91 | 
92 | ];
93 | 


--------------------------------------------------------------------------------
/documentation/Development.md:
--------------------------------------------------------------------------------
1 | # For Developers
2 | 
3 | This CMS was made to be extensible and manipulable by developers. This documentation should help you get started.
4 | 
5 | - Information about [creating custom modules](Development/CreatingModules.md) for the CMS.
6 | - Writing custom [views and scripts](Development/ViewsAndScripts.md) for modules and strategies.
7 | 


--------------------------------------------------------------------------------
/documentation/Development/CreatingModules.md:
--------------------------------------------------------------------------------
 1 | # Creating Custom Modules
 2 | 
 3 | ## Modules
 4 | 
 5 | A single module class may be registered with the CMS.
 6 | 
 7 | 
 8 | ### Creating Modules
 9 | 
10 | 1. Create a new module class.  
11 |     This must implement `Czim\CmsCore\Contracts\Modules\ModuleInterface`.  
12 |     It is advisable to set a key that is unlikely to cause conflicts with other modules or generators.
13 |     
14 | 2. Create service providers as needed.  
15 |     This is not required, but is highly recommended if your module requires provision that is not needed for non-CMS requests.
16 | 
17 | ### Installing Modules
18 | 
19 | 3. Register the module in the `cms-modules.php` config.  
20 |     Add the fully qualified namespace for the module class to the `cms-modules.modules` array.
21 |     
22 | 4. If relevant, add service providers to the `cms-modules.php` config.  
23 |     Add the fully qualified namespaces for any service providers to the `cms-modules.providers` array.
24 | 
25 | 
26 | ## Module Generators
27 | 
28 | Instead of coding concrete module classes, it is possible to register a module generator with the CMS.
29 | This may generate any number of modules procedurally, which will then each be registered with the CMS.
30 | 
31 | For an example of a module generator, see the [models module generator](https://github.com/czim/laravel-cms-models/blob/master/src/Modules/ModelModuleGenerator.php).
32 | 
33 | ### Creating Module Generators
34 | 
35 | 1. Create a new module generator class.  
36 |     This must implement `Czim\CmsCore\Contracts\Modules\ModuleGeneratorInterface`.  
37 |     It is advisable to set a key that is unlikely to cause conflicts with other modules or generators.
38 | 
39 | 2. Create service providers as needed.  
40 |     This is not required, but is highly recommended if your module requires provision that is not needed for non-CMS requests.
41 | 
42 | ### Installing Module Generators
43 | 
44 | The proces is the same as for installing modules as described above.
45 | The only difference is that the generator FQN is registered in `cms-modules.modules` instead of a module class.
46 | 
47 | 
48 | ## A Warning About Using `associatedClass`
49 | 
50 | If you're using the [models module](https://github.com/czim/laravel-cms-models), 
51 | avoid setting the `associatedClass` module property to an Eloquent model.
52 | This package relies on looking up (generated) modules by their Eloquent model classname.
53 | As long as there are duplicates, you should be fine. 
54 | 


--------------------------------------------------------------------------------
/documentation/Development/ViewsAndScripts.md:
--------------------------------------------------------------------------------
 1 | # Writing Views and Scripts
 2 | 
 3 | The CMS theme includes most scripts and shared stylesheets. Modules that provide their own styles must publish them, preferrably to a subdirectory of the `public/_cms` directory.
 4 | 
 5 | The blade directives described below may be used to include style and script assets.
 6 | 
 7 | 
 8 | ## Blade Directives
 9 | 
10 | The following blade directives are available in CMS templates:
11 | 
12 | - `@cms_script` / `@cms_endscript`  
13 |     A block directive that will add content at the end of the HTML page. Does not auto-wrap in `<script>` tags, so don't forget to add those.
14 |     
15 | - `@cms_scriptonce` / `@cms_endscriptonce`  
16 |     Like `cms_script` except the content will only be added once. If the exact same content is added more times, it will only be included once.
17 |  
18 | - `@cms_scriptasset($path)`  
19 |     Adds a single `<script>` to the end of the HTML body. 
20 | 
21 | - `@cms_scriptassethead($path)`  
22 |     Like `@cms_scriptasset`, but adds to the HTML `<head>` block instead. 
23 |  
24 | - `@cms_style($path, $type = null, $media = null, $rel = 'stylesheet')`  
25 |     Adds a style `<link>` include to the HTML `<head>`.
26 | 
27 | 
28 | ## View Template
29 | 
30 | Any view may be used by (custom) CMS modules. To ensure that the view will be displayed correctly, use the following template blade code for reference:
31 | 
32 | ```blade
33 | @extends(cms_config('views.layout'))
34 | 
35 | @section('title', 'Your page title here')
36 | 
37 | @section('breadcrumbs')
38 |     <ol class="breadcrumb">
39 |         <li><a href="{{ cms_route(\Czim\CmsCore\Support\Enums\NamedRoute::HOME) }}">
40 |                 {{ ucfirst(cms_trans('common.home')) }}
41 |             </a>
42 |         </li>
43 |         <li class="active">
44 |             Your breadcrumb
45 |         </li>
46 |     </ol>
47 | @endsection
48 | 
49 | @section('content')
50 | 
51 |     <div class="page-header">
52 |         <h1>
53 |             Your page title
54 |         </h1>
55 |     </div>
56 |     
57 | @endsection
58 | ```
59 | 


--------------------------------------------------------------------------------
/documentation/Modules.md:
--------------------------------------------------------------------------------
 1 | # CMS Modules and Components
 2 | 
 3 | This is a listing of all known publically available components and modules for this CMS.
 4 | 
 5 | If you have created or know about a package that should be listed here, I'd appreciate getting a heads-up, or even a pull request to add it to this page.
 6 | 
 7 | 
 8 | ## Components
 9 | 
10 | Components, unlike modules, are required for the CMS to work. 
11 | These are necessary but interchangeable add-ons to the core.
12 |  
13 | The main reason these are split off as separate packages, is to make it easier to replace or extend them with custom versions.
14 | 
15 | - [Authentication component](https://github.com/czim/laravel-cms-auth)  
16 |     Authentication, user and permission support for web and API access.
17 | 
18 | - [Theme component](https://github.com/czim/laravel-cms-theme)  
19 |     The look and feel of the CMS, as well as javascripts and general assets.
20 | 
21 | 
22 | ## Available modules
23 | 
24 | Modules are optional and may be added to the CMS as needed.
25 | 
26 | 
27 | - The default [ACL Module](https://github.com/czim/laravel-cms-acl-module)  
28 |     A very simple user, role & permission management module.
29 | 
30 | - The default [Models Module](https://github.com/czim/laravel-cms-models)  
31 |     Allows extensive management of Eloquent model data.  
32 |     For simple applications, this may be all you need for a complete CMS. 
33 | 
34 | Modules may require special configuration and setup, and have their own dependencies.
35 | Please check each module's documentation for further information.
36 | 
37 | 
38 | ### Making Custom Modules
39 | 
40 | The above list is not exhaustive, if only because making custom modules is encouraged.
41 | 
42 | For more information, see [creating custom modules](Development/CreatingModules.md).
43 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit backupGlobals="false"
 3 |          backupStaticAttributes="false"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 |          convertErrorsToExceptions="true"
 7 |          convertNoticesToExceptions="true"
 8 |          convertWarningsToExceptions="true"
 9 |          processIsolation="false"
10 |          stopOnFailure="false">
11 | 
12 |     <testsuites>
13 |         <testsuite name="CMS Core Package Test Suite">
14 |             <directory suffix=".php">./tests/</directory>
15 |             <exclude>./tests/Helpers</exclude>
16 |         </testsuite>
17 |     </testsuites>
18 | 
19 |     <filter>
20 |         <whitelist processUncoveredFilesFromWhitelist="true">
21 |             <directory suffix=".php">./src/</directory>
22 |             <exclude>
23 |                 <directory suffix=".php">./src/Events/</directory>
24 |                 <directory suffix=".php">./src/Facades/</directory>
25 |                 <directory suffix=".php">./src/Http/Requests</directory>
26 |                 <directory suffix=".php">./src/Exceptions</directory>
27 |                 <directory suffix=".php">./src/Support/Exception</directory>
28 |             </exclude>
29 |         </whitelist>
30 |     </filter>
31 | 
32 |     <php>
33 |         <env name="APP_ENV" value="testing"/>
34 |         <env name="APP_KEY" value="r5oGyLQMNyJ3xkJsV97KtK8u7DggzaAq"/>
35 |         <env name="CACHE_DRIVER" value="array"/>
36 |         <env name="SESSION_DRIVER" value="array"/>
37 |         <env name="QUEUE_DRIVER" value="sync"/>
38 |     </php>
39 | </phpunit>
40 | 
41 | 


--------------------------------------------------------------------------------
/src/Api/ApiCore.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Api;
 3 | 
 4 | use Czim\CmsCore\Contracts\Api\ApiCoreInterface;
 5 | use Czim\CmsCore\Contracts\Api\Response\ResponseBuilderInterface;
 6 | 
 7 | class ApiCore implements ApiCoreInterface
 8 | {
 9 | 
10 |     /**
11 |      * @var ResponseBuilderInterface
12 |      */
13 |     protected $builder;
14 | 
15 |     /**
16 |      * @param ResponseBuilderInterface $builder
17 |      */
18 |     public function __construct(ResponseBuilderInterface $builder)
19 |     {
20 |         $this->builder = $builder;
21 |     }
22 | 
23 | 
24 |     /**
25 |      * Returns API-formatted response based on given content.
26 |      *
27 |      * @param mixed $content
28 |      * @param int   $statusCode
29 |      * @return mixed
30 |      */
31 |     public function response($content, int $statusCode = 200)
32 |     {
33 |         return $this->builder->response($content, $statusCode);
34 |     }
35 | 
36 |     /**
37 |      * Returns API-formatted error response.
38 |      *
39 |      * @param mixed $content
40 |      * @param int   $statusCode
41 |      * @return mixed
42 |      */
43 |     public function error($content, int $statusCode = 500)
44 |     {
45 |         return $this->builder->error($content, $statusCode);
46 |     }
47 | 
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Api/Response/TransformContainer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Api\Response;
 3 | 
 4 | use Czim\CmsCore\Contracts\Api\Response\TransformContainerInterface;
 5 | use Czim\DataObject\AbstractDataObject;
 6 | use Illuminate\Support\Collection;
 7 | use League\Fractal\TransformerAbstract;
 8 | 
 9 | /**
10 |  * Class TransformContainer
11 |  *
12 |  * Container for serializable, transformable content, to be handled by a response builder.
13 |  *
14 |  * @property mixed                      $content
15 |  * @property string|TransformerAbstract $transformer
16 |  * @property bool                       $collection
17 |  */
18 | class TransformContainer extends AbstractDataObject implements TransformContainerInterface
19 | {
20 |     protected $attributes = [
21 |         'content'     => null,
22 |         'transformer' => null,
23 |         'collection'  => null,
24 |     ];
25 | 
26 |     /**
27 |      * Returns transformable content
28 |      *
29 |      * @return mixed
30 |      */
31 |     public function getContent()
32 |     {
33 |         return $this->getAttribute('content');
34 |     }
35 | 
36 |     /**
37 |      * The transformer instance, or an FQN for the transformer to instantiate.
38 |      *
39 |      * @return string|TransformerAbstract
40 |      */
41 |     public function getTransformer()
42 |     {
43 |         return $this->getAttribute('transformer');
44 |     }
45 | 
46 |     /**
47 |      * Returns whether the content is a collection of transformables.
48 |      *
49 |      * @return bool
50 |      */
51 |     public function isCollection(): bool
52 |     {
53 |         // If collection is not explicitly set, assume standard Laravel use,
54 |         // where either collections or models are passed in as content.
55 | 
56 |         if (null === $this->getAttribute('collection')) {
57 |             return $this->getContent() instanceof Collection;
58 |         }
59 | 
60 |         return $this->getAttribute('collection');
61 |     }
62 | }
63 | 


--------------------------------------------------------------------------------
/src/Api/Transformers/ModuleTransformer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Api\Transformers;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
 5 | use League\Fractal\TransformerAbstract;
 6 | 
 7 | class ModuleTransformer extends TransformerAbstract
 8 | {
 9 | 
10 |     /**
11 |      * @param ModuleInterface $module
12 |      * @return array
13 |      */
14 |     public function transform(ModuleInterface $module): array
15 |     {
16 |         return [
17 |             'key'         => $module->getKey(),
18 |             'name'        => $module->getName(),
19 |             'version'     => $module->getVersion(),
20 |             'class'       => $module->getAssociatedClass(),
21 |             'links'       => [
22 |                 [
23 |                     'rel' => 'self',
24 |                     'uri' => cms()->apiRoute('modules.show', [ $module->getKey() ]),
25 |                 ],
26 |             ],
27 |         ];
28 |     }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Api/Transformers/VersionTransformer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Api\Transformers;
 3 | 
 4 | use League\Fractal\TransformerAbstract;
 5 | 
 6 | class VersionTransformer extends TransformerAbstract
 7 | {
 8 | 
 9 |     /**
10 |      * @param array $version
11 |      * @return array
12 |      */
13 |     public function transform(array $version): array
14 |     {
15 |         return $version;
16 |     }
17 | 
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Console/Commands/CacheMenu.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
 5 | use Illuminate\Console\Command;
 6 | 
 7 | class CacheMenu extends Command
 8 | {
 9 | 
10 |     protected $signature = 'cms:menu:cache';
11 | 
12 |     protected $description = 'Caches menu data';
13 | 
14 | 
15 |     /**
16 |      * Execute the console command.
17 |      *
18 |      * @param MenuRepositoryInterface $repository
19 |      */
20 |     public function handle(MenuRepositoryInterface $repository): void
21 |     {
22 |         $repository
23 |             ->clearCache()
24 |             ->writeCache();
25 | 
26 |         $this->info('CMS menu cached.');
27 |     }
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Console/Commands/ClearMenuCache.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
 5 | use Illuminate\Console\Command;
 6 | 
 7 | class ClearMenuCache extends Command
 8 | {
 9 | 
10 |     protected $signature = 'cms:menu:clear';
11 | 
12 |     protected $description = 'Clears cached menu data';
13 | 
14 | 
15 |     /**
16 |      * Execute the console command.
17 |      *
18 |      * @param MenuRepositoryInterface $repository
19 |      */
20 |     public function handle(MenuRepositoryInterface $repository): void
21 |     {
22 |         $repository->clearCache();
23 | 
24 |         $this->info('CMS menu cache cleared.');
25 |     }
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Console/Commands/CmsMigrationContextTrait.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 5 | use Czim\CmsCore\Support\Enums\Component;
 6 | 
 7 | trait CmsMigrationContextTrait
 8 | {
 9 | 
10 |     /**
11 |      * Determines and returns the connection to use, if not set by --database.
12 |      *
13 |      * @return string|null
14 |      */
15 |     public function determineConnection(): ?string
16 |     {
17 |         $connection = $this->input->getOption('database');
18 | 
19 |         if ($connection) {
20 |             return $connection;
21 |         }
22 | 
23 |         $cmsConnection = $this->getCore()->config('database.driver');
24 | 
25 |         // If no separate database driver is configured for the CMS,
26 |         // we can use the normal driver and rely on the prefix alone.
27 |         if ( ! $cmsConnection) {
28 |             return $connection;
29 |         }
30 | 
31 |         // If we're running tests, make sure we use the correct override
32 |         // for the CMS database connection/driver.
33 |         // N.B. This is ignored on purpose if the default connection is not overridden normally.
34 |         if (app()->runningUnitTests()) {
35 |             $cmsConnection = $this->getCore()->config('database.testing.driver') ?: $cmsConnection;
36 |         }
37 | 
38 |         return $cmsConnection;
39 |     }
40 | 
41 |     /**
42 |      * Get the path to the migration directory.
43 |      *
44 |      * @return string
45 |      */
46 |     protected function getMigrationPath(): string
47 |     {
48 |         return app()->databasePath() . DIRECTORY_SEPARATOR
49 |              . $this->getCore()->config('database.migrations.path');
50 |     }
51 | 
52 |     /**
53 |      * Overridden to block internal migrator paths.
54 |      *
55 |      * @inheritdoc
56 |      */
57 |     protected function getMigrationPaths(): array
58 |     {
59 |         if ($this->input->hasOption('path') && $this->option('path')) {
60 |             return [app()->basePath() . '/' . $this->option('path')];
61 |         }
62 | 
63 |         // Do not use the migrator paths.
64 |         return [ $this->getMigrationPath() ];
65 |     }
66 | 
67 |     /**
68 |      * @return CoreInterface
69 |      */
70 |     protected function getCore(): CoreInterface
71 |     {
72 |         return app(Component::CORE);
73 |     }
74 | 
75 | }
76 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\MigrateCommand as LaravelMigrateCommand;
 5 | 
 6 | class MigrateCommand extends LaravelMigrateCommand
 7 | {
 8 |     use CmsMigrationContextTrait;
 9 | 
10 |     /**
11 |      * The name and signature of the console command.
12 |      *
13 |      * @var string
14 |      */
15 |     protected $signature = 'cms:migrate {--database= : The database connection to use.}
16 |                 {--force : Force the operation to run when in production.}
17 |                 {--path= : The path of migrations files to be executed.}
18 |                 {--pretend : Dump the SQL queries that would be run.}
19 |                 {--seed : Indicates if the seed task should be re-run.}
20 |                 {--step : Force the migrations to be run so they can be rolled back individually.}';
21 | 
22 |     protected $description = 'Run the database migrations for the CMS';
23 | 
24 |     /**
25 |      * Overridden to set the CMS connection, if required.
26 |      *
27 |      * {@inheritdoc}
28 |      */
29 |     protected function prepareDatabase(): void
30 |     {
31 |         $this->migrator->setConnection($this->determineConnection());
32 | 
33 |         if ( ! $this->migrator->repositoryExists()) {
34 |             $options = ['--database' => $this->input->getOption('database')];
35 | 
36 |             $this->call('cms:migrate:install', $options);
37 |         }
38 |     }
39 | 
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateInstallCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\InstallCommand;
 5 | use Illuminate\Database\Migrations\MigrationRepositoryInterface;
 6 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 7 | 
 8 | class MigrateInstallCommand extends InstallCommand
 9 | {
10 |     use CmsMigrationContextTrait;
11 | 
12 |     protected $name = 'cms:migrate:install';
13 |     protected $description = 'Create the migration repository for the CMS';
14 | 
15 |     /**
16 |      * @var CoreInterface
17 |      */
18 |     protected $core;
19 | 
20 |     /**
21 |      * Overridden to add Core reference.
22 |      *
23 |      * @param MigrationRepositoryInterface $repository
24 |      * @param CoreInterface                $core
25 |      */
26 |     public function __construct(MigrationRepositoryInterface $repository, CoreInterface $core)
27 |     {
28 |         parent::__construct($repository);
29 | 
30 |         $this->core = $core;
31 |     }
32 | 
33 |     /**
34 |      * Overridden for setSource parameter connection only.
35 |      *
36 |      * @inheritdoc
37 |      */
38 |     public function handle(): void
39 |     {
40 |         $this->repository->setSource($this->determineConnection());
41 | 
42 |         $this->repository->createRepository();
43 | 
44 |         $this->info('CMS migration table created successfully.');
45 |     }
46 | 
47 | }
48 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateRefreshCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\RefreshCommand;
 5 | 
 6 | class MigrateRefreshCommand extends RefreshCommand
 7 | {
 8 |     use CmsMigrationContextTrait;
 9 | 
10 |     protected $name = 'cms:migrate:refresh';
11 |     protected $description = 'Reset and re-run all CMS migrations';
12 | 
13 |     /**
14 |      * Overridden for database option and artisan command references.
15 |      *
16 |      * {@inheritdoc}
17 |      */
18 |     public function handle(): void
19 |     {
20 |         if (! $this->confirmToProceed()) {
21 |             // @codeCoverageIgnoreStart
22 |             return;
23 |             // @codeCoverageIgnoreEnd
24 |         }
25 | 
26 |         $database = $this->determineConnection();
27 | 
28 |         $force = $this->input->getOption('force');
29 | 
30 |         $path = $this->input->getOption('path');
31 | 
32 |         $this->call('cms:migrate:reset', [
33 |             '--database' => $database, '--force' => $force,
34 |         ]);
35 | 
36 |         // The refresh command is essentially just a brief aggregate of a few other of
37 |         // the migration commands and just provides a convenient wrapper to execute
38 |         // them in succession. We'll also see if we need to re-seed the database.
39 |         $this->call('cms:migrate', [
40 |             '--database' => $database,
41 |             '--force' => $force,
42 |             '--path' => $path,
43 |         ]);
44 | 
45 |         if ($this->needsSeeding()) {
46 |             $this->runSeeder($database);
47 |         }
48 |     }
49 | 
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateResetCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\ResetCommand;
 5 | 
 6 | class MigrateResetCommand extends ResetCommand
 7 | {
 8 |     use CmsMigrationContextTrait;
 9 | 
10 |     protected $name = 'cms:migrate:reset';
11 |     protected $description = 'Rollback all CMS database migrations';
12 | 
13 |     /**
14 |      * Overridden for setConnection only.
15 |      *
16 |      * {@inheritdoc}
17 |      */
18 |     public function handle(): void
19 |     {
20 |         if (! $this->confirmToProceed()) {
21 |             // @codeCoverageIgnoreStart
22 |             return;
23 |             // @codeCoverageIgnoreEnd
24 |         }
25 | 
26 |         $this->migrator->setConnection($this->determineConnection());
27 | 
28 |         if (! $this->migrator->repositoryExists()) {
29 |             $this->comment('Migration table not found.');
30 |             return;
31 |         }
32 | 
33 |         // First, we'll make sure that the migration table actually exists before we
34 |         // start trying to rollback and re-run all of the migrations. If it's not
35 |         // present we'll just bail out with an info message for the developers.
36 |         $this->migrator->setOutput($this->output)->reset(
37 |             $this->getMigrationPaths(), $this->option('pretend')
38 |         );
39 |     }
40 | 
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateRollbackCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\RollbackCommand as LaravelMigrateRollbackCommand;
 5 | 
 6 | class MigrateRollbackCommand extends LaravelMigrateRollbackCommand
 7 | {
 8 |     use CmsMigrationContextTrait;
 9 | 
10 |     protected $name = 'cms:migrate:rollback';
11 |     protected $description = 'Rollback the last CMS database migration';
12 | 
13 |     /**
14 |      * Overridden for setConnection only.
15 |      *
16 |      * {@inheritdoc}
17 |      */
18 |     public function handle(): void
19 |     {
20 |         if (! $this->confirmToProceed()) {
21 |             // @codeCoverageIgnoreStart
22 |             return;
23 |             // @codeCoverageIgnoreEnd
24 |         }
25 | 
26 |         $this->migrator->setConnection($this->determineConnection());
27 | 
28 |         $this->migrator->setOutput($this->output)->rollback(
29 |             $this->getMigrationPaths(), [
30 |                 'pretend' => $this->option('pretend'),
31 |                 'step' => (int) $this->option('step'),
32 |             ]
33 |         );
34 |     }
35 | 
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MigrateStatusCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Illuminate\Database\Console\Migrations\StatusCommand;
 5 | use Illuminate\Support\Collection;
 6 | 
 7 | class MigrateStatusCommand extends StatusCommand
 8 | {
 9 |     use CmsMigrationContextTrait;
10 | 
11 |     protected $name = 'cms:migrate:status';
12 |     protected $description = 'Show the status of each migration for the CMS';
13 | 
14 |     /**
15 |      * Overridden only to set connection with determineConnection().
16 |      *
17 |      * {@inheritdoc}
18 |      */
19 |     public function handle(): void
20 |     {
21 |         // Set the connection before checking whether the table on it
22 |         // exists! Otherwise, how could the table be found in the correct place?
23 |         $this->migrator->setConnection($this->determineConnection());
24 | 
25 |         if ( ! $this->migrator->repositoryExists()) {
26 |             $this->error('No migrations found.');
27 |             return;
28 |         }
29 | 
30 |         $this->migrator->setConnection($this->option('database'));
31 | 
32 |         $ran = $this->migrator->getRepository()->getRan();
33 | 
34 |         $migrations = Collection::make($this->getAllMigrationFiles())
35 |             ->map(function ($migration) use ($ran) {
36 |                 return in_array($this->migrator->getMigrationName($migration), $ran, true)
37 |                     ? ['<info>Y</info>', $this->migrator->getMigrationName($migration)]
38 |                     : ['<fg=red>N</fg=red>', $this->migrator->getMigrationName($migration)];
39 |             });
40 | 
41 |         if (count($migrations) > 0) {
42 |             $this->table(['Ran?', 'CMS Migration'], $migrations);
43 |         } else {
44 |             $this->error('No CMS migrations found');
45 |         }
46 |     }
47 | 
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Console/Commands/ShowMenu.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Console\Commands;
  3 | 
  4 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Illuminate\Console\Command;
  7 | 
  8 | class ShowMenu extends Command
  9 | {
 10 | 
 11 |     protected $signature = 'cms:menu:show 
 12 |         {--locale= : Show translation information for given locale}';
 13 | 
 14 |     protected $description = 'Show menu information';
 15 | 
 16 | 
 17 |     /**
 18 |      * Execute the console command.
 19 |      *
 20 |      * @param MenuRepositoryInterface $repository
 21 |      */
 22 |     public function handle(MenuRepositoryInterface $repository): void
 23 |     {
 24 |         $this->setLocale();
 25 | 
 26 |         $repository->ignorePermission()->initialize();
 27 | 
 28 |         $groups = $repository->getMenuLayout();
 29 | 
 30 |         if (count($groups)) {
 31 | 
 32 |             $this->comment('Menu layout:');
 33 |             $this->info('');
 34 | 
 35 |             foreach ($groups as $group) {
 36 | 
 37 |                 $this->displaySingle($group, 1);
 38 |             }
 39 |         }
 40 |     }
 41 | 
 42 |     /**
 43 |      * Sets locale if option is set.
 44 |      */
 45 |     protected function setLocale(): void
 46 |     {
 47 |         if ( ! ($locale = $this->option('locale'))) {
 48 |             return;
 49 |         }
 50 | 
 51 |         app()->setLocale($locale);
 52 |     }
 53 | 
 54 |     /**
 55 |      * @param MenuPresenceInterface $presence
 56 |      * @param int                   $depth
 57 |      */
 58 |     protected function displaySingle(MenuPresenceInterface $presence, int $depth = 0): void
 59 |     {
 60 |         $indent = str_repeat(' ', $depth * 2);
 61 | 
 62 |         $this->comment($indent . ucfirst($presence->type()));
 63 | 
 64 |         if ($presence->label()) {
 65 |             $this->info($indent . 'Label       : ' . $presence->label());
 66 |         }
 67 | 
 68 |         if ($presence->translationKey()) {
 69 | 
 70 |             // Add a flag for currently undefined translation keys
 71 |             $isTranslated = $presence->label() !== $presence->label(false);
 72 | 
 73 |             $this->info(
 74 |                 $indent . 'Transl. key : ' . $presence->translationKey()
 75 |                 . ($isTranslated ? null : ' (' .  app()->getLocale() . ' unset)')
 76 |             );
 77 |         }
 78 | 
 79 |         if ($presence->action()) {
 80 |             $this->info($indent . 'Action      : ' . $presence->action());
 81 |         }
 82 | 
 83 |         if (count($presence->permissions())) {
 84 |             $this->info($indent . 'Permissions : ' . implode(', ', $presence->permissions()));
 85 |         }
 86 | 
 87 |         $children = $presence->children();
 88 | 
 89 |         if (count($children)) {
 90 | 
 91 |             $this->info($indent . 'Children :');
 92 |             $this->info('');
 93 | 
 94 |             foreach ($children as $key => $child) {
 95 | 
 96 |                 $this->displaySingle($child, $depth + 1);
 97 |             }
 98 |         }
 99 | 
100 |         $this->info('');
101 |     }
102 | 
103 | }
104 | 


--------------------------------------------------------------------------------
/src/Console/Commands/ShowModules.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Console\Commands;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
 5 | use Czim\CmsCore\Contracts\Modules\ModuleManagerInterface;
 6 | use Illuminate\Console\Command;
 7 | use Illuminate\Support\Collection;
 8 | 
 9 | class ShowModules extends Command
10 | {
11 | 
12 |     protected $signature = 'cms:modules:show {module? : Module key to show for a specific module}
13 |                                 {--keys : Shows only the module keys}';
14 | 
15 |     protected $description = 'Show module information';
16 | 
17 | 
18 |     /**
19 |      * Execute the console command.
20 |      *
21 |      * @param ModuleManagerInterface $manager
22 |      */
23 |     public function handle(ModuleManagerInterface $manager): void
24 |     {
25 |         $key      = $this->argument('module');
26 |         $onlyKeys = $this->option('keys');
27 | 
28 |         if ( ! $key) {
29 |             // Show all modules
30 |             if ($onlyKeys) {
31 |                 $this->displayKeys($manager->getModules());
32 |             } else {
33 |                 $this->displayList($manager->getModules());
34 |             }
35 |             return;
36 |         }
37 | 
38 |         // Try by key
39 |         $module = $manager->get($key);
40 | 
41 |         if ($module) {
42 |             $this->displaySingle($module);
43 |             return;
44 |         }
45 | 
46 |         $this->error("Unable to find information for module by key '{$key}'");
47 |     }
48 | 
49 |     /**
50 |      * @param Collection|ModuleInterface[] $modules
51 |      */
52 |     protected function displayKeys(Collection $modules): void
53 |     {
54 |         foreach ($modules as $module) {
55 |             $this->comment($module->getKey());
56 |         }
57 |     }
58 | 
59 |     /**
60 |      * @param Collection|ModuleInterface[] $modules
61 |      */
62 |     protected function displayList(Collection $modules): void
63 |     {
64 |         foreach ($modules as $module) {
65 |             $this->displaySingle($module);
66 |         }
67 |     }
68 | 
69 |     /**
70 |      * @param ModuleInterface $module
71 |      */
72 |     protected function displaySingle(ModuleInterface $module): void
73 |     {
74 |         $this->comment($module->getKey());
75 |         $this->infoIndent('Name             : ' . $module->getName());
76 |         $this->infoIndent('Version          : ' . $module->getVersion());
77 | 
78 |         if ($module->getAssociatedClass()) {
79 |             $this->infoIndent('Associated Class : ' . $module->getAssociatedClass());
80 |         }
81 | 
82 |         $this->info('');
83 |     }
84 | 
85 |     /**
86 |      * @param string $info
87 |      * @param int    $indents
88 |      */
89 |     protected function infoIndent(string $info, int $indents = 1): void
90 |     {
91 |         $this->info(str_repeat(' ', $indents * 4) . $info);
92 |     }
93 | 
94 | }
95 | 


--------------------------------------------------------------------------------
/src/Contracts/Api/ApiCoreInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Contracts\Api;
3 | 
4 | use Czim\CmsCore\Contracts\Api\Response\ResponseBuilderInterface;
5 | 
6 | interface ApiCoreInterface extends ResponseBuilderInterface
7 | {
8 | }
9 | 


--------------------------------------------------------------------------------
/src/Contracts/Api/Response/ResponseBuilderInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Api\Response;
 3 | 
 4 | interface ResponseBuilderInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns API-formatted response based on given content.
 9 |      *
10 |      * @param mixed $content
11 |      * @param int   $statusCode
12 |      * @return mixed
13 |      */
14 |     public function response($content, int $statusCode = 200);
15 | 
16 |     /**
17 |      * Returns API-formatted error response.
18 |      *
19 |      * @param mixed $content
20 |      * @param int   $statusCode
21 |      * @return mixed
22 |      */
23 |     public function error($content, int $statusCode = 500);
24 | 
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Contracts/Api/Response/TransformContainerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Api\Response;
 3 | 
 4 | use Czim\DataObject\Contracts\DataObjectInterface;
 5 | use League\Fractal\TransformerAbstract;
 6 | 
 7 | interface TransformContainerInterface extends DataObjectInterface
 8 | {
 9 | 
10 |     /**
11 |      * Returns transformable content
12 |      *
13 |      * @return mixed
14 |      */
15 |     public function getContent();
16 | 
17 |     /**
18 |      * The transformer instance, or an FQN for the transformer to instantiate.
19 |      *
20 |      * @return string|TransformerAbstract
21 |      */
22 |     public function getTransformer();
23 | 
24 |     /**
25 |      * Returns whether the content is a collection of transformables.
26 |      *
27 |      * @return bool
28 |      */
29 |     public function isCollection(): bool;
30 | 
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/AclRepositoryInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
 5 | use Illuminate\Support\Collection;
 6 | 
 7 | interface AclRepositoryInterface
 8 | {
 9 | 
10 |     /**
11 |      * Parses available ACL presence data, so it may be retrieved.
12 |      */
13 |     public function initialize(): void;
14 | 
15 |     /**
16 |      * Retrieves all ACL presences.
17 |      *
18 |      * @return Collection|AclPresenceInterface[]
19 |      */
20 |     public function getAclPresences(): Collection;
21 | 
22 |     /**
23 |      * Retrieves all ACL presences for a module key.
24 |      *
25 |      * @param string $key
26 |      * @return Collection|AclPresenceInterface[]
27 |      */
28 |     public function getAclPresencesByModule(string $key): ?Collection;
29 | 
30 |     /**
31 |      * Retrieves a flat list of all permissions.
32 |      *
33 |      * @return string[]
34 |      */
35 |     public function getAllPermissions(): array;
36 | 
37 |     /**
38 |      * Retrieves a flat list of all permissions for a module.
39 |      *
40 |      * @param string $key
41 |      * @return string[]
42 |      */
43 |     public function getModulePermissions(string $key): array;
44 | 
45 | }
46 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/AuthApiRoutingInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface AuthApiRoutingInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns router action for the CMS API authentication.
 9 |      *
10 |      * @return string|array
11 |      */
12 |     public function getApiRouteLoginAction();
13 | 
14 |     /**
15 |      * Returns router action for logging out of the CMS for the API.
16 |      *
17 |      * @return string|array
18 |      */
19 |     public function getApiRouteLogoutAction();
20 | 
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/AuthRepositoryInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Contracts\Auth;
  3 | 
  4 | use Illuminate\Support\Collection;
  5 | 
  6 | interface AuthRepositoryInterface
  7 | {
  8 | 
  9 |     /**
 10 |      * Returns a user by their ID, if it exists.
 11 |      *
 12 |      * @param mixed $id
 13 |      * @return UserInterface|null
 14 |      */
 15 |     public function getUserById($id): ?UserInterface;
 16 | 
 17 |     /**
 18 |      * Returns a user by their username/email, if it exists.
 19 |      *
 20 |      * @param string $username
 21 |      * @return UserInterface|null
 22 |      */
 23 |     public function getUserByUserName(string $username): ?UserInterface;
 24 | 
 25 |     /**
 26 |      * Returns all CMS users.
 27 |      *
 28 |      * @param bool $withAdmin   include superadmins
 29 |      * @return Collection|UserInterface[]
 30 |      */
 31 |     public function getAllUsers(bool $withAdmin = false): Collection;
 32 | 
 33 |     /**
 34 |      * Returns all CMS users with the given role.
 35 |      *
 36 |      * @param string $role
 37 |      * @param bool $withAdmin   include superadmins
 38 |      * @return Collection|UserInterface[]
 39 |      */
 40 |     public function getUsersForRole(string $role, bool $withAdmin = false): Collection;
 41 | 
 42 |     /**
 43 |      * Returns whether a given role exists.
 44 |      *
 45 |      * @param string $role
 46 |      * @return bool
 47 |      */
 48 |     public function roleExists(string $role): bool;
 49 | 
 50 |     /**
 51 |      * @param string $role
 52 |      * @return RoleInterface
 53 |      */
 54 |     public function getRole(string $role): RoleInterface;
 55 | 
 56 |     /**
 57 |      * Returns all roles known by the authenticator.
 58 |      *
 59 |      * @return string[]
 60 |      */
 61 |     public function getAllRoles(): array;
 62 | 
 63 |     /**
 64 |      * Returns whether a role is currently used at all.
 65 |      *
 66 |      * @param string $role
 67 |      * @return bool
 68 |      */
 69 |     public function roleInUse(string $role): bool;
 70 | 
 71 |     /**
 72 |      * Returns whether a permission with the given (exact) name is currently used at all.
 73 |      *
 74 |      * @param string $permission
 75 |      * @return bool
 76 |      */
 77 |     public function permissionInUse(string $permission): bool;
 78 | 
 79 |     /**
 80 |      * Returns all permissions known by the authenticator.
 81 |      *
 82 |      * @return string[]
 83 |      */
 84 |     public function getAllPermissions(): array;
 85 | 
 86 |     /**
 87 |      * Returns all permission keys for a given role.
 88 |      *
 89 |      * @param string $role
 90 |      * @return string[]
 91 |      */
 92 |     public function getAllPermissionsForRole(string $role): array;
 93 | 
 94 |     /**
 95 |      * Returns all permission keys for a given user.
 96 |      *
 97 |      * @param string|UserInterface $user    user: name or instance
 98 |      * @return string[]
 99 |      */
100 |     public function getAllPermissionsForUser($user): array;
101 | 
102 | }
103 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/AuthRoutingInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface AuthRoutingInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns router action for the CMS login form.
 9 |      *
10 |      * @return string|array
11 |      */
12 |     public function getRouteLoginAction();
13 | 
14 |     /**
15 |      * Returns router action for the CMS login, posting login credentials.
16 |      *
17 |      * @return string|array
18 |      */
19 |     public function getRouteLoginPostAction();
20 | 
21 |     /**
22 |      * Returns router action for logging out of the CMS.
23 |      *
24 |      * @return string|array
25 |      */
26 |     public function getRouteLogoutAction();
27 | 
28 |     /**
29 |      * Returns router action for password email request form.
30 |      *
31 |      * @return string|array
32 |      */
33 |     public function getRoutePasswordEmailGetAction();
34 | 
35 |     /**
36 |      * Returns router action for posting request for password email.
37 |      *
38 |      * @return string|array
39 |      */
40 |     public function getRoutePasswordEmailPostAction();
41 | 
42 |     /**
43 |      * Returns router action for posting request for the password reset form.
44 |      *
45 |      * @return string|array
46 |      */
47 |     public function getRoutePasswordResetGetAction();
48 | 
49 |     /**
50 |      * Returns router action for posting request posting the password reset form.
51 |      *
52 |      * @return string|array
53 |      */
54 |     public function getRoutePasswordResetPostAction();
55 | 
56 | }
57 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/AuthenticatorInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface AuthenticatorInterface extends
 5 |     UserAuthenticationInterface,
 6 |     UserManagementInterface,
 7 |     AuthRepositoryInterface,
 8 |     AuthApiRoutingInterface,
 9 |     AuthRoutingInterface
10 | {
11 | 
12 |     /**
13 |      * Returns Authenticator component version number.
14 |      *
15 |      * @return string
16 |      */
17 |     public function version(): string;
18 | 
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/RoleInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface RoleInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns the key/slug for the role.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function getSlug(): string;
13 | 
14 |     /**
15 |      * Returns the display name.
16 |      *
17 |      * @return string
18 |      */
19 |     public function getName(): string;
20 | 
21 |     /**
22 |      * Returns all permissions for the role.
23 |      *
24 |      * @return string[]
25 |      */
26 |     public function getAllPermissions(): array;
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/UserAuthenticationInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface UserAuthenticationInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns whether any user is currently logged in.
 9 |      *
10 |      * @return bool
11 |      */
12 |     public function check(): bool;
13 | 
14 |     /**
15 |      * Returns currently logged in user, if any.
16 |      *
17 |      * @return UserInterface|false
18 |      */
19 |     public function user();
20 | 
21 |     /**
22 |      * Returns whether currently logged in user, if any, is (super) admin.
23 |      *
24 |      * @return bool
25 |      */
26 |     public function admin(): bool;
27 | 
28 |     /**
29 |      * @param string $username
30 |      * @param string $password
31 |      * @param bool   $remember
32 |      * @return bool
33 |      */
34 |     public function login(string $username, string $password, bool $remember = true): bool;
35 | 
36 |     /**
37 |      * Performs stateless login.
38 |      *
39 |      * @param string $username
40 |      * @param string $password
41 |      * @return bool
42 |      */
43 |     public function stateless(string $username, string $password): bool;
44 | 
45 |     /**
46 |      * Forces a user to be logged in without credentials verification.
47 |      *
48 |      * @param UserInterface $user
49 |      * @param bool          $remember
50 |      * @return bool
51 |      */
52 |     public function forceUser(UserInterface $user, bool $remember = true): bool;
53 | 
54 |     /**
55 |      * Forces a user to be logged in without credentials verification,
56 |      * without persistence, and without marking it as a login.
57 |      *
58 |      * @param UserInterface $user
59 |      * @return bool
60 |      */
61 |     public function forceUserStateless(UserInterface $user): bool;
62 | 
63 |     /**
64 |      * @return bool
65 |      */
66 |     public function logout(): bool;
67 | 
68 |     /**
69 |      * Returns whether the current user has the given role.
70 |      *
71 |      * @param string $role
72 |      * @return bool
73 |      */
74 |     public function hasRole($role): bool;
75 | 
76 |     /**
77 |      * Returns whether the current user has the given permission(s).
78 |      *
79 |      * @param string|string[] $permission
80 |      * @param bool            $allowAny     if true, allows if any is permitted
81 |      * @return bool
82 |      */
83 |     public function can($permission, bool $allowAny = false): bool;
84 | 
85 |     /**
86 |      * Returns whether the current user has any of the given permissions.
87 |      *
88 |      * @param string[] $permissions
89 |      * @return bool
90 |      */
91 |     public function canAnyOf(array $permissions): bool;
92 | 
93 | }
94 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/UserInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Auth;
 3 | 
 4 | interface UserInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns the login name of the user.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function getUsername(): string;
13 | 
14 |     /**
15 |      * Returns whether the user is a top-level admin.
16 |      *
17 |      * @return bool
18 |      */
19 |     public function isAdmin(): bool;
20 | 
21 |     /**
22 |      * Returns all roles for the user.
23 |      *
24 |      * @return string[]
25 |      */
26 |     public function getAllRoles(): array;
27 | 
28 |     /**
29 |      * Returns whether the user has the given role.
30 |      *
31 |      * @param string $role
32 |      * @return bool
33 |      */
34 |     public function hasRole(string $role): bool;
35 | 
36 |     /**
37 |      * Returns all permissions for the user, whether by role or for the user itself.
38 |      *
39 |      * @return string[]
40 |      */
41 |     public function getAllPermissions(): array;
42 | 
43 |     /**
44 |      * Returns whether the user has the given permission.
45 |      *
46 |      * @param string|string[] $permission
47 |      * @param bool            $allowAny     if true, allows if any is permitted
48 |      * @return bool
49 |      */
50 |     public function can(string $permission, bool $allowAny = false): bool;
51 | 
52 |     /**
53 |      * Returns whether the current user has any of the given permissions.
54 |      *
55 |      * @param string[] $permissions
56 |      * @return bool
57 |      */
58 |     public function canAnyOf(array $permissions): bool;
59 | 
60 | }
61 | 


--------------------------------------------------------------------------------
/src/Contracts/Core/BootCheckerInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Contracts\Core;
  3 | 
  4 | interface BootCheckerInterface
  5 | {
  6 | 
  7 |     /**
  8 |      * Returns whether the CMS should perform any service providing.
  9 |      *
 10 |      * @return bool
 11 |      */
 12 |     public function shouldCmsRegister(): bool;
 13 | 
 14 |     /**
 15 |      * Returns whether the CMS should perform service providing for the API specifically.
 16 |      *
 17 |      * @return bool
 18 |      */
 19 |     public function shouldCmsApiRegister(): bool;
 20 | 
 21 |     /**
 22 |      * Returns whether the CMS should commence booting.
 23 |      *
 24 |      * @return bool
 25 |      */
 26 |     public function shouldCmsBoot(): bool;
 27 | 
 28 |     /**
 29 |      * Marks the CMS as having fully registered.
 30 |      *
 31 |      * @param bool $registered
 32 |      */
 33 |     public function markCmsRegistered(bool $registered = true): void;
 34 | 
 35 |     /**
 36 |      * @return bool
 37 |      */
 38 |     public function isCmsRegistered(): bool;
 39 | 
 40 |     /**
 41 |      * Marks the CMS as having fully booted.
 42 |      *
 43 |      * @param bool $booted
 44 |      */
 45 |     public function markCmsBooted(bool $booted = true): void;
 46 | 
 47 |     /**
 48 |      * @return bool
 49 |      */
 50 |     public function isCmsBooted(): bool;
 51 | 
 52 |     /**
 53 |      * Returns whether the CMS middleware should be registered.
 54 |      *
 55 |      * @return bool
 56 |      */
 57 |     public function shouldLoadCmsMiddleware(): bool;
 58 | 
 59 |     /**
 60 |      * Returns whether non-API CMS middleware should be registered.
 61 |      *
 62 |      * @return bool
 63 |      */
 64 |     public function shouldLoadCmsWebMiddleware(): bool;
 65 | 
 66 |     /**
 67 |      * Returns whether API CMS middleware should be registered.
 68 |      *
 69 |      * @return bool
 70 |      */
 71 |     public function shouldLoadCmsApiMiddleware(): bool;
 72 | 
 73 |     /**
 74 |      * Returns whether non-API CMS middleware should be registered.
 75 |      *
 76 |      * @return bool
 77 |      */
 78 |     public function shouldRegisterCmsWebRoutes(): bool;
 79 | 
 80 |     /**
 81 |      * Returns whether API CMS middleware should be registered.
 82 |      *
 83 |      * @return bool
 84 |      */
 85 |     public function shouldRegisterCmsApiRoutes(): bool;
 86 | 
 87 |     /**
 88 |      * Returns whether a CMS web request is running.
 89 |      *
 90 |      * @return bool
 91 |      */
 92 |     public function isCmsWebRequest(): bool;
 93 | 
 94 |     /**
 95 |      * Returns whether a CMS API request is running.
 96 |      *
 97 |      * @return bool
 98 |      */
 99 |     public function isCmsApiRequest(): bool;
100 | 
101 | }
102 | 


--------------------------------------------------------------------------------
/src/Contracts/Core/CacheInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Contracts\Core;
  3 | 
  4 | interface CacheInterface
  5 | {
  6 | 
  7 |     /**
  8 |      * Determine if an item exists in the cache.
  9 |      *
 10 |      * @param  string  $key
 11 |      * @return bool
 12 |      */
 13 |     public function has(string $key): bool;
 14 | 
 15 |     /**
 16 |      * Retrieve an item from the cache by key.
 17 |      *
 18 |      * @param  string  $key
 19 |      * @param  mixed   $default
 20 |      * @return mixed
 21 |      */
 22 |     public function get(string $key, $default = null);
 23 | 
 24 |     /**
 25 |      * Retrieve multiple items from the cache by key.
 26 |      *
 27 |      * Items not found in the cache will have a null value.
 28 |      *
 29 |      * @param  array  $keys
 30 |      * @return array
 31 |      */
 32 |     public function many(array $keys): array;
 33 | 
 34 |     /**
 35 |      * Retrieve an item from the cache and delete it.
 36 |      *
 37 |      * @param  string  $key
 38 |      * @param  mixed   $default
 39 |      * @return mixed
 40 |      */
 41 |     public function pull(string $key, $default = null);
 42 | 
 43 |     /**
 44 |      * Store an item in the cache.
 45 |      *
 46 |      * @param  string  $key
 47 |      * @param  mixed   $value
 48 |      * @param  int     $minutes
 49 |      * @return void
 50 |      */
 51 |     public function put(string $key, $value, int $minutes = null): void;
 52 | 
 53 |     /**
 54 |      * Store multiple items in the cache for a given number of minutes.
 55 |      *
 56 |      * @param  array  $values
 57 |      * @param  int    $minutes
 58 |      * @return void
 59 |      */
 60 |     public function putMany(array $values, int $minutes): void;
 61 | 
 62 |     /**
 63 |      * Store an item in the cache if the key does not exist.
 64 |      *
 65 |      * @param  string  $key
 66 |      * @param  mixed   $value
 67 |      * @param  int     $minutes
 68 |      * @return bool
 69 |      */
 70 |     public function add(string $key, $value, int $minutes): bool;
 71 | 
 72 |     /**
 73 |      * Store an item in the cache indefinitely.
 74 |      *
 75 |      * @param  string  $key
 76 |      * @param  mixed   $value
 77 |      * @return void
 78 |      */
 79 |     public function forever(string $key, $value): void;
 80 | 
 81 |     /**
 82 |      * Get an item from the cache, or store the default value.
 83 |      *
 84 |      * @param  string    $key
 85 |      * @param  int       $minutes
 86 |      * @param  callable  $callback
 87 |      * @return mixed
 88 |      */
 89 |     public function remember(string $key, int $minutes, callable $callback);
 90 | 
 91 |     /**
 92 |      * Get an item from the cache, or store the default value forever.
 93 |      *
 94 |      * @param  string    $key
 95 |      * @param  callable  $callback
 96 |      * @return mixed
 97 |      */
 98 |     public function rememberForever(string $key, callable $callback);
 99 | 
100 |     /**
101 |      * Remove an item from the cache.
102 |      *
103 |      * @param  string $key
104 |      * @return bool
105 |      */
106 |     public function forget(string $key): bool;
107 | 
108 | }
109 | 


--------------------------------------------------------------------------------
/src/Contracts/Core/NotifierInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Core;
 3 | 
 4 | interface NotifierInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Flashes a message to the session.
 9 |      *
10 |      * @param string      $message
11 |      * @param null|string $level
12 |      * @return $this
13 |      */
14 |     public function flash(string $message, ?string $level = null): NotifierInterface;
15 | 
16 |     /**
17 |      * Returns any previously flashed messages.
18 |      *
19 |      * @param bool $clear   whether to delete the flashed messages from the session
20 |      * @return array set of associative arrays with message, level keys
21 |      */
22 |     public function getFlashed(bool $clear = true): array;
23 | 
24 | 
25 |     /**
26 |      * Adds a new notification for the current user.
27 |      *
28 |      * @param string      $message
29 |      * @param null|string $level
30 |      * @return $this
31 |      */
32 |     public function addNotification(string $message, ?string $level = null): NotifierInterface;
33 | 
34 |     /**
35 |      * Marks all unread notifications for the current user read.
36 |      *
37 |      * @return $this
38 |      */
39 |     public function markNotificationsRead(): NotifierInterface;
40 | 
41 |     /**
42 |      * Returns all unread notifications for the current user;
43 |      *
44 |      * @return array
45 |      */
46 |     public function getUnreadNotifications(): array;
47 | 
48 |     /**
49 |      * Returns all notifications set for the current user.
50 |      *
51 |      * @return array
52 |      */
53 |     public function getAllNotifications(): array;
54 | 
55 |     /**
56 |      * Returns notifications per page for the current user.
57 |      *
58 |      * @param int $page
59 |      * @param int $pageSize
60 |      * @return array
61 |      */
62 |     public function getPaginatedNotifications(int $page = 1, int $pageSize = 10): array;
63 | 
64 |     /**
65 |      * Deletes all notifications for the current user.
66 |      *
67 |      * @return $this
68 |      */
69 |     public function clearNotifications(): NotifierInterface;
70 | 
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Contracts/Menu/MenuConfigInterpreterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Support\Data\MenuLayoutDataInterface;
 5 | 
 6 | interface MenuConfigInterpreterInterface
 7 | {
 8 | 
 9 |     /**
10 |      * Interprets a configured menu layout array.
11 |      *
12 |      * @param array $layout
13 |      * @return MenuLayoutDataInterface
14 |      */
15 |     public function interpretLayout(array $layout): MenuLayoutDataInterface;
16 | 
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Contracts/Menu/MenuModulesInterpreterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Support\Data\MenuConfiguredModulesDataInterface;
 5 | 
 6 | interface MenuModulesInterpreterInterface
 7 | {
 8 | 
 9 |     /**
10 |      * Interprets configured module presences and returns a normalized data object.
11 |      *
12 |      * @return MenuConfiguredModulesDataInterface
13 |      */
14 |     public function interpret(): MenuConfiguredModulesDataInterface;
15 | 
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Contracts/Menu/MenuPermissionsFilterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Contracts\Support\Data\MenuLayoutDataInterface;
 6 | use Czim\CmsCore\Contracts\Support\Data\MenuPermissionsIndexDataInterface;
 7 | 
 8 | interface MenuPermissionsFilterInterface
 9 | {
10 | 
11 |     /**
12 |      * Builds permissions index data for a given layout.
13 |      *
14 |      * The purpose of the index is to allow for efficient presence filtering
15 |      * based on changing user permissions.
16 |      *
17 |      * @param MenuLayoutDataInterface $layout
18 |      * @return MenuPermissionsIndexDataInterface
19 |      */
20 |     public function buildPermissionsIndex(MenuLayoutDataInterface $layout): MenuPermissionsIndexDataInterface;
21 | 
22 |     /**
23 |      * Filters a given menu layout based on menu permissions.
24 |      *
25 |      * @param MenuLayoutDataInterface                $layout
26 |      * @param UserInterface|false                    $user
27 |      * @param MenuPermissionsIndexDataInterface|null $permissionsIndex
28 |      * @return MenuLayoutDataInterface
29 |      */
30 |     public function filterLayout(
31 |         MenuLayoutDataInterface $layout,
32 |         $user,
33 |         MenuPermissionsIndexDataInterface $permissionsIndex = null
34 |     ): MenuLayoutDataInterface;
35 | 
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Contracts/Menu/MenuRepositoryInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
 5 | use Illuminate\Support\Collection;
 6 | 
 7 | interface MenuRepositoryInterface
 8 | {
 9 | 
10 |     /**
11 |      * Sets whether to ignore permissions.
12 |      *
13 |      * @param bool $ignore
14 |      * @return $this
15 |      */
16 |     public function ignorePermission(bool $ignore = true): MenuRepositoryInterface;
17 | 
18 |     /**
19 |      * Parses available menu presence data, so it may be retrieved.
20 |      */
21 |     public function initialize(): void;
22 | 
23 |     /**
24 |      * @return Collection|MenuPresenceInterface[]
25 |      */
26 |     public function getMenuLayout(): Collection;
27 | 
28 |     /**
29 |      * Retrieves non-standard presences.
30 |      *
31 |      * @return Collection|MenuPresenceInterface[]
32 |      */
33 |     public function getAlternativePresences(): Collection;
34 | 
35 |     /**
36 |      * Clears cached menu data.
37 |      *
38 |      * @return $this
39 |      */
40 |     public function clearCache(): MenuRepositoryInterface;
41 | 
42 |     /**
43 |      * Writes menu data cache.
44 |      *
45 |      * @return $this
46 |      */
47 |     public function writeCache(): MenuRepositoryInterface;
48 | 
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Contracts/Modules/Data/AclPresenceInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Modules\Data;
 3 | 
 4 | use Czim\DataObject\Contracts\DataObjectInterface;
 5 | 
 6 | interface AclPresenceInterface extends DataObjectInterface
 7 | {
 8 | 
 9 |     /**
10 |      * Returns unique identifier for the ACL presence.
11 |      *
12 |      * @return string
13 |      */
14 |     public function id(): string;
15 | 
16 |     /**
17 |      * Returns type of presence.
18 |      *
19 |      * @see \Czim\CmsCore\Support\Enums\AclPresenceType
20 |      * @return string
21 |      */
22 |     public function type(): string;
23 | 
24 |     /**
25 |      * Returns available permission(s).
26 |      *
27 |      * @return string[]
28 |      */
29 |     public function permissions(): array;
30 | 
31 |     /**
32 |      * Returns (translated) label for display.
33 |      *
34 |      * @param bool $translated  returns translated label if possible
35 |      * @return string
36 |      */
37 |     public function label(bool $translated = true): string;
38 | 
39 |     /**
40 |      * Returns the translation key for the label.
41 |      *
42 |      * @return string|null
43 |      */
44 |     public function translationKey(): ?string;
45 | 
46 |     /**
47 |      * Replace the permissions entirely.
48 |      *
49 |      * @param string[] $permissions
50 |      */
51 |     public function setPermissions(array $permissions): void;
52 | 
53 |     /**
54 |      * Removes a permission from the current child permissions.
55 |      *
56 |      * @param string $permission
57 |      */
58 |     public function removePermission(string $permission): void;
59 | 
60 | }
61 | 


--------------------------------------------------------------------------------
/src/Contracts/Modules/ModuleGeneratorInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Modules;
 3 | 
 4 | use Illuminate\Support\Collection;
 5 | 
 6 | interface ModuleGeneratorInterface
 7 | {
 8 | 
 9 |     /**
10 |      * Generates and returns module instances.
11 |      *
12 |      * @return Collection|ModuleInterface[]
13 |      */
14 |     public function modules(): Collection;
15 | 
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Contracts/Modules/ModuleInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Modules;
 3 | 
 4 | use Illuminate\Routing\Router;
 5 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
 6 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
 7 | 
 8 | interface ModuleInterface
 9 | {
10 | 
11 |     /**
12 |      * Returns unique identifying key for the module.
13 |      * This should also be able to perform as a slug for it.
14 |      *
15 |      * @return string
16 |      */
17 |     public function getKey(): string;
18 | 
19 |     /**
20 |      * Returns display name for the module.
21 |      *
22 |      * @return string
23 |      */
24 |     public function getName(): string;
25 | 
26 |     /**
27 |      * Returns release or version number of module.
28 |      *
29 |      * @return string|null
30 |      */
31 |     public function getVersion(): ?string;
32 | 
33 |     /**
34 |      * Returns the FQN for a class mainly associated with this module.
35 |      *
36 |      * @return string|null
37 |      */
38 |     public function getAssociatedClass(): ?string;
39 | 
40 |     /**
41 |      * Generates web routes for the module given a contextual router instance.
42 |      * Note that the module is responsible for ACL-checks, including route-based.
43 |      *
44 |      * @param Router $router
45 |      */
46 |     public function mapWebRoutes(Router $router): void;
47 | 
48 |     /**
49 |      * Generates API routes for the module given a contextual router instance.
50 |      * Note that the module is responsible for ACL-checks, including route-based.
51 |      *
52 |      * @param Router $router
53 |      */
54 |     public function mapApiRoutes(Router $router): void;
55 | 
56 |     /**
57 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
58 |      */
59 |     public function getAclPresence();
60 | 
61 |     /**
62 |      * Returns data for CMS menu presence.
63 |      *
64 |      * @return null|array|MenuPresenceInterface|MenuPresenceInterface[]
65 |      */
66 |     public function getMenuPresence();
67 | 
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Contracts/Modules/ModuleManagerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Modules;
 3 | 
 4 | use Illuminate\Routing\Router;
 5 | use Illuminate\Support\Collection;
 6 | 
 7 | interface ModuleManagerInterface
 8 | {
 9 | 
10 |     /**
11 |      * Starts initialization, collection and registration of modules.
12 |      * This prepares the manager for further requests.
13 |      *
14 |      * @param string[]|null $modules     optional override of config: list of module FQN's
15 |      * @return $this
16 |      */
17 |     public function initialize(array $modules = null): ModuleManagerInterface;
18 | 
19 |     /**
20 |      * Returns whether the module manager was initialized.
21 |      *
22 |      * @return bool
23 |      */
24 |     public function isInitialized(): bool;
25 | 
26 |     /**
27 |      * Returns whether a module with the given key is active.
28 |      *
29 |      * @param string $key
30 |      * @return bool
31 |      */
32 |     public function has(string $key): bool;
33 | 
34 |     /**
35 |      * Returns a module by key.
36 |      *
37 |      * @param string $key
38 |      * @return ModuleInterface|false
39 |      */
40 |     public function get(string $key);
41 | 
42 |     /**
43 |      * Returns a module by its associated class. This may be an
44 |      * Eloquent model, for instance, for modules dedicated to
45 |      * editing a specific class. If multiple associations for the
46 |      * same class exist, the first ordered will be returned.
47 |      *
48 |      * @param string $modelClass    FQN of model
49 |      * @return ModuleInterface|false
50 |      */
51 |     public function getByAssociatedClass(string $modelClass);
52 | 
53 |     /**
54 |      * Returns all active modules.
55 |      *
56 |      * @return Collection|ModuleInterface[]
57 |      */
58 |     public function getModules(): Collection;
59 | 
60 |     /**
61 |      * Builds web routes for all modules given a router as context.
62 |      *
63 |      * @param Router $router
64 |      */
65 |     public function mapWebRoutes(Router $router): void;
66 | 
67 |     /**
68 |      * Builds API routes for all modules given a router as context.
69 |      *
70 |      * @param Router $router
71 |      */
72 |     public function mapApiRoutes(Router $router): void;
73 | 
74 |     /**
75 |      * Returns all permissions required by loaded modules.
76 |      *
77 |      * @return string[]
78 |      */
79 |     public function getAllPermissions(): array;
80 | 
81 |     /**
82 |      * Returns all permissions required by a single loaded module.
83 |      *
84 |      * @param string $key
85 |      * @return string[]
86 |      */
87 |     public function getModulePermissions(string $key): array;
88 | 
89 |     /**
90 |      * Returns module manager version number.
91 |      *
92 |      * @return string
93 |      */
94 |     public function version(): string;
95 | 
96 | }
97 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/Data/DataClearInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\Data;
 3 | 
 4 | interface DataClearInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Clears the attributes.
 9 |      *
10 |      * Note that this does not reset defaults, but clears them.
11 |      *
12 |      * @return $this
13 |      */
14 |     public function clear();
15 | 
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/Data/MenuConfiguredModulesDataInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\Data;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
 5 | use Czim\DataObject\Contracts\DataObjectInterface;
 6 | use Illuminate\Support\Collection;
 7 | 
 8 | interface MenuConfiguredModulesDataInterface extends DataObjectInterface
 9 | {
10 | 
11 |     /**
12 |      * Returns list of lists of presences per module key.
13 |      *
14 |      * @return Collection|MenuPresenceInterface[][]
15 |      */
16 |     public function standard(): Collection;
17 | 
18 |     /**
19 |      * Returns list of lists of presences per module key.
20 |      *
21 |      * @return Collection|MenuPresenceInterface[][]
22 |      */
23 |     public function alternative(): Collection;
24 | 
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/Data/MenuLayoutDataInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\Data;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
 5 | use Czim\DataObject\Contracts\DataObjectInterface;
 6 | 
 7 | interface MenuLayoutDataInterface extends DataObjectInterface
 8 | {
 9 | 
10 |     /**
11 |      * Returns the layout that should be used for displaying the menu form.
12 |      *
13 |      * @return MenuPresenceInterface[]
14 |      */
15 |     public function layout(): array;
16 | 
17 |     /**
18 |      * Sets the layout.
19 |      *
20 |      * @param MenuPresenceInterface[] $presences
21 |      * @return $this
22 |      */
23 |     public function setLayout(array $presences): MenuLayoutDataInterface;
24 | 
25 |     /**
26 |      * Returns the alternative presences.
27 |      *
28 |      * @return MenuPresenceInterface[]
29 |      */
30 |     public function alternative(): array;
31 | 
32 |     /**
33 |      * Sets the alternative presences.
34 |      *
35 |      * @param MenuPresenceInterface[] $presences
36 |      * @return $this
37 |      */
38 |     public function setAlternative(array $presences): MenuLayoutDataInterface;
39 | 
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/Data/MenuPermissionsIndexDataInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\Data;
 3 | 
 4 | use Czim\DataObject\Contracts\DataObjectInterface;
 5 | 
 6 | interface MenuPermissionsIndexDataInterface extends DataObjectInterface
 7 | {
 8 | 
 9 |     /**
10 |      * Returns the permissions index.
11 |      *
12 |      * @return array    associative: normalized nested node key => list of permissions
13 |      */
14 |     public function index(): array;
15 | 
16 |     /**
17 |      * Returns a list of all permissions referenced in the index.
18 |      *
19 |      * @return string[]
20 |      */
21 |     public function permissions(): array;
22 | 
23 |     /**
24 |      * Returns indexed permissions for a given menu layout node.
25 |      *
26 |      * @param array $nodeKey
27 |      * @return string[]|false       false if the node is not present in the index
28 |      */
29 |     public function getForNode(array $nodeKey);
30 | 
31 |     /**
32 |      * Sets permissions for a given menu layout node.
33 |      *
34 |      * @param array    $nodeKey
35 |      * @param string[] $permissions
36 |      * @return $this
37 |      */
38 |     public function setForNode(array $nodeKey, array $permissions = []): MenuPermissionsIndexDataInterface;
39 | 
40 |     /**
41 |      * Normalizes an array of keys leading to a node in the layout tree to a single string.
42 |      *
43 |      * @param array $nodeKey
44 |      * @return string
45 |      */
46 |     public function stringifyNodeKey(array $nodeKey): string;
47 | 
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/Localization/LocaleRepositoryInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\Localization;
 3 | 
 4 | interface LocaleRepositoryInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Returns the default locale.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function getDefault(): string;
13 | 
14 |     /**
15 |      * Determines and returns the available locales for the application.
16 |      *
17 |      * @return string[]
18 |      */
19 |     public function getAvailable(): array;
20 | 
21 |     /**
22 |      * Returns whether the application supports multiple locales.
23 |      *
24 |      * @return bool
25 |      */
26 |     public function isLocalized(): bool;
27 | 
28 |     /**
29 |      * Returns whether a locale is valid & available.
30 |      *
31 |      * @param string $locale
32 |      * @return bool
33 |      */
34 |     public function isAvailable(string $locale): bool;
35 | 
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Contracts/Support/View/AssetManagerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Contracts\Support\View;
 3 | 
 4 | interface AssetManagerInterface
 5 | {
 6 | 
 7 |     /**
 8 |      * Registers a CMS stylesheet asset.
 9 |      *
10 |      * @param string      $path
11 |      * @param null|string $type
12 |      * @param null|string $media
13 |      * @param string      $rel
14 |      * @return $this
15 |      */
16 |     public function registerStyleAsset(
17 |         string $path,
18 |         ?string $type = null,
19 |         ?string $media = null,
20 |         string $rel = 'stylesheet'
21 |     ): AssetManagerInterface;
22 | 
23 |     /**
24 |      * Registers a CMS javascript asset by (relative) path.
25 |      *
26 |      * @param string $path
27 |      * @param bool   $head      whether to add the asset to the head
28 |      * @return $this
29 |      */
30 |     public function registerScriptAsset(string $path, bool $head = false): AssetManagerInterface;
31 | 
32 |     /**
33 |      * Registers CMS javascript code
34 |      *
35 |      * @param string  $script
36 |      * @param bool    $once        if true, only registers script with these exact contents once
37 |      * @return $this
38 |      */
39 |     public function registerScript(string $script, bool $once = true): AssetManagerInterface;
40 | 
41 |     /**
42 |      * Returns rendered registered stylesheet asset links.
43 |      *
44 |      * @return string
45 |      */
46 |     public function renderStyleAssets(): string;
47 | 
48 |     /**
49 |      * Returns rendered registered script asset links for the footer.
50 |      *
51 |      * @return string
52 |      */
53 |     public function renderScriptAssets(): string;
54 | 
55 |     /**
56 |      * Returns rendered registered script asset links for the header.
57 |      *
58 |      * @return string
59 |      */
60 |     public function renderScriptHeadAssets(): string;
61 | 
62 |     /**
63 |      * Returns rendered registered scripts.
64 |      *
65 |      * @return string
66 |      */
67 |     public function renderScripts(): string;
68 | 
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Events/AbstractCmsEvent.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Events;
3 | 
4 | abstract class AbstractCmsEvent
5 | {
6 | 
7 | }
8 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsRolesChanged.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Events\Auth;
3 | 
4 | use Czim\CmsCore\Events\AbstractCmsEvent;
5 | 
6 | class CmsRolesChanged extends AbstractCmsEvent
7 | {
8 | }
9 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsUserCreated.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Events\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Events\AbstractCmsEvent;
 6 | 
 7 | class CmsUserCreated extends AbstractCmsEvent
 8 | {
 9 | 
10 |     /**
11 |      * @var UserInterface
12 |      */
13 |     public $user;
14 | 
15 |     public function __construct(UserInterface $user)
16 |     {
17 |         $this->user = $user;
18 |     }
19 | 
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsUserDeleted.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Events\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Events\AbstractCmsEvent;
 6 | 
 7 | class CmsUserDeleted extends AbstractCmsEvent
 8 | {
 9 | 
10 |     /**
11 |      * @var UserInterface
12 |      */
13 |     public $username;
14 | 
15 |     /**
16 |      * @param string $username
17 |      */
18 |     public function __construct($username)
19 |     {
20 |         $this->username = $username;
21 |     }
22 | 
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsUserLoggedIn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Events\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Events\AbstractCmsEvent;
 6 | 
 7 | /**
 8 |  * Class CmsUserLoggedIn
 9 |  *
10 |  * A CMS user logged in, or re-authenticated whether through normal, stateless or forced means.
11 |  */
12 | class CmsUserLoggedIn extends AbstractCmsEvent
13 | {
14 | 
15 |     /**
16 |      * @var UserInterface
17 |      */
18 |     public $user;
19 | 
20 |     /**
21 |      * @var bool
22 |      */
23 |     public $stateless;
24 | 
25 |     /**
26 |      * @var bool
27 |      */
28 |     public $forced;
29 | 
30 |     /**
31 |      * @param UserInterface $user
32 |      * @param bool          $stateless
33 |      * @param bool          $forced
34 |      */
35 |     public function __construct(UserInterface $user, $stateless = false, $forced = false)
36 |     {
37 |         $this->user      = $user;
38 |         $this->stateless = $stateless;
39 |         $this->forced    = $forced;
40 |     }
41 | 
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsUserLoggedOut.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Events\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Events\AbstractCmsEvent;
 6 | 
 7 | /**
 8 |  * Class CmsUserLoggedOut
 9 |  *
10 |  * A CMS user was deliberately logged out.
11 |  */
12 | class CmsUserLoggedOut extends AbstractCmsEvent
13 | {
14 | 
15 |     /**
16 |      * @var UserInterface
17 |      */
18 |     public $user;
19 | 
20 |     public function __construct(UserInterface $user)
21 |     {
22 |         $this->user = $user;
23 |     }
24 | 
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Events/Auth/CmsUserPermissionsChanged.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Events\Auth;
 3 | 
 4 | use Czim\CmsCore\Contracts\Auth\UserInterface;
 5 | use Czim\CmsCore\Events\AbstractCmsEvent;
 6 | 
 7 | class CmsUserPermissionsChanged extends AbstractCmsEvent
 8 | {
 9 | 
10 |     /**
11 |      * @var UserInterface
12 |      */
13 |     public $user;
14 | 
15 |     public function __construct(UserInterface $user)
16 |     {
17 |         $this->user = $user;
18 |     }
19 | 
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Events/CmsHasBooted.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Events;
3 | 
4 | class CmsHasBooted extends AbstractCmsEvent
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/src/Events/CmsHasRegistered.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Events;
3 | 
4 | class CmsHasRegistered extends AbstractCmsEvent
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/src/Exceptions/ExtendingHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Exceptions;
 3 | 
 4 | use App\Exceptions\Handler as LaravelHandler;
 5 | use Illuminate\Contracts\Container\Container;
 6 | use Throwable;
 7 | 
 8 | /**
 9 |  * Class ExtendingHandler
10 |  *
11 |  * This CMS handler extends the app's Handler.
12 |  */
13 | class ExtendingHandler extends LaravelHandler
14 | {
15 | 
16 |     /**
17 |      * Create a new exception handler instance.
18 |      *
19 |      * @param Container $container
20 |      */
21 |     public function __construct(Container $container)
22 |     {
23 |         parent::__construct($container);
24 | 
25 |         $this->mergeConfiguredDontReportExceptions();
26 |     }
27 | 
28 |     /**
29 |      * Merges CMS-configured exception classes not to report
30 |      */
31 |     protected function mergeConfiguredDontReportExceptions()
32 |     {
33 |         $this->dontReport = array_merge(
34 |             $this->dontReport,
35 |             config('cms-core.log.dont-report', [])
36 |         );
37 |     }
38 | 
39 |     /**
40 |      * Override to report to CMS log
41 |      *
42 |      * {@inheritdoc}
43 |      */
44 |     public function report(Throwable $e)
45 |     {
46 |         if ($this->shouldReport($e)) {
47 |             cms()->log($e);
48 |         }
49 |     }
50 | 
51 | }
52 | 


--------------------------------------------------------------------------------
/src/Facades/AuthenticatorFacade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Facades;
 3 | 
 4 | use Illuminate\Support\Facades\Facade;
 5 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | 
 8 | /**
 9 |  * Class AuthenticatorFacade
10 |  *
11 |  * @see AuthenticatorInterface
12 |  */
13 | class AuthenticatorFacade extends Facade
14 | {
15 | 
16 |     /**
17 |      * {@inheritDoc}
18 |      */
19 |     protected static function getFacadeAccessor()
20 |     {
21 |         return Component::AUTH;
22 |     }
23 | 
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Facades/CacheFacade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Facades;
 3 | 
 4 | use Illuminate\Support\Facades\Facade;
 5 | use Czim\CmsCore\Contracts\Core\CacheInterface;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | 
 8 | /**
 9 |  * Class CacheFacade
10 |  *
11 |  * @see CacheInterface
12 |  */
13 | class CacheFacade extends Facade
14 | {
15 | 
16 |     /**
17 |      * {@inheritDoc}
18 |      */
19 |     protected static function getFacadeAccessor()
20 |     {
21 |         return Component::CACHE;
22 |     }
23 | 
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Facades/CoreFacade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Facades;
 3 | 
 4 | use Illuminate\Support\Facades\Facade;
 5 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | 
 8 | /**
 9 |  * Class CoreFacade
10 |  *
11 |  * @see CoreInterface
12 |  */
13 | class CoreFacade extends Facade
14 | {
15 | 
16 |     /**
17 |      * {@inheritDoc}
18 |      */
19 |     protected static function getFacadeAccessor()
20 |     {
21 |         return Component::CORE;
22 |     }
23 | 
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/Api/MenuController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Http\Controllers\Api;
  3 | 
  4 | use Czim\CmsCore\Contracts\Core\CoreInterface;
  5 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
  6 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  7 | use Czim\CmsCore\Http\Controllers\Controller;
  8 | use Illuminate\Support\Collection;
  9 | 
 10 | class MenuController extends Controller
 11 | {
 12 | 
 13 |     /**
 14 |      * @var MenuRepositoryInterface
 15 |      */
 16 |     protected $menu;
 17 | 
 18 | 
 19 |     public function __construct(CoreInterface $core, MenuRepositoryInterface $menu)
 20 |     {
 21 |         parent::__construct($core);
 22 | 
 23 |         $this->menu = $menu;
 24 | 
 25 |         // For web routes, the menu structure is initialized by middleware;
 26 |         // here we must initialize it on-demand for menu-specific requests.
 27 |         $this->menu->initialize();
 28 |     }
 29 | 
 30 | 
 31 |     /**
 32 |      * Returns a list of modules currently loaded.
 33 |      *
 34 |      * @return mixed
 35 |      */
 36 |     public function index()
 37 |     {
 38 |         return $this->core->api()->response(
 39 |             [
 40 |                 'layout' => $this->transformPresencesForApi($this->menu->getMenuLayout()),
 41 |             ]
 42 |         );
 43 |     }
 44 | 
 45 |     /**
 46 |      * Transforms menu presence tree for API response.
 47 |      *
 48 |      * @param array|Collection|MenuPresenceInterface[] $presences
 49 |      * @return array
 50 |      */
 51 |     protected function transformPresencesForApi($presences): array
 52 |     {
 53 |         $response = [];
 54 | 
 55 |         foreach ($presences as $presence) {
 56 |             $response[] = $this->transformPresenceForApi($presence);
 57 |         }
 58 | 
 59 |         return $response;
 60 |     }
 61 | 
 62 |     /**
 63 |      * @param MenuPresenceInterface $presence
 64 |      * @return array
 65 |      */
 66 |     protected function transformPresenceForApi(MenuPresenceInterface $presence): array
 67 |     {
 68 |         $response = [
 69 |             'id'          => $presence->id(),
 70 |             'type'        => $presence->type(),
 71 |             'label'       => $this->makeLabelForPresence($presence),
 72 |             'icon'        => $presence->icon(),
 73 |             'action'      => $this->makeLinkForPresence($presence),
 74 |             'parameters'  => $presence->parameters(),
 75 |             'permissions' => $presence->permissions(),
 76 |             'children'    => [],
 77 |         ];
 78 | 
 79 |         if ($presence->children() && count($presence->children())) {
 80 |             $response['children'] = $this->transformPresencesForApi($presence->children());
 81 |         }
 82 | 
 83 |         return $response;
 84 |     }
 85 | 
 86 |     /**
 87 |      * @param MenuPresenceInterface $presence
 88 |      * @return string|null
 89 |      */
 90 |     protected function makeLabelForPresence(MenuPresenceInterface $presence): ?string
 91 |     {
 92 |         return $presence->label();
 93 |     }
 94 | 
 95 |     /**
 96 |      * @param MenuPresenceInterface $presence
 97 |      * @return string|null
 98 |      */
 99 |     protected function makeLinkForPresence(MenuPresenceInterface $presence): ?string
100 |     {
101 |         return $presence->action();
102 |     }
103 | 
104 | }
105 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/Api/ModulesController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Controllers\Api;
 3 | 
 4 | use Czim\CmsCore\Api\Response\TransformContainer;
 5 | use Czim\CmsCore\Api\Transformers\ModuleTransformer;
 6 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 7 | use Czim\CmsCore\Contracts\Modules\ModuleManagerInterface;
 8 | use Czim\CmsCore\Http\Controllers\Controller;
 9 | use Illuminate\Contracts\Support\Arrayable;
10 | 
11 | class ModulesController extends Controller
12 | {
13 | 
14 |     /**
15 |      * @var ModuleManagerInterface
16 |      */
17 |     protected $modules;
18 | 
19 | 
20 |     public function __construct(CoreInterface $core, ModuleManagerInterface $modules)
21 |     {
22 |         parent::__construct($core);
23 | 
24 |         $this->modules = $modules;
25 |     }
26 | 
27 | 
28 |     /**
29 |      * Returns a list of modules currently loaded.
30 |      *
31 |      * @return mixed
32 |      */
33 |     public function index()
34 |     {
35 |         return $this->core->api()->response(
36 |             $this->makeContainer($this->modules->getModules())
37 |         );
38 |     }
39 | 
40 |     /**
41 |      * @param string $key
42 |      * @return mixed
43 |      */
44 |     public function show($key)
45 |     {
46 |         $module = $this->modules->get($key);
47 | 
48 |         if ( ! $module) {
49 |             return abort(404, 'Module not found or not loaded');
50 |         }
51 | 
52 |         return $this->core->api()->response(
53 |             $this->makeContainer($module, false)
54 |         );
55 |     }
56 | 
57 | 
58 |     /**
59 |      * Wraps data in a transform container.
60 |      *
61 |      * @param object|array|Arrayable $data
62 |      * @param bool                   $collection
63 |      * @return TransformContainer
64 |      */
65 |     protected function makeContainer($data, bool $collection = true): TransformContainer
66 |     {
67 |         return new TransformContainer([
68 |             'content'     => $data,
69 |             'transformer' => new ModuleTransformer,
70 |             'collection'  => $collection,
71 |         ]);
72 |     }
73 | 
74 | }
75 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/Api/VersionController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Controllers\Api;
 3 | 
 4 | use Czim\CmsCore\Api\Response\TransformContainer;
 5 | use Czim\CmsCore\Api\Transformers\VersionTransformer;
 6 | use Czim\CmsCore\Http\Controllers\Controller;
 7 | 
 8 | class VersionController extends Controller
 9 | {
10 | 
11 |     /**
12 |      * Returns a list of components with current version numbers.
13 |      *
14 |      * @return mixed
15 |      */
16 |     public function index()
17 |     {
18 |         return $this->core->api()->response(
19 |             $this->makeContainer($this->getVersions())
20 |         );
21 |     }
22 | 
23 | 
24 |     protected function getVersions(): array
25 |     {
26 |         return [
27 |             [
28 |                 'id'      => 1,
29 |                 'name'    => 'core',
30 |                 'version' => $this->core->version(),
31 |             ],
32 |             [
33 |                 'id'      => 2,
34 |                 'name'    => 'auth',
35 |                 'version' => $this->core->auth()->version(),
36 |             ],
37 |             [
38 |                 'id'      => 3,
39 |                 'name'    => 'module-manager',
40 |                 'version' => $this->core->modules()->version(),
41 |             ],
42 |         ];
43 |     }
44 | 
45 |     /**
46 |      * Wraps data in a transform container.
47 |      *
48 |      * @param array $data
49 |      * @param bool  $collection
50 |      * @return TransformContainer
51 |      */
52 |     protected function makeContainer($data, bool $collection = true): TransformContainer
53 |     {
54 |         return new TransformContainer([
55 |             'content'     => $data,
56 |             'transformer' => new VersionTransformer(),
57 |             'collection'  => $collection,
58 |         ]);
59 |     }
60 | 
61 | }
62 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/Controller.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Controllers;
 3 | 
 4 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 5 | use Illuminate\Foundation\Bus\DispatchesJobs;
 6 | use Illuminate\Routing\Controller as BaseController;
 7 | use Illuminate\Foundation\Validation\ValidatesRequests;
 8 | 
 9 | abstract class Controller extends BaseController
10 | {
11 |     use DispatchesJobs;
12 |     use ValidatesRequests;
13 | 
14 | 
15 |     /**
16 |      * @var CoreInterface
17 |      */
18 |     protected $core;
19 | 
20 | 
21 |     public function __construct(CoreInterface $core)
22 |     {
23 |         $this->core = $core;
24 |     }
25 | 
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/DefaultController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Controllers;
 3 | 
 4 | class DefaultController extends Controller
 5 | {
 6 | 
 7 |     /**
 8 |      * Shows a very boring blank page.
 9 |      *
10 |      * Usable as a safe default fallback action.
11 |      *
12 |      * @return mixed
13 |      */
14 |     public function index()
15 |     {
16 |         return view('cms::blank.index');
17 |     }
18 | 
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/LocaleController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Controllers;
 3 | 
 4 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 5 | use Czim\CmsCore\Contracts\Support\Localization\LocaleRepositoryInterface;
 6 | use Czim\CmsCore\Http\Requests\SetLocaleRequest;
 7 | 
 8 | class LocaleController extends Controller
 9 | {
10 | 
11 |     /**
12 |      * @var LocaleRepositoryInterface
13 |      */
14 |     protected $repository;
15 | 
16 | 
17 |     public function __construct(CoreInterface $core, LocaleRepositoryInterface $repository)
18 |     {
19 |         parent::__construct($core);
20 | 
21 |         $this->repository = $repository;
22 |     }
23 | 
24 |     /**
25 |      * Sets and stores the locale in the session.
26 |      *
27 |      * @param SetLocaleRequest $request
28 |      * @return mixed
29 |      */
30 |     public function setLocale(SetLocaleRequest $request)
31 |     {
32 |         $locale = $request->input('locale');
33 | 
34 |         if ( ! $this->repository->isAvailable($locale)) {
35 |             return redirect()->back()->withErrors("Locale {$locale} is not available");
36 |         }
37 | 
38 |         session()->put($this->getSessionKey(), $locale);
39 | 
40 |         return redirect()->back();
41 |     }
42 | 
43 | 
44 |     protected function getSessionKey(): string
45 |     {
46 |         return $this->core->config('session.prefix') . 'locale';
47 |     }
48 | 
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/Api/Authenticate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware\Api;
 3 | 
 4 | use Closure;
 5 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 6 | 
 7 | class Authenticate
 8 | {
 9 | 
10 |     /**
11 |      * @var AuthenticatorInterface
12 |      */
13 |     protected $auth;
14 | 
15 | 
16 |     public function __construct(AuthenticatorInterface $auth)
17 |     {
18 |         $this->auth = $auth;
19 |     }
20 | 
21 |     /**
22 |      * Handle an incoming request.
23 |      *
24 |      * @param  \Illuminate\Http\Request  $request
25 |      * @param  \Closure  $next
26 |      * @return mixed
27 |      */
28 |     public function handle($request, Closure $next)
29 |     {
30 |         if ( ! $this->auth->check()) {
31 |             return cms_api()->response('Unauthorized.', 401);
32 |         }
33 | 
34 |         return $next($request);
35 |     }
36 | 
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/Authenticate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware;
 3 | 
 4 | use Closure;
 5 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 6 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 7 | use Czim\CmsCore\Support\Enums\Component;
 8 | use Czim\CmsCore\Support\Enums\NamedRoute;
 9 | 
10 | class Authenticate
11 | {
12 | 
13 |     /**
14 |      * @var AuthenticatorInterface
15 |      */
16 |     protected $auth;
17 | 
18 | 
19 |     public function __construct(AuthenticatorInterface $auth)
20 |     {
21 |         $this->auth = $auth;
22 |     }
23 | 
24 |     /**
25 |      * Handle an incoming request.
26 |      *
27 |      * @param  \Illuminate\Http\Request  $request
28 |      * @param  \Closure  $next
29 |      * @return mixed
30 |      */
31 |     public function handle($request, Closure $next)
32 |     {
33 |         if ( ! $this->auth->check()) {
34 | 
35 |             if ($request->ajax() || $request->wantsJson()) {
36 |                 return response('Unauthorized.', 401);
37 |             }
38 | 
39 |             /** @var CoreInterface $core */
40 |             $core = app(Component::CORE);
41 | 
42 |             return redirect()->route( $core->prefixRoute(NamedRoute::AUTH_LOGIN) );
43 |         }
44 | 
45 |         return $next($request);
46 |     }
47 | 
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/CheckPermission.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware;
 3 | 
 4 | use Closure;
 5 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | use Czim\CmsCore\Support\Enums\NamedRoute;
 8 | 
 9 | class CheckPermission
10 | {
11 | 
12 |     /**
13 |      * @var CoreInterface
14 |      */
15 |     protected $core;
16 | 
17 | 
18 |     public function __construct(CoreInterface $core)
19 |     {
20 |         $this->core = $core;
21 |     }
22 | 
23 |     /**
24 |      * Handle an incoming request.
25 |      *
26 |      * @param \Illuminate\Http\Request $request
27 |      * @param Closure                  $next
28 |      * @param string|null              $permission
29 |      * @return mixed
30 |      */
31 |     public function handle($request, Closure $next, $permission = null)
32 |     {
33 |         if (    $permission
34 |             &&  ! $this->core->auth()->admin()
35 |             &&  ! $this->core->auth()->can($permission)
36 |         ) {
37 | 
38 |             if ($this->core->bootChecker()->isCmsApiRequest()) {
39 |                 return $this->core->api()->error('Permission denied', 403);
40 |             }
41 | 
42 |             if ($request->ajax() || $request->wantsJson()) {
43 |                 return response('Permission denied.', 403);
44 |             }
45 | 
46 |             /** @var CoreInterface $core */
47 |             $core = app(Component::CORE);
48 | 
49 |             return redirect()->route( $core->prefixRoute(NamedRoute::HOME) );
50 |         }
51 | 
52 |         return $next($request);
53 |     }
54 | 
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/InitializeMenu.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware;
 3 | 
 4 | use Closure;
 5 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 6 | 
 7 | /**
 8 |  * Class InitializeMenu
 9 |  *
10 |  * Initialize the menu straigth away, so it is easier to debug
11 |  * using the backtrace, which is a pain for view composers.
12 |  */
13 | class InitializeMenu
14 | {
15 | 
16 |     /**
17 |      * @var CoreInterface
18 |      */
19 |     protected $core;
20 | 
21 | 
22 |     public function __construct(CoreInterface $core)
23 |     {
24 |         $this->core = $core;
25 |     }
26 | 
27 |     /**
28 |      * Handle an incoming request.
29 |      *
30 |      * @param \Illuminate\Http\Request $request
31 |      * @param Closure                  $next
32 |      * @return mixed
33 |      */
34 |     public function handle($request, Closure $next)
35 |     {
36 |         $this->core->menu()->initialize();
37 | 
38 |         return $next($request);
39 |     }
40 | 
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/RedirectIfAuthenticated.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware;
 3 | 
 4 | use Closure;
 5 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 6 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 7 | use Czim\CmsCore\Support\Enums\Component;
 8 | use Czim\CmsCore\Support\Enums\NamedRoute;
 9 | 
10 | class RedirectIfAuthenticated
11 | {
12 | 
13 |     /**
14 |      * @var AuthenticatorInterface
15 |      */
16 |     protected $auth;
17 | 
18 | 
19 |     public function __construct(AuthenticatorInterface $auth)
20 |     {
21 |         $this->auth = $auth;
22 |     }
23 | 
24 |     /**
25 |      * Handle an incoming request.
26 |      *
27 |      * @param  \Illuminate\Http\Request  $request
28 |      * @param  \Closure  $next
29 |      * @return mixed
30 |      */
31 |     public function handle($request, Closure $next)
32 |     {
33 |         if ($this->auth->check()) {
34 |             /** @var CoreInterface $core */
35 |             $core = app(Component::CORE);
36 | 
37 |             return redirect()->route( $core->prefixRoute(NamedRoute::HOME) );
38 |         }
39 | 
40 |         return $next($request);
41 |     }
42 | 
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/SetLocale.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Http\Middleware;
  3 | 
  4 | use Closure;
  5 | use Czim\CmsCore\Contracts\Core\CoreInterface;
  6 | use Czim\CmsCore\Contracts\Support\Localization\LocaleRepositoryInterface;
  7 | use Illuminate\Http\Request;
  8 | 
  9 | /**
 10 |  * Class SetLocale
 11 |  *
 12 |  * Sets the active locale for localized applications based on session content
 13 |  * or the request locale.
 14 |  */
 15 | class SetLocale
 16 | {
 17 | 
 18 |     /**
 19 |      * @var CoreInterface
 20 |      */
 21 |     protected $core;
 22 | 
 23 |     /**
 24 |      * @var LocaleRepositoryInterface
 25 |      */
 26 |     protected $repository;
 27 | 
 28 | 
 29 |     public function __construct(CoreInterface $core, LocaleRepositoryInterface $repository)
 30 |     {
 31 |         $this->core       = $core;
 32 |         $this->repository = $repository;
 33 |     }
 34 | 
 35 |     /**
 36 |      * Handle an incoming request.
 37 |      *
 38 |      * @param \Illuminate\Http\Request $request
 39 |      * @param Closure                  $next
 40 |      * @return mixed
 41 |      */
 42 |     public function handle($request, Closure $next)
 43 |     {
 44 |         if ( ! $this->repository->isLocalized()) {
 45 |             return $next($request);
 46 |         }
 47 | 
 48 |         $locale = $this->getValidSessionLocale();
 49 | 
 50 |         if ( ! $locale && $this->core->config('locale.request-based')) {
 51 |             $locale = $this->getRequestLocale($request);
 52 |         }
 53 | 
 54 |         if ($locale) {
 55 |             app()->setLocale($locale);
 56 |         }
 57 | 
 58 |         return $next($request);
 59 |     }
 60 | 
 61 |     /**
 62 |      * Returns the session locale, replacing unavailable with default.
 63 |      *
 64 |      * @return bool|string
 65 |      */
 66 |     protected function getValidSessionLocale()
 67 |     {
 68 |         $locale = $this->getSessionLocale();
 69 | 
 70 |         if ( ! $locale) {
 71 |             return false;
 72 |         }
 73 | 
 74 |         if ( ! $this->repository->isAvailable($locale)) {
 75 |             $locale = $this->repository->getDefault();
 76 |         }
 77 | 
 78 |         return $locale;
 79 |     }
 80 | 
 81 |     protected function getSessionLocale(): ?string
 82 |     {
 83 |         $sessionKey = $this->core->config('session.prefix') . 'locale';
 84 | 
 85 |         return session($sessionKey);
 86 |     }
 87 | 
 88 |     /**
 89 |      * @param Request $request
 90 |      * @return string
 91 |      */
 92 |     protected function getRequestLocale($request): string
 93 |     {
 94 |         $locales = array_unique(
 95 |             array_merge(
 96 |                 [ $this->repository->getDefault() ],
 97 |                 $this->repository->getAvailable()
 98 |             )
 99 |         );
100 | 
101 |         return $request->getPreferredLanguage($locales);
102 |     }
103 | 
104 | }
105 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/VerifyCsrfToken.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Middleware;
 3 | 
 4 | use Closure;
 5 | use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;
 6 | use Illuminate\Session\TokenMismatchException;
 7 | 
 8 | /**
 9 |  * Class VerifyCsrfToken
10 |  *
11 |  * @codeCoverageIgnore
12 |  */
13 | class VerifyCsrfToken extends BaseVerifier
14 | {
15 |     /**
16 |      * The URIs that should be excluded from CSRF verification.
17 |      *
18 |      * @var array
19 |      */
20 |     protected $except = [];
21 | 
22 |     /**
23 |      * Overridden to catch exception and redirect to login instead.
24 |      *
25 |      * {@inheritdoc}
26 |      */
27 |     public function handle($request, Closure $next)
28 |     {
29 |         try {
30 | 
31 |             return parent::handle($request, $next);
32 | 
33 |         } catch (TokenMismatchException $e) {
34 | 
35 |             if ( ! $request->ajax() && ! $request->wantsJson()) {
36 |                 return redirect()->back()->withInput()->with('token', csrf_token());
37 |             }
38 | 
39 |             return response('CSRF Token Mismatch', 500);
40 |         }
41 |     }
42 | 
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Http/Requests/Request.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Http\Requests;
3 | 
4 | use Illuminate\Foundation\Http\FormRequest;
5 | 
6 | abstract class Request extends FormRequest
7 | {
8 | }
9 | 


--------------------------------------------------------------------------------
/src/Http/Requests/SetLocaleRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\Requests;
 3 | 
 4 | class SetLocaleRequest extends Request
 5 | {
 6 | 
 7 |     public function authorize(): bool
 8 |     {
 9 |         return true;
10 |     }
11 | 
12 |     public function rules(): array
13 |     {
14 |         return [
15 |             'locale' => 'required|string',
16 |         ];
17 |     }
18 | 
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Http/ViewComposers/LocaleComposer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Http\ViewComposers;
 3 | 
 4 | use Czim\CmsCore\Contracts\Support\Localization\LocaleRepositoryInterface;
 5 | use Illuminate\Contracts\View\View;
 6 | 
 7 | /**
 8 |  * Class LocaleComposer
 9 |  *
10 |  * Composes data for the locale switching partial.
11 |  */
12 | class LocaleComposer
13 | {
14 | 
15 |     /**
16 |      * @var LocaleRepositoryInterface
17 |      */
18 |     protected $repository;
19 | 
20 | 
21 |     public function __construct(LocaleRepositoryInterface $repository)
22 |     {
23 |         $this->repository = $repository;
24 |     }
25 | 
26 |     /**
27 |      * Bind data to the view.
28 |      *
29 |      * @param View $view
30 |      */
31 |     public function compose(View $view): void
32 |     {
33 |         $view->with([
34 |             'localized'        => $this->repository->isLocalized(),
35 |             'currentLocale'    => app()->getLocale(),
36 |             'availableLocales' => $this->repository->getAvailable(),
37 |         ]);
38 |     }
39 | 
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Providers/Api/CmsCoreApiServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Providers\Api;
 3 | 
 4 | use Czim\CmsCore\Contracts\Api\Response\ResponseBuilderInterface;
 5 | use Czim\CmsCore\Support\Enums\Component;
 6 | use Illuminate\Support\ServiceProvider;
 7 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 8 | 
 9 | class CmsCoreApiServiceProvider extends ServiceProvider
10 | {
11 | 
12 |     /**
13 |      * @var CoreInterface
14 |      */
15 |     protected $core;
16 | 
17 | 
18 |     public function boot()
19 |     {
20 |     }
21 | 
22 |     public function register()
23 |     {
24 |         $this->core = app(Component::CORE);
25 | 
26 |         if ( ! $this->core->bootChecker()->shouldCmsApiRegister()) {
27 |             return;
28 |         }
29 | 
30 |         $this->registerResponseBuilder()
31 |              ->registerConfiguredServiceProviders();
32 |     }
33 | 
34 | 
35 |     /**
36 |      * Registers the configuration-determined response builder.
37 |      *
38 |      * @return $this
39 |      */
40 |     protected function registerResponseBuilder()
41 |     {
42 |         $this->app->singleton(ResponseBuilderInterface::class, $this->core->apiConfig('response-builder'));
43 | 
44 |         return $this;
45 |     }
46 | 
47 |     /**
48 |      * Registers any service providers listed in the core config.
49 |      *
50 |      * @return $this
51 |      */
52 |     protected function registerConfiguredServiceProviders()
53 |     {
54 |         $providers = $this->core->apiConfig('providers', []);
55 | 
56 |         foreach ($providers as $provider) {
57 |             $this->app->register($provider);
58 |         }
59 | 
60 |         return $this;
61 |     }
62 | 
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Providers/EventServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Providers;
 3 | 
 4 | use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 5 | 
 6 | class EventServiceProvider extends ServiceProvider
 7 | {
 8 | 
 9 |     /**
10 |      * {@inheritdoc}
11 |      */
12 |     public function register()
13 |     {
14 |         $this->listen = config('cms-core.events', []);
15 |     }
16 | 
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Providers/LogServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Providers;
 3 | 
 4 | use Czim\CmsCore\Support\Logging\CmsLogManager;
 5 | use Illuminate\Support\Arr;
 6 | use Illuminate\Support\ServiceProvider;
 7 | use Czim\CmsCore\Support\Enums\Component;
 8 | 
 9 | class LogServiceProvider extends ServiceProvider
10 | {
11 | 
12 |     public function boot()
13 |     {
14 |     }
15 | 
16 | 
17 |     public function register()
18 |     {
19 |         if ( ! $this->registerLogger()) {
20 |             // If the logger failed to register,
21 |             // fall back on the default Laravel log manager.
22 |             $this->app->instance(Component::LOG, app('log'));
23 |         }
24 |     }
25 | 
26 | 
27 |     protected function registerLogger(): bool
28 |     {
29 |         $channel = $this->getConfiguredDefaultChannel();
30 | 
31 |         if (null === $channel) {
32 |             return false;
33 |         }
34 | 
35 |         $config = $this->getCmsChannelConfiguration($channel);
36 | 
37 |         if ( ! is_array($config)) {
38 |             return false;
39 |         }
40 | 
41 |         $this->defineChannelConfigurationIfNotSet($channel, $config);
42 | 
43 | 
44 |         // Make the log manager for the CMS with the given channel as its default.
45 |         $cmsLogManager = new CmsLogManager($this->app, $channel);
46 | 
47 |         $this->app->instance(Component::LOG, $cmsLogManager);
48 | 
49 |         return true;
50 |     }
51 | 
52 |     /**
53 |      * Defines config entry for CMS channel if it does not exist.
54 |      *
55 |      * @param string $channel
56 |      * @param array  $configuration
57 |      */
58 |     protected function defineChannelConfigurationIfNotSet($channel, array $configuration)
59 |     {
60 |         if (Arr::has(config('logging.channels'), $channel)) {
61 |             return;
62 |         }
63 | 
64 |         config()->set("logging.channels.{$channel}", $configuration);
65 |     }
66 | 
67 |     /**
68 |      * @return string
69 |      */
70 |     protected function getConfiguredDefaultChannel()
71 |     {
72 |         return config('cms-core.log.channel', 'cms');
73 |     }
74 | 
75 |     /**
76 |      * @param string $channel
77 |      * @return array
78 |      */
79 |     protected function getCmsChannelConfiguration($channel)
80 |     {
81 |         return config("logging.channels.{$channel}", config('cms-core.log.default'));
82 |     }
83 | 
84 | }
85 | 


--------------------------------------------------------------------------------
/src/Providers/ModuleManagerServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Providers;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\ModuleManagerInterface;
 5 | use Illuminate\Support\ServiceProvider;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | 
 8 | /**
 9 |  * Class ModuleManagerServiceProvider
10 |  *
11 |  * Separate provider to initialize the module manager, to make sure that this happens
12 |  * before the other providers are booted -- expecting module data to be available.
13 |  */
14 | class ModuleManagerServiceProvider extends ServiceProvider
15 | {
16 | 
17 |     public function boot()
18 |     {
19 |         /** @var ModuleManagerInterface $manager */
20 |         $manager = app(Component::MODULES);
21 | 
22 |         $manager->initialize();
23 |     }
24 | 
25 | 
26 |     public function register()
27 |     {
28 |     }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Providers/TranslationServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Providers;
 3 | 
 4 | use Czim\CmsCore\Support\Translation\CmsTranslator;
 5 | use Illuminate\Support\ServiceProvider;
 6 | 
 7 | /**
 8 |  * Class TranslationServiceProvider
 9 |  *
10 |  * Re-registers translator binding with CMS translator that gives precedence
11 |  * to CMS-specific translations, with a fallback to application translations.
12 |  */
13 | class TranslationServiceProvider extends ServiceProvider
14 | {
15 | 
16 |     /**
17 |      * Indicates if loading of the provider is deferred.
18 |      *
19 |      * @var bool
20 |      */
21 |     protected $defer = true;
22 | 
23 | 
24 |     public function boot()
25 |     {
26 |         // Re-register on boot() instead of register(), to make sure it
27 |         // is done after the standard translator is registered.
28 | 
29 |         $this->app->singleton('translator', function ($app) {
30 | 
31 |             $trans = new CmsTranslator($app['translation.loader'], $app['config']['app.locale']);
32 | 
33 |             $trans->setFallback($app['config']['app.fallback_locale']);
34 | 
35 |             return $trans;
36 |         });
37 |     }
38 | 
39 |     public function register()
40 |     {
41 |     }
42 | 
43 |     /**
44 |      * Get the services provided by the provider.
45 |      *
46 |      * @return array
47 |      */
48 |     public function provides()
49 |     {
50 |         return ['translator'];
51 |     }
52 | 
53 | }
54 | 


--------------------------------------------------------------------------------
/src/Support/Data/Menu/ConfiguredModulesData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Data\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
 5 | use Czim\CmsCore\Contracts\Support\Data\MenuConfiguredModulesDataInterface;
 6 | use Czim\CmsCore\Support\Data\AbstractDataObject;
 7 | use Illuminate\Support\Collection;
 8 | 
 9 | /**
10 |  * Class ConfiguredModulesData
11 |  *
12 |  * @property Collection|MenuPresenceInterface[][] $standard
13 |  * @property Collection|MenuPresenceInterface[][] $alternative
14 |  */
15 | class ConfiguredModulesData extends AbstractDataObject implements MenuConfiguredModulesDataInterface
16 | {
17 | 
18 |     /**
19 |      * Returns list of lists of presences per module key.
20 |      *
21 |      * @return Collection|MenuPresenceInterface[][]
22 |      */
23 |     public function standard(): Collection
24 |     {
25 |         return $this->getAttribute('standard') ?: new Collection;
26 |     }
27 | 
28 |     /**
29 |      * Returns list of lists of presences per module key.
30 |      *
31 |      * @return Collection|MenuPresenceInterface[][]
32 |      */
33 |     public function alternative(): Collection
34 |     {
35 |         return $this->getAttribute('alternative') ?: new Collection;
36 |     }
37 | 
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Support/Data/Menu/LayoutData.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Support\Data\Menu;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Support\Data\MenuLayoutDataInterface;
  6 | use Czim\CmsCore\Support\Data\AbstractDataObject;
  7 | use Czim\DataObject\Contracts\DataObjectInterface;
  8 | 
  9 | /**
 10 |  * Class LayoutData
 11 |  *
 12 |  * Data container that represents the top level for menu presence layout,
 13 |  * along with related and alternative presences.
 14 |  *
 15 |  * @property MenuPresenceInterface[] $layout
 16 |  * @property MenuPresenceInterface[] $alternative
 17 |  */
 18 | class LayoutData extends AbstractDataObject implements MenuLayoutDataInterface
 19 | {
 20 | 
 21 |     protected $attributes = [
 22 |         // Top-level menu layout elements, either elements of ModelLayoutGroupData or module key strings
 23 |         'layout' => [],
 24 |         // Alternative presences, that are not part of the normal layout
 25 |         'alternative' => [],
 26 |     ];
 27 | 
 28 |     /**
 29 |      * Returns the layout that should be used for displaying the edit form.
 30 |      *
 31 |      * @return array
 32 |      */
 33 |     public function layout(): array
 34 |     {
 35 |         return $this->getAttribute('layout') ?: [];
 36 |     }
 37 | 
 38 |     /**
 39 |      * @return MenuPresenceInterface[]
 40 |      */
 41 |     public function alternative(): array
 42 |     {
 43 |         return $this->getAttribute('alternative') ?: [];
 44 |     }
 45 | 
 46 |     /**
 47 |      * Sets the layout.
 48 |      *
 49 |      * @param MenuPresenceInterface[] $presences
 50 |      * @return $this
 51 |      */
 52 |     public function setLayout(array $presences): MenuLayoutDataInterface
 53 |     {
 54 |         $this->setAttribute('layout', $presences);
 55 | 
 56 |         return $this;
 57 |     }
 58 | 
 59 |     /**
 60 |      * Sets the alternative presences.
 61 |      *
 62 |      * @param MenuPresenceInterface[] $presences
 63 |      * @return $this
 64 |      */
 65 |     public function setAlternative(array $presences): MenuLayoutDataInterface
 66 |     {
 67 |         $this->setAttribute('alternative', $presences);
 68 | 
 69 |         return $this;
 70 |     }
 71 | 
 72 |     /**
 73 |      * Converts attributes to specific dataobjects if configured to
 74 |      *
 75 |      * @param string $key
 76 |      * @return mixed|DataObjectInterface
 77 |      */
 78 |     public function &getAttributeValue(string $key)
 79 |     {
 80 |         if ($key !== 'layout') {
 81 |             return parent::getAttributeValue($key);
 82 |         }
 83 | 
 84 |         if ( ! isset($this->attributes[$key]) || ! is_array($this->attributes[$key])) {
 85 |             $null = [];
 86 |             return $null;
 87 |         }
 88 | 
 89 |         // If object is an array, interpret it as a group
 90 |         $this->decorateLayoutAttribute($key);
 91 | 
 92 |         return $this->attributes[$key];
 93 |     }
 94 | 
 95 |     /**
 96 |      * @param string $topKey
 97 |      */
 98 |     protected function decorateLayoutAttribute(string $topKey = 'layout'): void
 99 |     {
100 |         foreach ($this->attributes[$topKey] as $key => &$value) {
101 | 
102 |             if (is_array($value)) {
103 |                 $value = new LayoutGroupData($value);
104 |             }
105 |         }
106 | 
107 |         unset ($value);
108 |     }
109 | 
110 | }
111 | 


--------------------------------------------------------------------------------
/src/Support/Data/Menu/PermissionsIndexData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Data\Menu;
 3 | 
 4 | use Czim\CmsCore\Contracts\Support\Data\MenuPermissionsIndexDataInterface;
 5 | use Czim\CmsCore\Support\Data\AbstractDataObject;
 6 | use Illuminate\Support\Arr;
 7 | 
 8 | /**
 9 |  * Class PermissionsIndexData
10 |  *
11 |  * Data container that has all the relevant data to filter menu layout on permissions.
12 |  *
13 |  * @property array    $index
14 |  * @property string[] $permissions
15 |  */
16 | class PermissionsIndexData extends AbstractDataObject implements MenuPermissionsIndexDataInterface
17 | {
18 |     public const KEY_TOP_LEVEL = '*';
19 |     public const KEY_SEPARATOR = '.';
20 | 
21 |     protected $attributes = [
22 |         // The permissions index
23 |         'index' => [],
24 |         // All permissions referenced
25 |         'permissions' => [],
26 |     ];
27 | 
28 |     /**
29 |      * Returns the permissions index.
30 |      *
31 |      * @return array    associative: normalized nested node key => list of permissions
32 |      */
33 |     public function index(): array
34 |     {
35 |         return $this->getAttribute('index') ?: [];
36 |     }
37 | 
38 |     /**
39 |      * Returns a list of all permissions referenced in the index.
40 |      *
41 |      * @return string[]
42 |      */
43 |     public function permissions(): array
44 |     {
45 |         return $this->getAttribute('permissions') ?: [];
46 |     }
47 | 
48 |     /**
49 |      * Returns indexed permissions for a given menu layout node.
50 |      *
51 |      * @param array $nodeKey
52 |      * @return string[]|false       false if the node is not present in the index
53 |      */
54 |     public function getForNode(array $nodeKey)
55 |     {
56 |         $normalized = $this->stringifyNodeKey($nodeKey);
57 | 
58 |         return Arr::get($this->index(), $normalized, false);
59 |     }
60 | 
61 |     /**
62 |      * Sets permissions for a given menu layout node.
63 |      *
64 |      * @param array    $nodeKey
65 |      * @param string[] $permissions
66 |      * @return $this
67 |      */
68 |     public function setForNode(array $nodeKey, array $permissions = []): MenuPermissionsIndexDataInterface
69 |     {
70 |         $this->attributes['index'][ $this->stringifyNodeKey($nodeKey) ] = $permissions;
71 | 
72 |         return $this;
73 |     }
74 | 
75 |     /**
76 |      * Normalizes an array of keys leading to a node in the layout tree to a single string.
77 |      *
78 |      * @param array $nodeKey
79 |      * @return string
80 |      */
81 |     public function stringifyNodeKey(array $nodeKey): string
82 |     {
83 |         if ( ! count($nodeKey)) {
84 |             return static::KEY_TOP_LEVEL;
85 |         }
86 | 
87 |         return implode(static::KEY_SEPARATOR, array_map('base64_encode', $nodeKey));
88 |     }
89 | 
90 | }
91 | 


--------------------------------------------------------------------------------
/src/Support/Database/CmsMigration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Database;
 3 | 
 4 | use Illuminate\Database\Migrations\Migration;
 5 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 6 | use Czim\CmsCore\Support\Enums\Component;
 7 | 
 8 | class CmsMigration extends Migration
 9 | {
10 | 
11 |     /**
12 |      * Get the migration connection name.
13 |      *
14 |      * @return string|null
15 |      */
16 |     public function getConnection(): ?string
17 |     {
18 |         $connection = parent::getConnection();
19 | 
20 |         if ( ! app()->bound(Component::CORE)) {
21 |             // @codeCoverageIgnoreStart
22 |             return $connection;
23 |             // @codeCoverageIgnoreEnd
24 |         }
25 | 
26 |         /** @var CoreInterface $core */
27 |         $core = app(Component::CORE);
28 |         $cmsConnection = $core->config('database.driver');
29 | 
30 |         // If no separate database driver is configured for the CMS,
31 |         // we can use the normal driver and rely on the prefix alone.
32 |         if ( ! $cmsConnection) {
33 |             return $connection;
34 |         }
35 | 
36 |         // If we're running tests, make sure we use the correct override
37 |         // for the CMS database connection/driver.
38 |         // N.B. This is ignored on purpose if the default connection is not overridden normally.
39 |         if (app()->runningUnitTests()) {
40 |             $cmsConnection = $core->config('database.testing.driver') ?: $cmsConnection;
41 |         }
42 | 
43 |         return $cmsConnection;
44 |     }
45 | 
46 |     /**
47 |      * @param string $name
48 |      * @return string
49 |      */
50 |     protected function prefixCmsTable(?string $name): string
51 |     {
52 |         return config('cms-core.database.prefix', '') . $name;
53 |     }
54 | 
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Support/Enums/AclPresenceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | class AclPresenceType extends Enum
 7 | {
 8 |     public const GROUP      = 'group';         // Group container (should have children)
 9 |     public const PERMISSION = 'permission';    // CMS permission key
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Support/Enums/CmsMiddleware.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | /**
 7 |  * Class CmsMiddleware
 8 |  *
 9 |  * Listing of CMS-specific 'hard-coded' middleware. Since these are
10 |  * supposed to be middleware key names, be careful not to use ':'.
11 |  */
12 | class CmsMiddleware extends Enum
13 | {
14 |     public const AUTHENTICATED = 'cms\auth';
15 |     public const GUEST         = 'cms\guest';
16 |     public const PERMISSION    = 'cms\permission';
17 | 
18 |     public const API_AUTHENTICATED = 'cms\api\auth';
19 |     public const API_AUTH_OWNER    = 'cms\api\auth-owner';
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Support/Enums/Component.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | /**
 7 |  * Class Component
 8 |  *
 9 |  * Listing of standard CMS components as bound in Laravel's service container.
10 |  * Note that these values will be used as config keys aswell, so be careful not
11 |  * to use periods (.).
12 |  */
13 | class Component extends Enum
14 | {
15 |     public const ACL  = 'cms-acl';
16 |     public const API         = 'cms-api';
17 |     public const ASSETS      = 'cms-assets';
18 |     public const AUTH        = 'cms-auth';
19 |     public const BOOTCHECKER = 'cms-bootchecker';
20 |     public const CACHE       = 'cms-cache';
21 |     public const CORE        = 'cms-core';
22 |     public const LOG         = 'cms-log';
23 |     public const MENU        = 'cms-menu';
24 |     public const MODULES     = 'cms-modules';
25 |     public const NOTIFIER    = 'cms-notifier';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Support/Enums/FlashLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | /**
 7 |  * Class FlashLevel
 8 |  *
 9 |  * Session flash message levels.
10 |  */
11 | class FlashLevel extends Enum
12 | {
13 |     public const DANGER  = 'danger';
14 |     public const INFO    = 'info';
15 |     public const SUCCESS = 'success';
16 |     public const WARNING = 'warning';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Support/Enums/MenuPresenceMode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | class MenuPresenceMode extends Enum
 7 | {
 8 |     public const ADD     = 'add';      // Does not affect existing presences, adds a new one (index should be ignored)
 9 |     public const DELETE  = 'delete';   // Deleting original presence, no new one added
10 |     public const MODIFY  = 'modify';   // Modifying only the set keys for the original presence
11 |     public const REPLACE = 'replace';  // Replaces contents of presence entirely, nullifying original
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Support/Enums/MenuPresenceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | class MenuPresenceType extends Enum
 7 | {
 8 |     public const GROUP  = 'group';     // Group container (should have children)
 9 |     public const ACTION = 'action';    // CMS Route action (array or string)
10 |     public const LINK   = 'link';      // Simple hyperlink
11 |     public const HTML   = 'html';      // Custom HTML content
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Support/Enums/NamedRoute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Enums;
 3 | 
 4 | use MyCLabs\Enum\Enum;
 5 | 
 6 | /**
 7 |  * Class NamedRoute
 8 |  *
 9 |  * Listing of 'hard-coded' standard route names for critical CMS routes.
10 |  */
11 | class NamedRoute extends Enum
12 | {
13 |     public const HOME                = 'home';
14 |     public const AUTH_LOGIN          = 'auth-login';
15 |     public const AUTH_LOGOUT         = 'auth-logout';
16 |     public const AUTH_PASSWORD_EMAIL = 'auth-password-email';
17 |     public const AUTH_PASSWORD_RESET = 'auth-password-reset';
18 |     public const LOCALE_SET          = 'locale-set';
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Support/Logging/CmsCustomizeFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Logging;
 3 | 
 4 | use Monolog\Logger;
 5 | 
 6 | class CmsCustomizeFormatter
 7 | {
 8 | 
 9 |     /**
10 |      * Customize the given Monolog instance.
11 |      *
12 |      * @param Logger $monolog
13 |      */
14 |     public function __invoke($monolog)
15 |     {
16 |         foreach ($monolog->getHandlers() as $handler) {
17 | 
18 |             $handler->setFormatter(
19 |                 new CmsFormatterDecorator($handler->getFormatter())
20 |             );
21 |         }
22 |     }
23 | 
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Support/Logging/CmsFormatterDecorator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Logging;
 3 | 
 4 | use Monolog\Formatter\FormatterInterface;
 5 | 
 6 | class CmsFormatterDecorator implements FormatterInterface
 7 | {
 8 |     public const CMS_RECORD_PREFIX = '[CMS] ';
 9 | 
10 | 
11 |     /**
12 |      * @var FormatterInterface
13 |      */
14 |     protected $formatter;
15 | 
16 |     /**
17 |      * @var string
18 |      */
19 |     protected $formatterPrefix = self::CMS_RECORD_PREFIX;
20 | 
21 | 
22 |     public function __construct(FormatterInterface $formatter)
23 |     {
24 |         $this->formatter = $formatter;
25 |     }
26 | 
27 | 
28 |     /**
29 |      * Formats a log record.
30 |      *
31 |      * @param array $record     a record to format
32 |      * @return mixed    the formatted record
33 |      */
34 |     public function format(array $record)
35 |     {
36 |         $formattedRecord = $this->formatter->format($record);
37 | 
38 |         if (is_array($formattedRecord)) {
39 |             [$channel, $message, $backtrace, $loglevel] = $formattedRecord;
40 | 
41 |             return [
42 |                 $channel,
43 |                 $this->formatterPrefix . $message,
44 |                 $backtrace,
45 |                 $loglevel,
46 |             ];
47 |         }
48 | 
49 |         return $this->formatterPrefix . $formattedRecord;
50 |     }
51 | 
52 |     /**
53 |      * Formats a set of log records.
54 |      *
55 |      * @param array $records    a set of records to format
56 |      * @return mixed    the formatted set of records
57 |      */
58 |     public function formatBatch(array $records)
59 |     {
60 |         return $this->formatter->formatBatch($records);
61 |     }
62 | 
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Support/Logging/CmsLogManager.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Logging;
 3 | 
 4 | use Illuminate\Contracts\Foundation\Application;
 5 | use Illuminate\Foundation\Application as FoundationApplication;
 6 | use Illuminate\Log\LogManager;
 7 | 
 8 | /**
 9 |  * Class CmsLogManager
10 |  *
11 |  * Extension of the Laravel log manager with its own default channel
12 |  * for the CMS-context.
13 |  */
14 | class CmsLogManager extends LogManager
15 | {
16 | 
17 |     /**
18 |      * @var string
19 |      */
20 |     protected $defaultChannel;
21 | 
22 | 
23 |     /**
24 |      * Create a new Log manager instance.
25 |      *
26 |      * @param Application|FoundationApplication $app
27 |      * @param string                            $defaultChannel
28 |      */
29 |     public function __construct($app, string $defaultChannel = 'cms')
30 |     {
31 |         parent::__construct($app);
32 | 
33 |         $this->defaultChannel = $defaultChannel;
34 |     }
35 | 
36 | 
37 |     /**
38 |      * Get the default log driver name.
39 |      *
40 |      * @return string
41 |      */
42 |     public function getDefaultDriver()
43 |     {
44 |         return $this->defaultChannel;
45 |     }
46 | 
47 |     /**
48 |      * Set the default log driver name.
49 |      *
50 |      * @param string $name
51 |      */
52 |     public function setDefaultDriver($name): void
53 |     {
54 |         $this->defaultChannel = $name;
55 |     }
56 | 
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Support/Translation/CmsTranslator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Support\Translation;
 3 | 
 4 | use Illuminate\Support\Str;
 5 | use Illuminate\Translation\Translator;
 6 | 
 7 | /**
 8 |  * Class CmsTranslator
 9 |  *
10 |  * Translator that uses CMS-specific translations where possible,
11 |  * and falls back to application translations where not.
12 |  */
13 | class CmsTranslator extends Translator
14 | {
15 | 
16 |     /**
17 |      * Prefix to prepend to normal keys to get CMS-specific translations.
18 |      *
19 |      * @return string
20 |      */
21 |     protected function getCmsPrefix(): string
22 |     {
23 |         return 'cms::';
24 |     }
25 | 
26 |     /**
27 |      * Prefixes an unprefixed key to be CMS-specific.
28 |      *
29 |      * @param string $key
30 |      * @return string
31 |      */
32 |     protected function applyCmsPrefix(string $key): string
33 |     {
34 |         return $this->getCmsPrefix() . $key;
35 |     }
36 | 
37 |     /**
38 |      * Returns whether a key is prefixed as CMS-specific.
39 |      *
40 |      * @param string $key
41 |      * @return bool
42 |      */
43 |     protected function isCmsPrefixed(string $key): bool
44 |     {
45 |         return Str::startsWith($key, $this->getCmsPrefix());
46 |     }
47 | 
48 |     /**
49 |      * Get the translation for the given key.
50 |      *
51 |      * {@inheritdoc}
52 |      */
53 |     public function get($key, array $replace = [], $locale = null, $fallback = true)
54 |     {
55 |         // If we have a CMS-prefixed version, use it.
56 |         if ( ! $this->isCmsPrefixed($key)) {
57 |             $prefixedKey = $this->applyCmsPrefix($key);
58 | 
59 |             if ($this->has($prefixedKey, $locale, $fallback)) {
60 |                 $key = $prefixedKey;
61 |             }
62 |         }
63 | 
64 |         return parent::get($key, $replace, $locale, $fallback);
65 |     }
66 | 
67 | }
68 | 


--------------------------------------------------------------------------------
/tests/Api/ModulesTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Api;
 6 | 
 7 | use Czim\CmsCore\Test\ApiTestCase;
 8 | use Czim\CmsCore\Test\Helpers\Modules\SimpleAssociatedTestModule;
 9 | use Czim\CmsCore\Test\Helpers\Modules\SimpleTestModule;
10 | use Czim\CmsCore\Test\Helpers\Modules\SimpleTestModuleWithServiceProviders;
11 | use Illuminate\Foundation\Application;
12 | 
13 | class ModulesTest extends ApiTestCase
14 | {
15 | 
16 |     /**
17 |      * {@inheritdoc}
18 |      */
19 |     protected function getEnvironmentSetUp($app): void
20 |     {
21 |         parent::getEnvironmentSetUp($app);
22 | 
23 |         $this->setUpBasicModules($app);
24 |     }
25 | 
26 |     /**
27 |      * @test
28 |      */
29 |     function it_responds_with_a_list_of_modules()
30 |     {
31 |         $response = $this->call('get', 'cms-api/meta/modules');
32 | 
33 |         $response->assertStatus(200)
34 |              ->assertJsonFragment([
35 |                  'key'  => 'associated-test-module',
36 |                  'name' => 'Test Associated Module',
37 |              ])
38 |              ->assertJsonFragment([
39 |                 'key'  => 'test-module',
40 |                 'name' => 'Test Module',
41 |              ])
42 |              ->assertJsonFragment([
43 |                 'key'  => 'test-module-with-service-providers',
44 |                 'name' => 'Test Module With Service Providers',
45 |              ]);
46 | 
47 |         $response = $response->decodeResponseJson();
48 | 
49 |         static::assertArrayHasKey('data', $response);
50 |         static::assertCount(3, $response['data']);
51 |     }
52 |     
53 |     /**
54 |      * @test
55 |      */
56 |     function it_responds_with_information_on_a_single_module_by_key()
57 |     {
58 |         $response = $this->call('get', 'cms-api/meta/modules/test-module-with-service-providers');
59 | 
60 |         $response->assertStatus(200)
61 |             ->assertJsonFragment([
62 |                 'key'  => 'test-module-with-service-providers',
63 |                 'name' => 'Test Module With Service Providers',
64 |             ]);
65 | 
66 |         $response = $response->decodeResponseJson();
67 | 
68 |         static::assertArrayHasKey('data', $response);
69 |     }
70 | 
71 |     /**
72 |      * @test
73 |      */
74 |     function it_responds_with_404_if_single_module_by_key_was_not_found()
75 |     {
76 |         $response = $this->call('get', 'cms-api/meta/modules/does-not-exist');
77 | 
78 |         $response->assertStatus(404);
79 |     }
80 | 
81 |     /**
82 |      * @param Application $app
83 |      */
84 |     protected function setUpBasicModules(Application $app)
85 |     {
86 |         $app['config']->set('cms-modules.modules', [
87 |             SimpleTestModule::class,
88 |             SimpleAssociatedTestModule::class,
89 |             SimpleTestModuleWithServiceProviders::class,
90 |         ]);
91 |     }
92 | 
93 | }
94 | 


--------------------------------------------------------------------------------
/tests/Api/Response/TransformContainerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Api;
 6 | 
 7 | use Czim\CmsCore\Api\Response\TransformContainer;
 8 | use Czim\CmsCore\Test\CmsBootTestCase;
 9 | use Illuminate\Support\Collection;
10 | 
11 | class TransformContainerTest extends CmsBootTestCase
12 | {
13 | 
14 |     /**
15 |      * @test
16 |      */
17 |     function it_defaults_to_content_type_for_determining_is_collection_value()
18 |     {
19 |         $container = new TransformContainer([
20 |             'content'    => new Collection,
21 |             'collection' => null,
22 |         ]);
23 | 
24 |         static::assertTrue($container->isCollection());
25 |     }
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/tests/Api/VersionsTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Api;
 6 | 
 7 | use Czim\CmsCore\Test\ApiTestCase;
 8 | 
 9 | class VersionsTest extends ApiTestCase
10 | {
11 | 
12 |     /**
13 |      * @test
14 |      */
15 |     function it_responds_with_versions_for_core_components()
16 |     {
17 |         $response = $this->call('get', 'cms-api/meta/versions');
18 | 
19 |         $response->assertStatus(200)
20 |              ->assertJsonStructure([
21 |                  'data' => [
22 |                      '*' => [ 'id', 'name', 'version' ]
23 |                  ]
24 |              ])
25 |             ->assertJsonFragment([ 'name' => 'core' ])
26 |             ->assertJsonFragment([ 'name' => 'auth' ])
27 |             ->assertJsonFragment([ 'name' => 'module-manager' ]);
28 | 
29 |         // see if each item is follows the semantic version format
30 |         $response = $response->decodeResponseJson();
31 | 
32 |         foreach ($response['data'] as $version) {
33 |             static::assertRegExp('#^\d+\.\d+\.\d+$#', $version['version']);
34 |         }
35 |     }
36 | 
37 | }
38 | 


--------------------------------------------------------------------------------
/tests/ApiTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test;
 3 | 
 4 | use Czim\CmsAuthApi\Http\Middleware\OAuthMiddleware;
 5 | use Czim\CmsAuthApi\Http\Middleware\OAuthUserOwnerMiddleware;
 6 | use Czim\CmsCore\Test\Helpers\Core\MockApiBootChecker;
 7 | use Czim\CmsCore\Test\Helpers\Http\NullMiddleware;
 8 | use Illuminate\Foundation\Application;
 9 | 
10 | abstract class ApiTestCase extends WebTestCase
11 | {
12 | 
13 |     /**
14 |      * Define environment setup.
15 |      *
16 |      * @param Application $app
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         parent::getEnvironmentSetUp($app);
21 | 
22 |         $this->bindNullMiddleware($app);
23 |     }
24 | 
25 |     protected function getTestBootCheckerBinding(): string
26 |     {
27 |         return MockApiBootChecker::class;
28 |     }
29 | 
30 |     /**
31 |      * Binds inert middleware to standard API middleware not included in this package.
32 |      *
33 |      * @param Application $app
34 |      */
35 |     protected function bindNullMiddleware(Application $app): void
36 |     {
37 |         $app->bind(
38 |             OAuthMiddleware::class,
39 |             NullMiddleware::class
40 |         );
41 | 
42 |         $app->bind(
43 |             OAuthUserOwnerMiddleware::class,
44 |             NullMiddleware::class
45 |         );
46 |     }
47 | 
48 | }
49 | 


--------------------------------------------------------------------------------
/tests/Console/CacheMenuTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
 8 | use Czim\CmsCore\Test\CmsBootTestCase;
 9 | use Mockery;
10 | use Mockery\Mock;
11 | use Mockery\MockInterface;
12 | 
13 | class CacheMenuTest extends CmsBootTestCase
14 | {
15 | 
16 |     /**
17 |      * @test
18 |      */
19 |     function it_caches_using_the_menu_repository()
20 |     {
21 |         /** @var Mock|MockInterface|MenuRepositoryInterface $repositoryMock */
22 |         $repositoryMock = Mockery::mock(MenuRepositoryInterface::class);
23 | 
24 |         $repositoryMock->shouldReceive('clearCache')->once()->andReturnSelf();
25 |         $repositoryMock->shouldReceive('writeCache')->once()->andReturnSelf();
26 | 
27 |         $this->app->instance(MenuRepositoryInterface::class, $repositoryMock);
28 | 
29 |         $this->artisan('cms:menu:cache')->assertExitCode(0);
30 |     }
31 | 
32 | }
33 | 


--------------------------------------------------------------------------------
/tests/Console/ClearMenuCacheTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
 8 | use Czim\CmsCore\Test\CmsBootTestCase;
 9 | use Mockery;
10 | use Mockery\Mock;
11 | use Mockery\MockInterface;
12 | 
13 | class ClearMenuCacheTest extends CmsBootTestCase
14 | {
15 | 
16 |     /**
17 |      * @test
18 |      */
19 |     function it_clears_cache_using_the_menu_repository()
20 |     {
21 |         /** @var MenuRepositoryInterface|Mock|MockInterface $repositoryMock */
22 |         $repositoryMock = Mockery::mock(MenuRepositoryInterface::class);
23 | 
24 |         $repositoryMock->shouldReceive('clearCache')->once();
25 | 
26 |         $this->app->instance(MenuRepositoryInterface::class, $repositoryMock);
27 | 
28 |         $this->artisan('cms:menu:clear')->assertExitCode(0);
29 |     }
30 | 
31 | }
32 | 


--------------------------------------------------------------------------------
/tests/Console/MigrateInstallCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use Czim\CmsCore\Test\SimpleDbTestCase;
 8 | use Illuminate\Support\Facades\Schema;
 9 | 
10 | class MigrateInstallCommandTest extends SimpleDbTestCase
11 | {
12 | 
13 |     /**
14 |      * @test
15 |      */
16 |     function it_installs_the_migration_table_if_it_does_not_exist()
17 |     {
18 |         static::assertFalse(
19 |             Schema::connection('testbench')->hasTable('cms_migrations'), '
20 |             CMS migration table should not exist yet'
21 |         );
22 | 
23 |         $this->artisan('cms:migrate:install')->assertExitCode(0);
24 | 
25 |         static::assertTrue(
26 |             Schema::connection('testbench')->hasTable('cms_migrations'),
27 |             'CMS migration table was not created'
28 |         );
29 |     }
30 | 
31 | }
32 | 


--------------------------------------------------------------------------------
/tests/Console/MigrateRefreshCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use CreateTestRecordsTable;
 8 | use Czim\CmsCore\Test\SimpleDbTestCase;
 9 | use Illuminate\Support\Facades\DB;
10 | use Illuminate\Support\Facades\Schema;
11 | 
12 | class MigrateRefreshCommandTest extends SimpleDbTestCase
13 | {
14 | 
15 |     public function setUp(): void
16 |     {
17 |         parent::setUp();
18 | 
19 |         $this->setHelperCmsMigrationPath();
20 |     }
21 | 
22 |     /**
23 |      * @test
24 |      */
25 |     function it_refreshes_database_migrations()
26 |     {
27 |         // Set up
28 |         $this->setHelperCmsMigrationPath();
29 |         $this->createMigrationTable();
30 | 
31 |         (new CreateTestRecordsTable())->up();
32 | 
33 |         DB::table('cms_migrations')->insert([
34 |             'migration' => '2017_01_01_100000_create_test_records_table',
35 |             'batch'     => 1,
36 |         ]);
37 | 
38 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_test_records'), 'Failed to fake migration');
39 | 
40 |         // Test
41 |         $this->artisan('cms:migrate:refresh', ['--seed' => true])->assertExitCode(0);
42 | 
43 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_test_records'));
44 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_more_test_records'));
45 | 
46 |         $this->assertDatabaseHas('cms_test_records', [ 'description' => 'testing!' ]);
47 |     }
48 | 
49 | }
50 | 


--------------------------------------------------------------------------------
/tests/Console/MigrateResetCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use CreateTestRecordsTable;
 8 | use Czim\CmsCore\Test\SimpleDbTestCase;
 9 | use Illuminate\Support\Facades\DB;
10 | use Illuminate\Support\Facades\Schema;
11 | 
12 | class MigrateResetCommandTest extends SimpleDbTestCase
13 | {
14 | 
15 |     public function setUp(): void
16 |     {
17 |         parent::setUp();
18 | 
19 |         $this->setHelperCmsMigrationPath();
20 |         $this->withoutMockingConsoleOutput();
21 |     }
22 | 
23 |     /**
24 |      * @test
25 |      */
26 |     function it_resets_database_migrations()
27 |     {
28 |         // Set up
29 |         $this->setHelperCmsMigrationPath();
30 |         $this->createMigrationTable();
31 | 
32 |         (new CreateTestRecordsTable())->up();
33 | 
34 |         DB::table('cms_migrations')->insert([
35 |             'migration' => '2017_01_01_100000_create_test_records_table',
36 |             'batch'     => 1,
37 |         ]);
38 | 
39 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_test_records'), 'Failed to fake migration');
40 | 
41 |         // Test
42 |         static::assertEquals(0, $this->artisan('cms:migrate:reset'));
43 | 
44 |         static::assertFalse(Schema::connection('testbench')->hasTable('cms_test_records'));
45 |         static::assertFalse(Schema::connection('testbench')->hasTable('cms_more_test_records'));
46 |     }
47 | 
48 |     /**
49 |      * @test
50 |      */
51 |     function it_reports_when_the_migration_table_does_not_exist()
52 |     {
53 |         static::assertEquals(0, $this->artisan('cms:migrate:reset'));
54 | 
55 |         static::assertRegExp('#not found#i', $this->getArtisanOutput());
56 |     }
57 | 
58 | }
59 | 


--------------------------------------------------------------------------------
/tests/Console/MigrateRollbackCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use CreateMoreTestRecordsTable;
 8 | use CreateTestRecordsTable;
 9 | use Czim\CmsCore\Test\SimpleDbTestCase;
10 | use Illuminate\Support\Facades\DB;
11 | use Illuminate\Support\Facades\Schema;
12 | 
13 | class MigrateRollbackCommandTest extends SimpleDbTestCase
14 | {
15 | 
16 |     public function setUp(): void
17 |     {
18 |         parent::setUp();
19 | 
20 |         $this->setHelperCmsMigrationPath();
21 |     }
22 | 
23 |     /**
24 |      * @test
25 |      */
26 |     function it_rolls_back_a_migration()
27 |     {
28 |         // Set up
29 |         $this->setHelperCmsMigrationPath();
30 |         $this->createMigrationTable();
31 | 
32 |         (new CreateTestRecordsTable())->up();
33 |         (new CreateMoreTestRecordsTable())->up();
34 | 
35 |         DB::table('cms_migrations')->insert([
36 |             'migration' => '2017_01_01_100000_create_test_records_table',
37 |             'batch'     => 1,
38 |         ]);
39 |         DB::table('cms_migrations')->insert([
40 |             'migration' => '2017_01_01_200000_create_more_test_records_table',
41 |             'batch'     => 2,
42 |         ]);
43 | 
44 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_test_records'), 'Failed to fake migration');
45 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_more_test_records'), 'Failed to fake migration');
46 | 
47 |         // Test
48 |         $this->artisan('cms:migrate:rollback')->assertExitCode(0);
49 | 
50 |         static::assertTrue(Schema::connection('testbench')->hasTable('cms_test_records'));
51 |         static::assertFalse(Schema::connection('testbench')->hasTable('cms_more_test_records'));
52 |     }
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/tests/Console/MigrateStatusCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Console;
 6 | 
 7 | use Czim\CmsCore\Test\SimpleDbTestCase;
 8 | use Illuminate\Support\Facades\DB;
 9 | use Illuminate\Support\Facades\Schema;
10 | 
11 | class MigrateStatusCommandTest extends SimpleDbTestCase
12 | {
13 | 
14 |     /**
15 |      * {@inheritdoc}
16 |      */
17 |     public function setUp(): void
18 |     {
19 |         parent::setUp();
20 | 
21 |         $this->withoutMockingConsoleOutput();
22 |     }
23 | 
24 |     /**
25 |      * @test
26 |      */
27 |     function it_reports_no_migrations_if_the_migration_table_is_not_installed()
28 |     {
29 |         static::assertFalse(
30 |             Schema::connection('testbench')->hasTable('cms_migrations'),
31 |             'CMS migration table should not exist yet'
32 |         );
33 | 
34 |         static::assertEquals(0, $this->artisan('cms:migrate:status'));
35 | 
36 |         static::assertRegExp('#no (cms\s+)?migrations#i', $this->getArtisanOutput());
37 |     }
38 | 
39 |     /**
40 |      * @test
41 |      */
42 |     function it_reports_no_migrations_if_migration_table_is_empty()
43 |     {
44 |         $this->createMigrationTable();
45 | 
46 |         static::assertEquals(0, $this->artisan('cms:migrate:status'));
47 | 
48 |         static::assertRegExp('#no (cms\s+)?migrations#i', $this->getArtisanOutput());
49 |     }
50 | 
51 |     /**
52 |      * @test
53 |      */
54 |     function it_reports_migration_status()
55 |     {
56 |         $this->setHelperCmsMigrationPath();
57 |         $this->createMigrationTable();
58 | 
59 |         // Status when no migrations are run
60 |         static::assertEquals(0, $this->artisan('cms:migrate:status'));
61 | 
62 |         $output = $this->getArtisanOutput();
63 | 
64 |         static::assertRegExp('#\|\s+n\s+\|\s+2017_01_01_100000_create_test_records_table#is', $output);
65 |         static::assertRegExp('#\|\s+n\s+\|\s+2017_01_01_200000_create_more_test_records_table#is', $output);
66 | 
67 |         // Status when a single migration has run
68 |         DB::table('cms_migrations')->insert([
69 |             'migration' => '2017_01_01_100000_create_test_records_table',
70 |             'batch'     => 1,
71 |         ]);
72 | 
73 |         static::assertEquals(0, $this->artisan('cms:migrate:status'));
74 | 
75 |         $output = $this->getArtisanOutput();
76 | 
77 |         static::assertRegExp('#\|\s+y\s+\|\s+2017_01_01_100000_create_test_records_table#is', $output);
78 |         static::assertRegExp('#\|\s+n\s+\|\s+2017_01_01_200000_create_more_test_records_table#is', $output);
79 |     }
80 | 
81 | }
82 | 


--------------------------------------------------------------------------------
/tests/Core/BasicNotifierTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Core;
 6 | 
 7 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 8 | use Czim\CmsCore\Core\BasicNotifier;
 9 | use Czim\CmsCore\Test\Helpers\Spies\SessionSpy;
10 | use Czim\CmsCore\Test\CmsBootTestCase;
11 | use Illuminate\Session\SessionManager;
12 | use Mockery;
13 | use Mockery\Mock;
14 | use Mockery\MockInterface;
15 | 
16 | class BasicNotifierTest extends CmsBootTestCase
17 | {
18 |     /**
19 |      * @var SessionManager
20 |      */
21 |     protected $sessionMock;
22 | 
23 |     /**
24 |      * @test
25 |      */
26 |     function it_can_flash_a_message_to_the_session()
27 |     {
28 |         $this->sessionMock = $this->getSessionSpy();
29 | 
30 |         $notifier = $this->makeNotifier();
31 | 
32 |         static::assertEmpty($notifier->getFlashed(), 'no messages should be in flash memory on init');
33 | 
34 |         $notifier->flash('testing message');
35 | 
36 |         $flashed = $notifier->getFlashed();
37 | 
38 |         static::assertIsArray($flashed);
39 |         static::assertCount(1, $flashed);
40 |         static::assertEquals(['level' => 'info', 'message' => 'testing message'], head($flashed));
41 |     }
42 | 
43 |     /**
44 |      * @test
45 |      */
46 |     function it_clears_flash_messages_after_retrieving_by_default()
47 |     {
48 |         $this->sessionMock = $this->getSessionSpy();
49 | 
50 |         $notifier = $this->makeNotifier();
51 | 
52 |         $notifier->flash('testing message');
53 | 
54 |         static::assertCount(1, $notifier->getFlashed());
55 |         static::assertCount(0, $notifier->getFlashed(), 'Flash message was not cleared');
56 |     }
57 | 
58 |     /**
59 |      * @test
60 |      */
61 |     function it_optionally_does_not_clear_flash_messages_after_retrieving()
62 |     {
63 |         $this->sessionMock = $this->getSessionSpy();
64 | 
65 |         $notifier = $this->makeNotifier();
66 | 
67 |         $notifier->flash('testing message');
68 | 
69 |         static::assertCount(1, $notifier->getFlashed(false));
70 |         static::assertCount(1, $notifier->getFlashed(), 'Flash message was cleared');
71 |     }
72 | 
73 | 
74 |     protected function makeNotifier(): BasicNotifier
75 |     {
76 |         return new BasicNotifier($this->getMockCore());
77 |     }
78 | 
79 |     /**
80 |      * @return MockInterface|Mock|CoreInterface $mockCore
81 |      */
82 |     protected function getMockCore()
83 |     {
84 |         /** @var MockInterface|Mock|CoreInterface $mockCore */
85 |         $mockCore = Mockery::mock(CoreInterface::class);
86 | 
87 |         $mockCore->shouldReceive('session')->andReturn($this->sessionMock);
88 | 
89 |         return $mockCore;
90 |     }
91 | 
92 |     protected function getSessionSpy(): SessionSpy
93 |     {
94 |         return new SessionSpy;
95 |     }
96 | 
97 | }
98 | 
99 | 


--------------------------------------------------------------------------------
/tests/Helpers/Api/TestTransformer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Api;
 3 | 
 4 | use League\Fractal\TransformerAbstract;
 5 | 
 6 | class TestTransformer extends TransformerAbstract
 7 | {
 8 | 
 9 |     /**
10 |      * @param mixed $content
11 |      * @return mixed
12 |      */
13 |     public function transform($content)
14 |     {
15 |         return $content;
16 |     }
17 | 
18 | }
19 | 


--------------------------------------------------------------------------------
/tests/Helpers/Exceptions/WithGetStatusCodeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Exceptions;
 3 | 
 4 | class WithGetStatusCodeException extends \Exception
 5 | {
 6 | 
 7 |     public function getStatusCode(): int
 8 |     {
 9 |         return 418;
10 |     }
11 | 
12 | }
13 | 


--------------------------------------------------------------------------------
/tests/Helpers/Exceptions/WithStatusCodePropertyException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Exceptions;
 3 | 
 4 | class WithStatusCodePropertyException extends \Exception
 5 | {
 6 | 
 7 |     /**
 8 |      * @var int
 9 |      */
10 |     public $httpStatusCode = 418;
11 | 
12 | }
13 | 


--------------------------------------------------------------------------------
/tests/Helpers/Http/KernelWithRemoveMiddlewareMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Czim\CmsCore\Test\Helpers\Http;
 4 | 
 5 | use Illuminate\Foundation\Http\Kernel;
 6 | 
 7 | class KernelWithRemoveMiddlewareMethod extends Kernel
 8 | {
 9 | 
10 |     /**
11 |      * Removes all global middleware registered.
12 |      */
13 |     public function removeGlobalMiddleware()
14 |     {
15 |         $this->middleware = [];
16 |     }
17 | 
18 | }
19 | 


--------------------------------------------------------------------------------
/tests/Helpers/Http/MockRequest.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Test\Helpers\Http;
3 | 
4 | class MockRequest
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/tests/Helpers/Http/NullMiddleware.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Http;
 3 | 
 4 | use Closure;
 5 | use Illuminate\Http\Request;
 6 | 
 7 | /**
 8 |  * Class NullMiddleware
 9 |  *
10 |  * A middleware class that does nothing.
11 |  */
12 | class NullMiddleware
13 | {
14 | 
15 |     /**
16 |      * @param Request $request
17 |      * @param Closure $next
18 |      * @return mixed
19 |      */
20 |     public function handle($request, Closure $next)
21 |     {
22 |         return $next($request);
23 |     }
24 | 
25 | }
26 | 


--------------------------------------------------------------------------------
/tests/Helpers/Listeners/TestEventListener.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Listeners;
 3 | 
 4 | /**
 5 |  * Class TestEventListener
 6 |  *
 7 |  * @see \Czim\CmsCore\Test\Providers\EventServiceProviderTest
 8 |  */
 9 | class TestEventListener
10 | {
11 | 
12 |     public function triggered()
13 |     {
14 |         // Bind something in the app to perform a simple assertion on in the test
15 |         app()->instance('testing.listened', true);
16 |     }
17 | 
18 | }
19 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/SimpleAssociatedTestModule.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Test\Helpers\Modules;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
  7 | use Czim\CmsCore\Modules\ModuleManager;
  8 | use Illuminate\Routing\Router;
  9 | 
 10 | class SimpleAssociatedTestModule implements ModuleInterface
 11 | {
 12 | 
 13 |     /**
 14 |      * Returns unique identifying key for the module.
 15 |      * This should also be able to perform as a slug for it.
 16 |      *
 17 |      * @return string
 18 |      */
 19 |     public function getKey(): string
 20 |     {
 21 |         return 'associated-test-module';
 22 |     }
 23 | 
 24 |     /**
 25 |      * Returns display name for the module.
 26 |      *
 27 |      * @return string
 28 |      */
 29 |     public function getName(): string
 30 |     {
 31 |         return 'Test Associated Module';
 32 |     }
 33 | 
 34 |     /**
 35 |      * Returns the FQN for a class mainly associated with this module.
 36 |      *
 37 |      * @return string|null
 38 |      */
 39 |     public function getAssociatedClass(): ?string
 40 |     {
 41 |         return ModuleManager::class;
 42 |     }
 43 | 
 44 |     /**
 45 |      * Returns a list of FQNs for service providers that should always be registered.
 46 |      *
 47 |      * @return string[]
 48 |      */
 49 |     public function getServiceProviders(): array
 50 |     {
 51 |         return [];
 52 |     }
 53 | 
 54 |     /**
 55 |      * Generates web routes for the module given a contextual router instance.
 56 |      * Note that the module is responsible for ACL-checks, including route-based.
 57 |      *
 58 |      * @param Router $router
 59 |      */
 60 |     public function mapWebRoutes(Router $router): void
 61 |     {
 62 |     }
 63 | 
 64 |     /**
 65 |      * Generates API routes for the module given a contextual router instance.
 66 |      * Note that the module is responsible for ACL-checks, including route-based.
 67 |      *
 68 |      * @param Router $router
 69 |      */
 70 |     public function mapApiRoutes(Router $router): void
 71 |     {
 72 |     }
 73 | 
 74 |     /**
 75 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
 76 |      */
 77 |     public function getAclPresence()
 78 |     {
 79 |         return null;
 80 |     }
 81 | 
 82 |     /**
 83 |      * Returns data for CMS menu presence.
 84 |      *
 85 |      * @return null|array|MenuPresenceInterface[]|MenuPresenceInterface[]
 86 |      */
 87 |     public function getMenuPresence()
 88 |     {
 89 |         return null;
 90 |     }
 91 | 
 92 |     /**
 93 |      * Returns release or version number of module.
 94 |      *
 95 |      * @return string
 96 |      */
 97 |     public function getVersion(): string
 98 |     {
 99 |         return '1.0.0';
100 |     }
101 | 
102 | }
103 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/SimpleTestModule.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Test\Helpers\Modules;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
  7 | use Illuminate\Routing\Router;
  8 | 
  9 | class SimpleTestModule implements ModuleInterface
 10 | {
 11 | 
 12 |     /**
 13 |      * Returns unique identifying key for the module.
 14 |      * This should also be able to perform as a slug for it.
 15 |      *
 16 |      * @return string
 17 |      */
 18 |     public function getKey(): string
 19 |     {
 20 |         return 'test-module';
 21 |     }
 22 | 
 23 |     /**
 24 |      * Returns display name for the module.
 25 |      *
 26 |      * @return string
 27 |      */
 28 |     public function getName(): string
 29 |     {
 30 |         return 'Test Module';
 31 |     }
 32 | 
 33 |     /**
 34 |      * Returns the FQN for a class mainly associated with this module.
 35 |      *
 36 |      * @return string|null
 37 |      */
 38 |     public function getAssociatedClass(): ?string
 39 |     {
 40 |         return null;
 41 |     }
 42 | 
 43 |     /**
 44 |      * Returns a list of FQNs for service providers that should always be registered.
 45 |      *
 46 |      * @return string[]
 47 |      */
 48 |     public function getServiceProviders(): array
 49 |     {
 50 |         return [];
 51 |     }
 52 | 
 53 |     /**
 54 |      * Generates web routes for the module given a contextual router instance.
 55 |      * Note that the module is responsible for ACL-checks, including route-based.
 56 |      *
 57 |      * @param Router $router
 58 |      */
 59 |     public function mapWebRoutes(Router $router): void
 60 |     {
 61 | 
 62 |     }
 63 | 
 64 |     /**
 65 |      * Generates API routes for the module given a contextual router instance.
 66 |      * Note that the module is responsible for ACL-checks, including route-based.
 67 |      *
 68 |      * @param Router $router
 69 |      */
 70 |     public function mapApiRoutes(Router $router): void
 71 |     {
 72 | 
 73 |     }
 74 | 
 75 |     /**
 76 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
 77 |      */
 78 |     public function getAclPresence()
 79 |     {
 80 |         return null;
 81 |     }
 82 | 
 83 |     /**
 84 |      * Returns data for CMS menu presence.
 85 |      *
 86 |      * @return null|array|MenuPresenceInterface[]|MenuPresenceInterface[]
 87 |      */
 88 |     public function getMenuPresence()
 89 |     {
 90 |         return null;
 91 |     }
 92 | 
 93 |     /**
 94 |      * Returns release or version number of module.
 95 |      *
 96 |      * @return string
 97 |      */
 98 |     public function getVersion(): string
 99 |     {
100 |         return '1.0.0';
101 |     }
102 | 
103 | }
104 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/SimpleTestModuleGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Modules;
 3 | 
 4 | use Czim\CmsCore\Contracts\Modules\ModuleGeneratorInterface;
 5 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
 6 | use Illuminate\Support\Collection;
 7 | 
 8 | class SimpleTestModuleGenerator implements ModuleGeneratorInterface
 9 | {
10 | 
11 |     /**
12 |      * Generates and returns module instances.
13 |      *
14 |      * @return Collection|ModuleInterface[]
15 |      */
16 |     public function modules(): Collection
17 |     {
18 |         return new Collection([
19 |             new SimpleTestModule(),
20 |             new SimpleAssociatedTestModule(),
21 |         ]);
22 |     }
23 | 
24 | }
25 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/SimpleTestModuleWithSameServiceProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Test\Helpers\Modules;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
  7 | use Illuminate\Routing\Router;
  8 | 
  9 | class SimpleTestModuleWithSameServiceProvider implements ModuleInterface
 10 | {
 11 | 
 12 |     /**
 13 |      * Returns unique identifying key for the module.
 14 |      * This should also be able to perform as a slug for it.
 15 |      *
 16 |      * @return string
 17 |      */
 18 |     public function getKey(): string
 19 |     {
 20 |         return 'test-module-with-the-same-service-provider';
 21 |     }
 22 | 
 23 |     /**
 24 |      * Returns display name for the module.
 25 |      *
 26 |      * @return string
 27 |      */
 28 |     public function getName(): string
 29 |     {
 30 |         return 'Test Module With Service Providers (2)';
 31 |     }
 32 | 
 33 |     /**
 34 |      * Returns the FQN for a class mainly associated with this module.
 35 |      *
 36 |      * @return string|null
 37 |      */
 38 |     public function getAssociatedClass(): ?string
 39 |     {
 40 |         return null;
 41 |     }
 42 | 
 43 |     /**
 44 |      * Returns a list of FQNs for service providers that should always be registered.
 45 |      *
 46 |      * @return string[]
 47 |      */
 48 |     public function getServiceProviders(): array
 49 |     {
 50 |         return [
 51 |             'ServiceProvider\\That\\Does\\Not\\Exist',
 52 |         ];
 53 |     }
 54 | 
 55 |     /**
 56 |      * Generates web routes for the module given a contextual router instance.
 57 |      * Note that the module is responsible for ACL-checks, including route-based.
 58 |      *
 59 |      * @param Router $router
 60 |      */
 61 |     public function mapWebRoutes(Router $router): void
 62 |     {
 63 |     }
 64 | 
 65 |     /**
 66 |      * Generates API routes for the module given a contextual router instance.
 67 |      * Note that the module is responsible for ACL-checks, including route-based.
 68 |      *
 69 |      * @param Router $router
 70 |      */
 71 |     public function mapApiRoutes(Router $router): void
 72 |     {
 73 |     }
 74 | 
 75 |     /**
 76 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
 77 |      */
 78 |     public function getAclPresence()
 79 |     {
 80 |         return null;
 81 |     }
 82 | 
 83 |     /**
 84 |      * Returns data for CMS menu presence.
 85 |      *
 86 |      * @return null|array|MenuPresenceInterface[]|MenuPresenceInterface[]
 87 |      */
 88 |     public function getMenuPresence()
 89 |     {
 90 |         return null;
 91 |     }
 92 | 
 93 |     /**
 94 |      * Returns release or version number of module.
 95 |      *
 96 |      * @return string
 97 |      */
 98 |     public function getVersion(): string
 99 |     {
100 |         return '1.0.0';
101 |     }
102 | 
103 | }
104 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/SimpleTestModuleWithServiceProviders.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Test\Helpers\Modules;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
  7 | use Czim\CmsCore\Modules\ModuleManager;
  8 | use Illuminate\Routing\Router;
  9 | 
 10 | class SimpleTestModuleWithServiceProviders implements ModuleInterface
 11 | {
 12 | 
 13 |     /**
 14 |      * Returns unique identifying key for the module.
 15 |      * This should also be able to perform as a slug for it.
 16 |      *
 17 |      * @return string
 18 |      */
 19 |     public function getKey(): string
 20 |     {
 21 |         return 'test-module-with-service-providers';
 22 |     }
 23 | 
 24 |     /**
 25 |      * Returns display name for the module.
 26 |      *
 27 |      * @return string
 28 |      */
 29 |     public function getName(): string
 30 |     {
 31 |         return 'Test Module With Service Providers';
 32 |     }
 33 | 
 34 |     /**
 35 |      * Returns the FQN for a class mainly associated with this module.
 36 |      *
 37 |      * @return string|null
 38 |      */
 39 |     public function getAssociatedClass(): ?string
 40 |     {
 41 |         return ModuleManager::class;
 42 |     }
 43 | 
 44 |     /**
 45 |      * Returns a list of FQNs for service providers that should always be registered.
 46 |      *
 47 |      * @return string[]
 48 |      */
 49 |     public function getServiceProviders(): array
 50 |     {
 51 |         return [
 52 |             'ServiceProvider\\That\\Does\\Not\\Exist',
 53 |             'Another\\Registered\\ServiceProvider',
 54 |         ];
 55 |     }
 56 | 
 57 |     /**
 58 |      * Generates web routes for the module given a contextual router instance.
 59 |      * Note that the module is responsible for ACL-checks, including route-based.
 60 |      *
 61 |      * @param Router $router
 62 |      */
 63 |     public function mapWebRoutes(Router $router): void
 64 |     {
 65 |     }
 66 | 
 67 |     /**
 68 |      * Generates API routes for the module given a contextual router instance.
 69 |      * Note that the module is responsible for ACL-checks, including route-based.
 70 |      *
 71 |      * @param Router $router
 72 |      */
 73 |     public function mapApiRoutes(Router $router): void
 74 |     {
 75 |     }
 76 | 
 77 |     /**
 78 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
 79 |      */
 80 |     public function getAclPresence()
 81 |     {
 82 |         return null;
 83 |     }
 84 | 
 85 |     /**
 86 |      * Returns data for CMS menu presence.
 87 |      *
 88 |      * @return null|array|MenuPresenceInterface[]|MenuPresenceInterface[]
 89 |      */
 90 |     public function getMenuPresence()
 91 |     {
 92 |         return null;
 93 |     }
 94 | 
 95 |     /**
 96 |      * Returns release or version number of module.
 97 |      *
 98 |      * @return string
 99 |      */
100 |     public function getVersion(): string
101 |     {
102 |         return '1.0.0';
103 |     }
104 | 
105 | }
106 | 


--------------------------------------------------------------------------------
/tests/Helpers/Modules/TestModuleWithRoutes.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Czim\CmsCore\Test\Helpers\Modules;
  3 | 
  4 | use Czim\CmsCore\Contracts\Modules\Data\AclPresenceInterface;
  5 | use Czim\CmsCore\Contracts\Modules\Data\MenuPresenceInterface;
  6 | use Czim\CmsCore\Contracts\Modules\ModuleInterface;
  7 | use Illuminate\Routing\Router;
  8 | 
  9 | class TestModuleWithRoutes implements ModuleInterface
 10 | {
 11 | 
 12 |     /**
 13 |      * Returns unique identifying key for the module.
 14 |      * This should also be able to perform as a slug for it.
 15 |      *
 16 |      * @return string
 17 |      */
 18 |     public function getKey(): string
 19 |     {
 20 |         return 'test-module-with-routes';
 21 |     }
 22 | 
 23 |     /**
 24 |      * Returns display name for the module.
 25 |      *
 26 |      * @return string
 27 |      */
 28 |     public function getName(): string
 29 |     {
 30 |         return 'Test Module With Routes';
 31 |     }
 32 | 
 33 |     /**
 34 |      * Returns the FQN for a class mainly associated with this module.
 35 |      *
 36 |      * @return string|null
 37 |      */
 38 |     public function getAssociatedClass(): ?string
 39 |     {
 40 |         return null;
 41 |     }
 42 | 
 43 |     /**
 44 |      * Returns a list of FQNs for service providers that should always be registered.
 45 |      *
 46 |      * @return string[]
 47 |      */
 48 |     public function getServiceProviders(): array
 49 |     {
 50 |         return [];
 51 |     }
 52 | 
 53 |     /**
 54 |      * Generates web routes for the module given a contextual router instance.
 55 |      * Note that the module is responsible for ACL-checks, including route-based.
 56 |      *
 57 |      * @param Router $router
 58 |      */
 59 |     public function mapWebRoutes(Router $router): void
 60 |     {
 61 |         $router->get('test', 'SomeController@index');
 62 |         $router->post('test', 'SomeController@store');
 63 |     }
 64 | 
 65 |     /**
 66 |      * Generates API routes for the module given a contextual router instance.
 67 |      * Note that the module is responsible for ACL-checks, including route-based.
 68 |      *
 69 |      * @param Router $router
 70 |      */
 71 |     public function mapApiRoutes(Router $router): void
 72 |     {
 73 |         $router->get('test', 'SomeApiController@index');
 74 |         $router->post('test', 'SomeApiController@store');
 75 |     }
 76 | 
 77 |     /**
 78 |      * @return null|array|AclPresenceInterface|AclPresenceInterface[]
 79 |      */
 80 |     public function getAclPresence()
 81 |     {
 82 |         return null;
 83 |     }
 84 | 
 85 |     /**
 86 |      * Returns data for CMS menu presence.
 87 |      *
 88 |      * @return null|array|MenuPresenceInterface[]|MenuPresenceInterface[]
 89 |      */
 90 |     public function getMenuPresence()
 91 |     {
 92 |         return null;
 93 |     }
 94 | 
 95 |     /**
 96 |      * Returns release or version number of module.
 97 |      *
 98 |      * @return string
 99 |      */
100 |     public function getVersion(): string
101 |     {
102 |         return '1.0.0';
103 |     }
104 | 
105 | }
106 | 


--------------------------------------------------------------------------------
/tests/Helpers/NonInstantiableClassWithDependency.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers;
 3 | 
 4 | class NonInstantiableClassWithDependency
 5 | {
 6 | 
 7 |     public function __construct(Does\Not\Exist $dependency)
 8 |     {
 9 |     }
10 | 
11 | }
12 | 


--------------------------------------------------------------------------------
/tests/Helpers/NonInstantiableInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Test\Helpers;
3 | 
4 | interface NonInstantiableInterface
5 | {
6 | 
7 | }
8 | 


--------------------------------------------------------------------------------
/tests/Helpers/Providers/TestViewsServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Providers;
 3 | 
 4 | use Illuminate\Support\ServiceProvider;
 5 | 
 6 | class TestViewsServiceProvider extends ServiceProvider
 7 | {
 8 | 
 9 |     public function boot()
10 |     {
11 |     }
12 | 
13 |     public function register()
14 |     {
15 |         $this->loadViewsFrom(
16 |             realpath(dirname(__DIR__) . '/resources/views'),
17 |             'cms-test'
18 |         );
19 |     }
20 | 
21 | }
22 | 


--------------------------------------------------------------------------------
/tests/Helpers/Spies/CacheSpy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Spies;
 3 | 
 4 | /**
 5 |  * Class CacheSpy
 6 |  *
 7 |  * Helper class to spy on initialization, since mocks + container
 8 |  * bindings are not able to perform expectation checks in succession.
 9 |  *
10 |  * @see \Czim\CmsCore\Test\Core\CacheTest
11 |  */
12 | class CacheSpy
13 | {
14 |     public $storeCalled = 0;
15 |     public $storeParameter;
16 | 
17 |     public $tagsCalled = 0;
18 |     public $tagsParameter;
19 | 
20 |     /**
21 |      * @param mixed $parameter
22 |      * @return $this
23 |      */
24 |     public function store($parameter): CacheSpy
25 |     {
26 |         $this->storeParameter = $parameter;
27 |         $this->storeCalled++;
28 | 
29 |         return $this;
30 |     }
31 | 
32 |     /**
33 |      * @param mixed $parameter
34 |      * @return $this
35 |      */
36 |     public function tags($parameter): CacheSpy
37 |     {
38 |         $this->tagsParameter = $parameter;
39 |         $this->tagsCalled++;
40 | 
41 |         return $this;
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/tests/Helpers/Spies/SessionSpy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Spies;
 3 | 
 4 | use Illuminate\Support\Arr;
 5 | 
 6 | /**
 7 |  * Class SessionSpy
 8 |  *
 9 |  * @see \Czim\CmsCore\Test\Core\BasicNotifierTest
10 |  */
11 | class SessionSpy
12 | {
13 |     /**
14 |      * @var array
15 |      */
16 |     public $stored = [];
17 | 
18 | 
19 |     /**
20 |      * @param string $key
21 |      * @param mixed $default
22 |      * @return mixed
23 |      */
24 |     public function get(string $key, $default)
25 |     {
26 |         return Arr::get($this->stored, $key, $default);
27 |     }
28 | 
29 |     /**
30 |      * @param string $key
31 |      * @param mixed  $value
32 |      */
33 |     public function put(string $key, $value): void
34 |     {
35 |         Arr::set($this->stored, $key, $value);
36 |     }
37 | 
38 |     /**
39 |      * @param string $key
40 |      * @return bool
41 |      */
42 |     public function has(string $key): bool
43 |     {
44 |         return Arr::has($this->stored, $key);
45 |     }
46 | 
47 |     /**
48 |      * @param string $key
49 |      */
50 |     public function remove(string $key): void
51 |     {
52 |         Arr::forget($this->stored, $key);
53 |     }
54 | 
55 | }
56 | 


--------------------------------------------------------------------------------
/tests/Helpers/Support/AnotherTestDataObject.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Support;
 3 | 
 4 | use Czim\CmsCore\Support\Data\AbstractDataObject;
 5 | 
 6 | /**
 7 |  * Class AnotherTestDataObject
 8 |  *
 9 |  * @property mixed $key
10 |  * @property mixed $value
11 |  */
12 | class AnotherTestDataObject extends AbstractDataObject
13 | {
14 |     /**
15 |      * Test merge method.
16 |      *
17 |      * To be called while performing merges on attribute of TestDataObject.
18 |      *
19 |      * @param AnotherTestDataObject $new
20 |      */
21 |     public function merge(AnotherTestDataObject $new): void
22 |     {
23 |         $this->key   = $new->key   ?: $this->key;
24 |         $this->value = $new->value ?: $this->value;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/tests/Helpers/Support/BasicDataObject.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace Czim\CmsCore\Test\Helpers\Support;
3 | 
4 | use Czim\CmsCore\Support\Data\AbstractDataObject;
5 | 
6 | class BasicDataObject extends AbstractDataObject
7 | {
8 | }
9 | 


--------------------------------------------------------------------------------
/tests/Helpers/Support/TestDataObject.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test\Helpers\Support;
 3 | 
 4 | use Czim\CmsCore\Support\Data\AbstractDataObject;
 5 | 
 6 | /**
 7 |  * Class TestDataObject
 8 |  *
 9 |  * @property mixed $some
10 |  * @property mixed $that
11 |  * @property mixed $set
12 |  * @property TestDataObject $test
13 |  * @property AnotherTestDataObject $other
14 |  * @property AnotherTestDataObject[] $others
15 |  */
16 | class TestDataObject extends AbstractDataObject
17 | {
18 |     protected $objects = [
19 |         'test'   => self::class,
20 |         'other'  => AnotherTestDataObject::class,
21 |         'others' => AnotherTestDataObject::class . '[]',
22 |     ];
23 | 
24 |     /**
25 |      * Passthru for testing mergeAttribute method.
26 |      *
27 |      * @param string $attribute
28 |      * @param mixed  $newValue
29 |      */
30 |     public function testMerge(string $attribute, $newValue): void
31 |     {
32 |         $this->mergeAttribute($attribute, $newValue);
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/tests/Helpers/migrations/DatabaseSeeder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Seeder;
 4 | use Illuminate\Support\Facades\DB;
 5 | 
 6 | class DatabaseSeeder extends Seeder
 7 | {
 8 | 
 9 | 
10 |     /**
11 |      * Run the database seeds.
12 |      *
13 |      * @return void
14 |      */
15 |     public function run()
16 |     {
17 |         DB::connection('testbench')
18 |             ->table('cms_test_records')
19 |             ->insert([
20 |                 'id'          => 1,
21 |                 'description' => 'testing!',
22 |                 'created_at'  => '2017-01-01 00:00:00',
23 |                 'updated_at'  => '2017-01-01 00:00:00',
24 |             ]);
25 |     }
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/tests/Helpers/migrations/alt/2017_01_01_300000_create_test_alternative_records_table.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Czim\CmsCore\Support\Database\CmsMigration;
 4 | use Illuminate\Database\Schema\Blueprint;
 5 | use Illuminate\Support\Facades\Schema;
 6 | 
 7 | class CreateTestAlternativeRecordsTable extends CmsMigration
 8 | {
 9 | 
10 |     public function up()
11 |     {
12 |         Schema::create($this->prefixCmsTable('test_alternative_records'), function (Blueprint $table) {
13 |             $table->string('id')->primary();
14 |         });
15 |     }
16 | 
17 |     public function down()
18 |     {
19 |         Schema::drop($this->prefixCmsTable('test_alternative_records'));
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/tests/Helpers/migrations/cms/2017_01_01_100000_create_test_records_table.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Czim\CmsCore\Support\Database\CmsMigration;
 4 | use Illuminate\Database\Schema\Blueprint;
 5 | use Illuminate\Support\Facades\Schema;
 6 | 
 7 | class CreateTestRecordsTable extends CmsMigration
 8 | {
 9 | 
10 |     public function up()
11 |     {
12 |         Schema::create($this->prefixCmsTable('test_records'), function (Blueprint $table) {
13 |             $table->string('id')->primary();
14 |             $table->string('description');
15 |             $table->nullableTimestamps();
16 |         });
17 |     }
18 | 
19 |     public function down()
20 |     {
21 |         Schema::drop($this->prefixCmsTable('test_records'));
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/tests/Helpers/migrations/cms/2017_01_01_200000_create_more_test_records_table.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Czim\CmsCore\Support\Database\CmsMigration;
 4 | use Illuminate\Database\Schema\Blueprint;
 5 | use Illuminate\Support\Facades\Schema;
 6 | 
 7 | class CreateMoreTestRecordsTable extends CmsMigration
 8 | {
 9 | 
10 |     public function up()
11 |     {
12 |         Schema::create($this->prefixCmsTable('more_test_records'), function (Blueprint $table) {
13 |             $table->string('id')->primary();
14 |         });
15 |     }
16 | 
17 |     public function down()
18 |     {
19 |         Schema::drop($this->prefixCmsTable('more_test_records'));
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/tests/Helpers/resources/views/blade_cms_script.blade.php:
--------------------------------------------------------------------------------
1 | @cms_script
2 | testing!
3 | @cms_endscript
4 | 


--------------------------------------------------------------------------------
/tests/Helpers/resources/views/blade_cms_scriptasset.blade.php:
--------------------------------------------------------------------------------
1 | @cms_scriptasset('/testing/path')
2 | 


--------------------------------------------------------------------------------
/tests/Helpers/resources/views/blade_cms_scriptassethead.blade.php:
--------------------------------------------------------------------------------
1 | @cms_scriptassethead('/testing/path')
2 | 


--------------------------------------------------------------------------------
/tests/Helpers/resources/views/blade_cms_scriptonce.blade.php:
--------------------------------------------------------------------------------
1 | @cms_scriptonce
2 | testing!
3 | @cms_endscriptonce
4 | 


--------------------------------------------------------------------------------
/tests/Helpers/resources/views/blade_cms_style.blade.php:
--------------------------------------------------------------------------------
1 | @cms_style('/testing/path')
2 | 


--------------------------------------------------------------------------------
/tests/Http/Controllers/DefaultControllerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Controllers;
 6 | 
 7 | use Czim\CmsCore\Http\Controllers\DefaultController;
 8 | use Czim\CmsCore\Support\Enums\Component;
 9 | use Czim\CmsCore\Test\CmsBootTestCase;
10 | use Illuminate\Contracts\View\Factory;
11 | use Mockery;
12 | use Mockery\Mock;
13 | use Mockery\MockInterface;
14 | 
15 | class DefaultControllerTest extends CmsBootTestCase
16 | {
17 | 
18 |     /**
19 |      * @test
20 |      */
21 |     function it_returns_a_default_blank_view()
22 |     {
23 |         $controller = new DefaultController($this->app[Component::CORE]);
24 | 
25 |         /** @var Factory|Mock|MockInterface $viewMock */
26 |         $viewMock = Mockery::mock(Factory::class);
27 | 
28 |         $viewMock->shouldReceive('make')->with('cms::blank.index', [], [])->andReturn('testing');
29 | 
30 |         $this->app->instance(Factory::class, $viewMock);
31 | 
32 |         static::assertEquals('testing', $controller->index());
33 |     }
34 | 
35 | }
36 | 


--------------------------------------------------------------------------------
/tests/Http/Controllers/LocaleControllerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Controllers;
 6 | 
 7 | use Czim\CmsCore\Contracts\Support\Localization\LocaleRepositoryInterface;
 8 | use Czim\CmsCore\Http\Controllers\LocaleController;
 9 | use Czim\CmsCore\Http\Requests\SetLocaleRequest;
10 | use Czim\CmsCore\Support\Enums\Component;
11 | use Czim\CmsCore\Test\CmsBootTestCase;
12 | use Illuminate\Http\RedirectResponse;
13 | use Mockery;
14 | 
15 | class LocaleControllerTest extends CmsBootTestCase
16 | {
17 | 
18 |     /**
19 |      * @test
20 |      */
21 |     function it_sets_an_available_locale()
22 |     {
23 |         /** @var LocaleRepositoryInterface|Mockery\Mock|Mockery\MockInterface $repositoryMock */
24 |         /** @var SetLocaleRequest|Mockery\Mock|Mockery\MockInterface $requestMock */
25 |         $repositoryMock = Mockery::mock(LocaleRepositoryInterface::class);
26 |         $requestMock    = Mockery::mock(SetLocaleRequest::class);
27 | 
28 |         $repositoryMock->shouldReceive('isAvailable')
29 |             ->atLeast()->once()
30 |             ->with('nl')
31 |             ->andReturn(true);
32 | 
33 |         $requestMock->shouldReceive('input')
34 |             ->atLeast()->once()
35 |             ->with('locale')
36 |             ->andReturn('nl');
37 | 
38 |         $controller = new LocaleController($this->app[Component::CORE], $repositoryMock);
39 | 
40 |         /** @var RedirectResponse $return */
41 |         $return = $controller->setLocale($requestMock);
42 | 
43 |         static::assertInstanceOf(RedirectResponse::class, $return);
44 | 
45 |         static::assertEquals('nl', session()->get('cms::locale'));
46 |     }
47 | 
48 |     /**
49 |      * @test
50 |      */
51 |     function it_redirects_if_locale_to_set_is_unavailable()
52 |     {
53 |         /** @var LocaleRepositoryInterface|Mockery\Mock|Mockery\MockInterface $repositoryMock */
54 |         /** @var SetLocaleRequest|Mockery\Mock|Mockery\MockInterface $requestMock */
55 |         $repositoryMock = Mockery::mock(LocaleRepositoryInterface::class);
56 |         $requestMock    = Mockery::mock(SetLocaleRequest::class);
57 | 
58 |         $repositoryMock->shouldReceive('isAvailable')
59 |             ->atLeast()->once()
60 |             ->with('nl')
61 |             ->andReturn(false);
62 | 
63 |         $requestMock->shouldReceive('input')
64 |             ->atLeast()->once()
65 |             ->with('locale')
66 |             ->andReturn('nl');
67 | 
68 |         $controller = new LocaleController($this->app[Component::CORE], $repositoryMock);
69 | 
70 |         /** @var RedirectResponse $return */
71 |         $return = $controller->setLocale($requestMock);
72 | 
73 |         static::assertInstanceOf(RedirectResponse::class, $return);
74 | 
75 |         static::assertFalse(session()->has('cms::locale'));
76 |     }
77 | 
78 | }
79 | 


--------------------------------------------------------------------------------
/tests/Http/Middleware/Api/AuthenticateTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Middleware\Api;
 6 | 
 7 | use Czim\CmsCore\Contracts\Api\ApiCoreInterface;
 8 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 9 | use Czim\CmsCore\Http\Middleware\Api\Authenticate;
10 | use Czim\CmsCore\Support\Enums\Component;
11 | use Czim\CmsCore\Test\Helpers\Http\MockRequest;
12 | use Czim\CmsCore\Test\TestCase;
13 | use Hamcrest\Matchers;
14 | use Illuminate\Http\Request;
15 | use Illuminate\Http\Response;
16 | use Mockery;
17 | use Mockery\Mock;
18 | use Mockery\MockInterface;
19 | 
20 | class AuthenticateTest extends TestCase
21 | {
22 | 
23 |     /**
24 |      * @test
25 |      */
26 |     function it_passes_through_if_authenticated()
27 |     {
28 |         /** @var AuthenticatorInterface|Mock|MockInterface $authMock */
29 |         /** @var Request|Mock|MockInterface $requestMock */
30 |         $authMock    = Mockery::mock(AuthenticatorInterface::class);
31 |         $requestMock = Mockery::mock(Request::class);
32 | 
33 |         $authMock->shouldReceive('check')->once()->andReturn(true);
34 | 
35 |         $middleware = new Authenticate($authMock);
36 | 
37 |         $next = function ($request) {
38 |             return $request;
39 |         };
40 | 
41 |         static::assertSame($requestMock, $middleware->handle($requestMock, $next));
42 |     }
43 | 
44 |     /**
45 |      * @test
46 |      */
47 |     function it_returns_unauthorized_response_if_not_authenticated_for_ajax_request()
48 |     {
49 |         /** @var ApiCoreInterface|Mock|MockInterface $apiMock */
50 |         /** @var AuthenticatorInterface|Mock|MockInterface $authMock */
51 |         /** @var MockRequest|Mock|MockInterface $requestMock */
52 |         $apiMock     = Mockery::mock(ApiCoreInterface::class);
53 |         $authMock    = Mockery::mock(AuthenticatorInterface::class);
54 |         $requestMock = Mockery::mock(MockRequest::class);
55 | 
56 |         $authMock->shouldReceive('check')->once()->andReturn(false);
57 |         $requestMock->shouldReceive('ajax')->andReturn(true);
58 |         $requestMock->shouldReceive('wantsJson')->andReturn(true);
59 | 
60 |         $apiMock->shouldReceive('response')->once()
61 |             ->with(Matchers::anything(), 401)
62 |             ->andReturn('testing-response');
63 | 
64 |         $this->app->instance(Component::API, $apiMock);
65 | 
66 |         $middleware = new Authenticate($authMock);
67 | 
68 |         $next = function ($request) {
69 |             return $request;
70 |         };
71 | 
72 |         /** @var Response $response */
73 |         $response = $middleware->handle($requestMock, $next);
74 | 
75 |         static::assertEquals('testing-response', $response);
76 |     }
77 | 
78 | }
79 | 


--------------------------------------------------------------------------------
/tests/Http/Middleware/InitializeMenuTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Middleware;
 6 | 
 7 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 8 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
 9 | use Czim\CmsCore\Http\Middleware\InitializeMenu;
10 | use Czim\CmsCore\Test\TestCase;
11 | use Illuminate\Http\Request;
12 | use Mockery;
13 | 
14 | class InitializeMenuTest extends TestCase
15 | {
16 | 
17 |     /**
18 |      * @test
19 |      */
20 |     function it_initializes_the_menu()
21 |     {
22 |         /** @var CoreInterface|Mockery\Mock|Mockery\MockInterface $coreMock */
23 |         /** @var MenuRepositoryInterface|Mockery\Mock|Mockery\MockInterface $menuMock */
24 |         /** @var Request|Mockery\Mock|Mockery\MockInterface $requestMock */
25 |         $coreMock    = Mockery::mock(CoreInterface::class);
26 |         $menuMock    = Mockery::mock(MenuRepositoryInterface::class);
27 |         $requestMock = Mockery::mock(Request::class);
28 | 
29 |         $menuMock->shouldReceive('initialize')->once();
30 | 
31 |         $coreMock->shouldReceive('menu')->atLeast()->once()->andReturn($menuMock);
32 | 
33 |         $middleware = new InitializeMenu($coreMock);
34 | 
35 |         $next = function ($request) {
36 |             return $request;
37 |         };
38 | 
39 |         static::assertSame($requestMock, $middleware->handle($requestMock, $next));
40 |     }
41 | 
42 | }
43 | 


--------------------------------------------------------------------------------
/tests/Http/Middleware/RedirectIfAuthenticatedTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Middleware;
 6 | 
 7 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 8 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 9 | use Czim\CmsCore\Contracts\Menu\MenuRepositoryInterface;
10 | use Czim\CmsCore\Http\Middleware\RedirectIfAuthenticated;
11 | use Czim\CmsCore\Support\Enums\Component;
12 | use Czim\CmsCore\Test\TestCase;
13 | use Illuminate\Http\RedirectResponse;
14 | use Illuminate\Http\Request;
15 | use Mockery;
16 | 
17 | class RedirectIfAuthenticatedTest extends TestCase
18 | {
19 | 
20 |     /**
21 |      * @test
22 |      */
23 |     function it_passes_through_if_not_authenticated()
24 |     {
25 |         /** @var MenuRepositoryInterface|Mockery\Mock|Mockery\MockInterface $menuMock */
26 |         /** @var Request|Mockery\Mock|Mockery\MockInterface $requestMock */
27 |         $authMock    = Mockery::mock(AuthenticatorInterface::class);
28 |         $requestMock = Mockery::mock(Request::class);
29 | 
30 |         $authMock->shouldReceive('check')->once()->andReturn(false);
31 | 
32 |         $middleware = new RedirectIfAuthenticated($authMock);
33 | 
34 |         $next = function ($request) {
35 |             return $request;
36 |         };
37 | 
38 |         static::assertSame($requestMock, $middleware->handle($requestMock, $next));
39 |     }
40 | 
41 |     /**
42 |      * @test
43 |      */
44 |     function it_redirects_if_authenticated_for_non_ajax_request()
45 |     {
46 |         /** @var AuthenticatorInterface|Mockery\Mock|Mockery\MockInterface $menuMock */
47 |         /** @var Request|Mockery\Mock|Mockery\MockInterface $requestMock */
48 |         /** @var CoreInterface|Mockery\Mock|Mockery\MockInterface $coreMock */
49 |         $authMock    = Mockery::mock(AuthenticatorInterface::class);
50 |         $requestMock = Mockery::mock(Request::class);
51 |         $coreMock    = Mockery::mock(CoreInterface::class);
52 | 
53 |         $authMock->shouldReceive('check')->once()->andReturn(true);
54 | 
55 |         // Register and fake the redirect route
56 |         $this->app['router']->get('testing/ignore', ['as' => 'testing', 'uses' => 'NoController@nowhere']);
57 |         $coreMock->shouldReceive('prefixRoute')->andReturn('testing');
58 | 
59 |         $this->app->instance(Component::CORE, $coreMock);
60 | 
61 |         $middleware = new RedirectIfAuthenticated($authMock);
62 | 
63 |         $next = function ($request) {
64 |             return $request;
65 |         };
66 | 
67 |         static::assertInstanceOf(RedirectResponse::class, $middleware->handle($requestMock, $next));
68 |     }
69 | 
70 | }
71 | 


--------------------------------------------------------------------------------
/tests/Http/ViewComposers/LocaleComposerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Http\Middleware;
 6 | 
 7 | use Czim\CmsCore\Contracts\Support\Localization\LocaleRepositoryInterface;
 8 | use Czim\CmsCore\Http\ViewComposers\LocaleComposer;
 9 | use Czim\CmsCore\Test\TestCase;
10 | use Illuminate\Contracts\View\View;
11 | use Mockery;
12 | use Mockery\Mock;
13 | use Mockery\MockInterface;
14 | 
15 | class LocaleComposerTest extends TestCase
16 | {
17 | 
18 |     /**
19 |      * @test
20 |      */
21 |     function it_composes_locale_data()
22 |     {
23 |         /** @var LocaleRepositoryInterface|Mock|MockInterface $repositoryMock */
24 |         /** @var View|Mock|MockInterface $viewMock */
25 |         $repositoryMock = Mockery::mock(LocaleRepositoryInterface::class);
26 |         $viewMock       = Mockery::mock(View::class);
27 | 
28 |         $viewMock->shouldReceive('with')->once()
29 |             ->with([
30 |                 'localized'        => true,
31 |                 'currentLocale'    => 'en',
32 |                 'availableLocales' => ['nl', 'en'],
33 |             ]);
34 | 
35 |         $repositoryMock->shouldReceive('isLocalized')->once()
36 |             ->andReturn(true);
37 | 
38 |         $repositoryMock->shouldReceive('getAvailable')->once()
39 |             ->andReturn(['nl', 'en']);
40 | 
41 |         $composer = new LocaleComposer($repositoryMock);
42 |         $composer->compose($viewMock);
43 |     }
44 | 
45 | }
46 | 


--------------------------------------------------------------------------------
/tests/Providers/BladeDirectivesTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Providers;
 6 | 
 7 | use Czim\CmsCore\Contracts\Core\CoreInterface;
 8 | use Czim\CmsCore\Contracts\Support\View\AssetManagerInterface;
 9 | use Czim\CmsCore\Providers\ViewServiceProvider;
10 | use Czim\CmsCore\Test\Helpers\Providers\TestViewsServiceProvider;
11 | use Czim\CmsCore\Test\TestCase;
12 | use Mockery;
13 | 
14 | class BladeDirectivesTest extends TestCase
15 | {
16 |     /**
17 |      * @var AssetManagerInterface|Mockery\Mock
18 |      */
19 |     protected $assetManager;
20 | 
21 |     /**
22 |      * {@inheritdoc}
23 |      */
24 |     protected function getEnvironmentSetUp($app): void
25 |     {
26 |         parent::getEnvironmentSetUp($app);
27 | 
28 |         $this->assetManager = Mockery::mock(AssetManagerInterface::class);
29 | 
30 |         /** @var CoreInterface|Mockery\Mock $core */
31 |         $core = Mockery::mock(CoreInterface::class);
32 |         $core->shouldReceive('assets')->andReturn($this->assetManager);
33 |         $core->shouldReceive('config')->andReturnUsing(function () { return func_get_args(); });
34 | 
35 |         $app->instance(CoreInterface::class, $core);
36 |         $app->instance(AssetManagerInterface::class, $this->assetManager);
37 | 
38 |         $app->register(TestViewsServiceProvider::class);
39 |         $app->register(ViewServiceProvider::class);
40 |     }
41 | 
42 |     /**
43 |      * @test
44 |      */
45 |     function it_features_cms_style_directive()
46 |     {
47 |         $this->assetManager->shouldReceive('registerStyleAsset')->with('/testing/path')->once();
48 | 
49 |         view('cms-test::blade_cms_style')->render();
50 |     }
51 | 
52 |     /**
53 |      * @test
54 |      */
55 |     function it_features_cms_scriptasset_directive()
56 |     {
57 |         $this->assetManager->shouldReceive('registerScriptAsset')->with('/testing/path')->once();
58 | 
59 |         view('cms-test::blade_cms_scriptasset')->render();
60 |     }
61 | 
62 |     /**
63 |      * @test
64 |      */
65 |     function it_features_cms_scriptassethead_directive()
66 |     {
67 |         $this->assetManager->shouldReceive('registerScriptAsset')->with('/testing/path', true)->once();
68 | 
69 |         view('cms-test::blade_cms_scriptassethead')->render();
70 |     }
71 | 
72 |     /**
73 |      * @test
74 |      */
75 |     function it_features_cms_script_block_directive()
76 |     {
77 |         $this->assetManager->shouldReceive('registerScript')->with("testing!\n", false)->once();
78 | 
79 |         view('cms-test::blade_cms_script')->render();
80 |     }
81 | 
82 |     /**
83 |      * @test
84 |      */
85 |     function it_features_cms_scriptonce_block_directive()
86 |     {
87 |         $this->assetManager->shouldReceive('registerScript')->with("testing!\n", true)->once();
88 | 
89 |         view('cms-test::blade_cms_scriptonce')->render();
90 |     }
91 | 
92 | }
93 | 


--------------------------------------------------------------------------------
/tests/Providers/EventServiceProviderTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Providers;
 6 | 
 7 | use Czim\CmsCore\Providers\EventServiceProvider;
 8 | use Czim\CmsCore\Test\TestCase;
 9 | 
10 | class EventServiceProviderTest extends TestCase
11 | {
12 | 
13 |     /**
14 |      * @test
15 |      */
16 |     function it_registers_configured_events()
17 |     {
18 |         $this->app['config']->set('cms-core.events', [
19 |             'testing.event.trigger' => [
20 |                 \Czim\CmsCore\Test\Helpers\Listeners\TestEventListener::class . '@triggered',
21 |             ],
22 |         ]);
23 | 
24 |         $provider = new EventServiceProvider($this->app);
25 |         $provider->register();
26 |         $provider->boot();
27 | 
28 |         event('testing.event.trigger');
29 | 
30 |         static::assertTrue($this->app->bound('testing.listened'), 'Event listener did not catch the test event');
31 |     }
32 | 
33 | }
34 | 


--------------------------------------------------------------------------------
/tests/Providers/TranslationServiceProviderTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Providers;
 6 | 
 7 | use Czim\CmsCore\Providers\TranslationServiceProvider;
 8 | use Czim\CmsCore\Support\Translation\CmsTranslator;
 9 | use Czim\CmsCore\Test\TestCase;
10 | 
11 | class TranslationServiceProviderTest extends TestCase
12 | {
13 | 
14 |     /**
15 |      * @test
16 |      */
17 |     function it_registers_the_cms_translator()
18 |     {
19 |         $provider = new TranslationServiceProvider($this->app);
20 |         $provider->register();
21 |         $provider->boot();
22 | 
23 |         static::assertTrue($this->app->bound('translator'));
24 |         static::assertInstanceOf(CmsTranslator::class, $this->app['translator']);
25 |     }
26 | 
27 |     /**
28 |      * @test
29 |      */
30 |     function it_reports_providing_translator()
31 |     {
32 |         $provider = new TranslationServiceProvider($this->app);
33 | 
34 |         static::assertEquals(['translator'], $provider->provides());
35 |     }
36 | 
37 | }
38 | 


--------------------------------------------------------------------------------
/tests/SimpleDbTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Czim\CmsCore\Test;
 4 | 
 5 | use Illuminate\Contracts\Config\Repository;
 6 | 
 7 | abstract class SimpleDbTestCase extends CmsBootTestCase
 8 | {
 9 | 
10 |     /**
11 |      * {@inheritdoc}
12 |      */
13 |     protected function getEnvironmentSetUp($app): void
14 |     {
15 |         parent::getEnvironmentSetUp($app);
16 | 
17 |         /** @var Repository $config */
18 |         $config = $app['config'];
19 | 
20 |         // Setup default database to use sqlite :memory:
21 |         $config->set('database.default', 'testbench');
22 |         $config->set('database.connections.testbench', [
23 |             'driver'   => 'sqlite',
24 |             'database' => ':memory:',
25 |             'prefix'   => '',
26 |         ]);
27 |     }
28 | 
29 |     /**
30 |      * Creates and verifies the cms migrations table.
31 |      */
32 |     protected function createMigrationTable(): void
33 |     {
34 |         $result = $this->artisan('cms:migrate:install');
35 | 
36 |         if ($result instanceof \Illuminate\Testing\PendingCommand) {
37 |             $result->assertExitCode(0);
38 |         } else {
39 |             static::assertEquals(0, $result);
40 |         }
41 |     }
42 | 
43 |     /**
44 |      * Sets the migrations cms path to a directory with test migrations.
45 |      */
46 |     protected function setHelperCmsMigrationPath(): void
47 |     {
48 |         $this->app['config']->set(
49 |             'cms-core.database.migrations.path',
50 |             '../../../../../tests/Helpers/migrations/cms'
51 |         );
52 |     }
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/tests/Support/Data/Menu/LayoutDataTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
  3 | /** @noinspection AccessModifierPresentedInspection */
  4 | 
  5 | namespace Czim\CmsCore\Test\Support\Data\Menu;
  6 | 
  7 | use Czim\CmsCore\Support\Data\Menu\LayoutData;
  8 | use Czim\CmsCore\Support\Data\Menu\LayoutGroupData;
  9 | use Czim\CmsCore\Test\CmsBootTestCase;
 10 | 
 11 | class LayoutDataTest extends CmsBootTestCase
 12 | {
 13 | 
 14 |     /**
 15 |      * @test
 16 |      */
 17 |     function it_returns_layout()
 18 |     {
 19 |         $data = new LayoutData;
 20 |         $data->layout = ['test'];
 21 | 
 22 |         static::assertEquals(['test'], $data->layout());
 23 |     }
 24 | 
 25 |     /**
 26 |      * @test
 27 |      */
 28 |     function it_returns_empty_array_as_default_for_layout()
 29 |     {
 30 |         $data = new LayoutData;
 31 | 
 32 |         static::assertEquals([], $data->layout());
 33 |     }
 34 | 
 35 |     /**
 36 |      * @test
 37 |      */
 38 |     function it_forces_empty_array_for_direct_layout_access()
 39 |     {
 40 |         $data = new LayoutData;
 41 | 
 42 |         $data->layout = null;
 43 | 
 44 |         static::assertEquals([], $data->layout);
 45 |     }
 46 | 
 47 |     /**
 48 |      * @test
 49 |      */
 50 |     function it_returns_alternative()
 51 |     {
 52 |         $data = new LayoutData;
 53 |         $data->alternative = ['test'];
 54 | 
 55 |         static::assertEquals(['test'], $data->alternative());
 56 |     }
 57 | 
 58 |     /**
 59 |      * @test
 60 |      */
 61 |     function it_returns_empty_array_as_default_for_alternative()
 62 |     {
 63 |         $data = new LayoutData;
 64 | 
 65 |         static::assertEquals([], $data->alternative());
 66 |     }
 67 | 
 68 |     /**
 69 |      * @test
 70 |      */
 71 |     function it_sets_layout()
 72 |     {
 73 |         $data = new LayoutData;
 74 | 
 75 |         static::assertSame($data, $data->setLayout(['test']));
 76 |         static::assertEquals(['test'], $data->layout);
 77 |     }
 78 | 
 79 |     /**
 80 |      * @test
 81 |      */
 82 |     function it_sets_alternative()
 83 |     {
 84 |         $data = new LayoutData;
 85 | 
 86 |         static::assertSame($data, $data->setAlternative(['test']));
 87 |         static::assertEquals(['test'], $data->alternative);
 88 |     }
 89 | 
 90 |     /**
 91 |      * @test
 92 |      */
 93 |     function it_decorates_layout_attribute_with_group_data_instances_for_arrays()
 94 |     {
 95 |         $data = new LayoutData;
 96 | 
 97 |         $data->layout = [
 98 |             [
 99 |                 'id'    => 'test-group',
100 |                 'label' => 'Test',
101 |             ]
102 |         ];
103 | 
104 |         $layout = $data->layout();
105 | 
106 |         static::assertIsArray($layout);
107 |         static::assertInstanceOf(LayoutGroupData::class, head($layout));
108 |         static::assertEquals('test-group', head($layout)['id']);
109 |     }
110 | 
111 | }
112 | 


--------------------------------------------------------------------------------
/tests/Support/Data/Menu/PermissionIndexDataTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Support\Data\Menu;
 6 | 
 7 | use Czim\CmsCore\Support\Data\Menu\PermissionsIndexData;
 8 | use Czim\CmsCore\Test\CmsBootTestCase;
 9 | 
10 | class PermissionIndexDataTest extends CmsBootTestCase
11 | {
12 | 
13 |     /**
14 |      * @test
15 |      */
16 |     function it_returns_stringified_base_encoded_identifier_for_nested_keys_array()
17 |     {
18 |         $data = new PermissionsIndexData();
19 | 
20 |         $stringified = base64_encode('test') . '.' . base64_encode(1) . '.' . base64_encode('deep');
21 | 
22 |         static::assertEquals($stringified, $data->stringifyNodeKey(['test', 1, 'deep']));
23 |     }
24 | 
25 |     /**
26 |      * @test
27 |      */
28 |     function it_returns_top_level_identifier_when_stringifying_empty_key_array()
29 |     {
30 |         $data = new PermissionsIndexData();
31 | 
32 |         static::assertEquals(PermissionsIndexData::KEY_TOP_LEVEL, $data->stringifyNodeKey([]));
33 |     }
34 | 
35 | }
36 | 


--------------------------------------------------------------------------------
/tests/Support/Logging/CmsFormatterDecoratorTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Support\Data;
 6 | 
 7 | use Czim\CmsCore\Support\Logging\CmsFormatterDecorator;
 8 | use Czim\CmsCore\Test\TestCase;
 9 | use Mockery;
10 | use Mockery\Mock;
11 | use Mockery\MockInterface;
12 | use Monolog\Formatter\FormatterInterface;
13 | 
14 | class CmsFormatterDecoratorTest extends TestCase
15 | {
16 | 
17 |     /**
18 |      * @test
19 |      */
20 |     function it_relays_batch_formatting_to_wrapped_formatter()
21 |     {
22 |         /** @var FormatterInterface|Mock|MockInterface $formatterMock */
23 |         $formatterMock = Mockery::mock(FormatterInterface::class);
24 |         $formatterMock->shouldReceive('formatBatch')->once()->with(['testing']);
25 | 
26 |         $decorator = new CmsFormatterDecorator($formatterMock);
27 | 
28 |         $decorator->formatBatch(['testing']);
29 |     }
30 | 
31 |     /**
32 |      * @test
33 |      */
34 |     function it_decorates_a_string_message()
35 |     {
36 |         /** @var FormatterInterface|Mock|MockInterface $formatterMock */
37 |         $formatterMock = Mockery::mock(FormatterInterface::class);
38 |         $formatterMock->shouldReceive('format')->once()
39 |             ->with(['test'])->andReturn('test');
40 | 
41 |         $decorator = new CmsFormatterDecorator($formatterMock);
42 | 
43 |         static::assertEquals(CmsFormatterDecorator::CMS_RECORD_PREFIX . 'test', $decorator->format(['test']));
44 |     }
45 | 
46 |     /**
47 |      * @test
48 |      */
49 |     function it_decorates_an_array_message()
50 |     {
51 |         /** @var FormatterInterface|Mock|MockInterface $formatterMock */
52 |         $formatterMock = Mockery::mock(FormatterInterface::class);
53 |         $formatterMock->shouldReceive('format')->once()
54 |             ->with(['test'])
55 |             ->andReturn([
56 |                 'channel',
57 |                 'test',
58 |                 'trace',
59 |                 'level'
60 |             ]);
61 | 
62 |         $decorator = new CmsFormatterDecorator($formatterMock);
63 | 
64 |         static::assertEquals(
65 |             [
66 |                 'channel',
67 |                 CmsFormatterDecorator::CMS_RECORD_PREFIX . 'test',
68 |                 'trace',
69 |                 'level'
70 |             ],
71 |             $decorator->format(['test'])
72 |         );
73 |     }
74 | 
75 | }
76 | 


--------------------------------------------------------------------------------
/tests/Support/Translation/CmsTranslatorTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Support\Translation;
 6 | 
 7 | use Czim\CmsCore\Support\Translation\CmsTranslator;
 8 | use Czim\CmsCore\Test\CmsBootTestCase;
 9 | use Illuminate\Contracts\Translation\Loader;
10 | use Mockery;
11 | use Mockery\Mock;
12 | use Mockery\MockInterface;
13 | 
14 | class CmsTranslatorTest extends CmsBootTestCase
15 | {
16 | 
17 |     /**
18 |      * @test
19 |      */
20 |     function it_falls_back_to_application_translation_if_cms_translation_key_not_found()
21 |     {
22 |         /** @var Loader|Mock|MockInterface $loaderMock */
23 |         $loaderMock = Mockery::mock(Loader::class);
24 |         $loaderMock->shouldReceive('load');
25 | 
26 |         $translator = new CmsTranslator($loaderMock, 'en');
27 | 
28 |         $translator->addLines(['testing.test' => 'exists application'], 'en');
29 | 
30 |         static::assertEquals('exists application', $translator->get('testing.test'));
31 |     }
32 | 
33 |     /**
34 |      * @test
35 |      */
36 |     function it_does_not_fall_back_to_application_translation_if_key_already_prefixed()
37 |     {
38 |         /** @var Loader|Mock|MockInterface $loaderMock */
39 |         $loaderMock = Mockery::mock(Loader::class);
40 |         $loaderMock->shouldReceive('load');
41 | 
42 |         $translator = new CmsTranslator($loaderMock, 'en');
43 | 
44 |         $translator->addLines(['testing.test' => 'exists application'], 'en');
45 | 
46 |         static::assertEquals('cms::testing.test', $translator->get('cms::testing.test'));
47 |     }
48 | 
49 |     /**
50 |      * @test
51 |      */
52 |     function it_prefixes_a_translation_key_using_cms_translation_if_available()
53 |     {
54 |         /** @var Loader|Mock|MockInterface $loaderMock */
55 |         $loaderMock = Mockery::mock(Loader::class);
56 |         $loaderMock->shouldReceive('load');
57 | 
58 |         $translator = new CmsTranslator($loaderMock, 'en');
59 | 
60 |         $translator->addLines(['testing.test' => 'exists cms'], 'en', 'cms');
61 |         $translator->addLines(['testing.test' => 'exists application'], 'en');
62 | 
63 |         static::assertEquals('exists cms', $translator->get('testing.test'));
64 |     }
65 | 
66 | }
67 | 


--------------------------------------------------------------------------------
/tests/Support/View/AssetManagerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /** @noinspection ReturnTypeCanBeDeclaredInspection */
 3 | /** @noinspection AccessModifierPresentedInspection */
 4 | 
 5 | namespace Czim\CmsCore\Test\Support\View;
 6 | 
 7 | use Czim\CmsCore\Support\View\AssetManager;
 8 | use Czim\CmsCore\Test\TestCase;
 9 | 
10 | class AssetManagerTest extends TestCase
11 | {
12 | 
13 |     /**
14 |      * @test
15 |      */
16 |     function it_registers_style_assets()
17 |     {
18 |         $manager = new AssetManager();
19 | 
20 |         static::assertSame($manager, $manager->registerStyleAsset('/path/to/asset', 'something', 'screen'));
21 | 
22 |         static::assertEquals(
23 |             '<link rel="stylesheet" href="/path/to/asset" type="something" media="screen">',
24 |             $manager->renderStyleAssets()
25 |         );
26 | 
27 |         // Without parameters
28 |         $manager = new AssetManager();
29 | 
30 |         $manager->registerStyleAsset('/path/to/asset');
31 | 
32 |         static::assertEquals('<link rel="stylesheet" href="/path/to/asset">', $manager->renderStyleAssets());
33 |     }
34 | 
35 |     /**
36 |      * @test
37 |      */
38 |     function it_registers_script_footer_assets()
39 |     {
40 |         $manager = new AssetManager();
41 | 
42 |         static::assertSame($manager, $manager->registerScriptAsset('/path/to/asset'));
43 |         $manager->registerScriptAsset('/not/footer', true);
44 | 
45 |         static::assertEquals('<script src="/path/to/asset"></script>', $manager->renderScriptAssets());
46 |     }
47 | 
48 |     /**
49 |      * @test
50 |      */
51 |     function it_registers_script_header_assets()
52 |     {
53 |         $manager = new AssetManager();
54 | 
55 |         static::assertSame($manager, $manager->registerScriptAsset('/path/to/asset', true));
56 |         $manager->registerScriptAsset('/not/footer');
57 | 
58 |         static::assertEquals('<script src="/path/to/asset"></script>', $manager->renderScriptHeadAssets());
59 |     }
60 | 
61 |     /**
62 |      * @test
63 |      */
64 |     function it_registers_script_bodies()
65 |     {
66 |         $manager = new AssetManager();
67 | 
68 |         static::assertSame($manager, $manager->registerScript('<script>test</script>', false));
69 |         $manager->registerScript('<script>test</script>', false);
70 | 
71 |         static::assertEquals("<script>test</script>\n<script>test</script>", $manager->renderScripts());
72 |     }
73 | 
74 |     /**
75 |      * @test
76 |      */
77 |     function it_registers_script_bodies_such_that_duplicates_are_not_rendered()
78 |     {
79 |         $manager = new AssetManager();
80 | 
81 |         static::assertSame($manager, $manager->registerScript('<script>test</script>'));
82 |         $manager->registerScript('<script>test</script>');
83 | 
84 |         static::assertEquals('<script>test</script>', $manager->renderScripts());
85 |     }
86 | 
87 | }
88 | 


--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test;
 3 | 
 4 | use Czim\CmsCore\Core\BootChecker;
 5 | use Illuminate\Contracts\Config\Repository;
 6 | use Illuminate\Contracts\Console\Kernel as ConsoleKernelContract;
 7 | use Illuminate\Contracts\Foundation\Application;
 8 | use Czim\CmsCore\Contracts\Auth\AuthenticatorInterface;
 9 | use Mockery;
10 | use Orchestra\Testbench\TestCase as OrchestraTestCase;
11 | 
12 | abstract class TestCase extends OrchestraTestCase
13 | {
14 | 
15 |     /**
16 |      * {@inheritdoc}
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         parent::getEnvironmentSetUp($app);
21 | 
22 |         /** @var Repository $config */
23 |         $config = $app['config'];
24 | 
25 |         $config->set('cms-modules.modules', []);
26 |     }
27 | 
28 |     protected function getTestBootCheckerBinding(): string
29 |     {
30 |         return BootChecker::class;
31 |     }
32 | 
33 |     /**
34 |      * Mocks components that should not be part of any core test.
35 |      *
36 |      * @param Application $app
37 |      * @return $this
38 |      */
39 |     protected function mockBoundCoreExternalComponents(Application $app): TestCase
40 |     {
41 |         $app->bind('mock-cms-auth', function () {
42 | 
43 |             $mock = $this->getMockAuthenticator();
44 | 
45 |             $mock->shouldReceive('version')->andReturn('1.2.3');
46 | 
47 |             $mock->shouldReceive('admin')->andReturn(false);
48 |             $mock->shouldReceive('user')->andReturn(null);
49 | 
50 |             $mock->shouldReceive('getRouteLoginAction')->andReturn('MockController@index');
51 |             $mock->shouldReceive('getRouteLoginPostAction')->andReturn('MockController@index');
52 |             $mock->shouldReceive('getRouteLogoutAction')->andReturn('MockController@index');
53 | 
54 |             $mock->shouldReceive('getApiRouteLoginAction')->andReturn('MockController@index');
55 |             $mock->shouldReceive('getApiRouteLogoutAction')->andReturn('MockController@index');
56 | 
57 |             $mock->shouldReceive('getRoutePasswordEmailGetAction')->andReturn('MockController@index');
58 |             $mock->shouldReceive('getRoutePasswordEmailPostAction')->andReturn('MockController@index');
59 |             $mock->shouldReceive('getRoutePasswordResetGetAction')->andReturn('MockController@index');
60 |             $mock->shouldReceive('getRoutePasswordResetPostAction')->andReturn('MockController@index');
61 | 
62 |             return $mock;
63 |         });
64 | 
65 |         return $this;
66 |     }
67 | 
68 |     /**
69 |      * Returns most recent artisan command output.
70 |      *
71 |      * @return string
72 |      */
73 |     protected function getArtisanOutput(): string
74 |     {
75 |         return $this->app[ConsoleKernelContract::class]->output();
76 |     }
77 | 
78 |     /**
79 |      * @return \Mockery\MockInterface|\Mockery\Mock|AuthenticatorInterface
80 |      */
81 |     protected function getMockAuthenticator()
82 |     {
83 |         return Mockery::mock(AuthenticatorInterface::class);
84 |     }
85 | 
86 | 
87 | }
88 | 


--------------------------------------------------------------------------------
/tests/WebTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Czim\CmsCore\Test;
 3 | 
 4 | use Czim\CmsCore\Test\Helpers\Core\MockWebBootChecker;
 5 | 
 6 | abstract class WebTestCase extends CmsBootTestCase
 7 | {
 8 | 
 9 |     protected function getTestBootCheckerBinding(): string
10 |     {
11 |         return MockWebBootChecker::class;
12 |     }
13 | 
14 | }
15 | 


--------------------------------------------------------------------------------