giumar / fortunecookies

src/Application.php

<?php

Filename "Application.php" doesn't match the expected filename "application.php"

The PHP open tag does not have a corresponding PHP close tag

This file is missing a doc comment.

Class found in ".php" file; use ".inc" extension instead

declare(strict_types=1);

/**

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

The file-level docblock must follow the opening PHP tag in the file header

 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

Doc comment short description must be on a single line, further text should be a separate paragraph

 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

@copyright tag must contain a year and the name of the copyright holder

 * @link      https://cakephp.org CakePHP(tm) Project

Tag value indented incorrectly; expected 1 space but found 6

The tag in position 2 should be the @license tag

 * @since     3.3.0

Tag value indented incorrectly; expected 1 space but found 5

The tag in position 3 should be the @link tag

 * @license   https://opensource.org/licenses/mit-license.php MIT License

The tag in position 4 should be the @since tag

Tag value indented incorrectly; expected 1 space but found 3

 */

Missing @category tag in file comment

PHP version not specified

Missing @package tag in file comment

Missing @author tag in file comment

namespace App;

use Cake\Core\Configure;
use Cake\Core\Exception\MissingPluginException;
use Cake\Error\Middleware\ErrorHandlerMiddleware;
use Cake\Http\BaseApplication;
use Cake\Http\Middleware\BodyParserMiddleware;
use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Http\MiddlewareQueue;
use Cake\Routing\Middleware\AssetMiddleware;
use Cake\Routing\Middleware\RoutingMiddleware;
use Authentication\AuthenticationService;
use Authentication\AuthenticationServiceInterface;
use Authentication\AuthenticationServiceProviderInterface;
use Authentication\Identifier\IdentifierInterface;
use Authentication\Middleware\AuthenticationMiddleware;
#use Cake\Http\MiddlewareQueue;

50% of this comment could be valid code. Did you maybe forget this after debugging?

Perl-style comments are not allowed; use "// Comment" instead

Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead.

use Cake\Routing\Router;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Application setup class.
 *
 * This defines the bootstrapping logic and middleware layers you
 * want to use in your application.
 */

Missing @author tag in class comment

Missing @package tag in class comment

Missing @category tag in class comment

Missing @link tag in class comment

Missing @license tag in class comment

class Application extends BaseApplication implements AuthenticationServiceProviderInterface {

Opening brace of a class must be on the line after the definition

    /**
     * Load all the application configuration and bootstrap logic.
     *
     * @return void

If there is no return value for a function, there must not be a @return tag.

     */
    public function bootstrap(): void {

Opening brace should be on a new line

        // Call parent to load bootstrap from files.
        parent::bootstrap();

        if (PHP_SAPI === 'cli') {
            $this->bootstrapCli();
        }

        /*
         * Only try to load DebugKit in development mode
         * Debug Kit should not be installed on a production system
         */

Empty line required after block comment

        if (Configure::read('debug')) {
            $this->addPlugin('DebugKit');
        }

        // Load more plugins here

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

Inline comments must end in full-stops, exclamation marks, or question marks

        $this->addPlugin('Authentication');
    }

    /**
     * Setup the middleware queue your application will use.
     *
     * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to setup.

Parameter comment must be on the next line

     * @return \Cake\Http\MiddlewareQueue The updated middleware queue.

Separate the @param and @return sections by a blank line.

     */
    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue {

Opening brace should be on a new line

        $middlewareQueue
                // Catch any exceptions in the lower layers,
                // and make an error page/response

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

Inline comments must end in full-stops, exclamation marks, or question marks

                ->add(new ErrorHandlerMiddleware(Configure::read('Error')))

Object operator not indented correctly; expected 10 spaces but found 16

Space found before object operator

Object operator not indented correctly; expected 12 spaces but found 16

                // Handle plugin/theme assets like CakePHP normally does.
                ->add(new AssetMiddleware([

Object operator not indented correctly; expected 12 spaces but found 16

Space found before object operator

                            'cacheTime' => Configure::read('Asset.cacheTime'),

Array key not indented correctly; expected 20 spaces but found 28

                        ]))

Array closing indentation error, expected 16 spaces but found 24

Array close brace not indented correctly; expected 16 spaces but found 24

                // Add routing middleware.
                // If you have a large number of routes connected, turning on routes

Line exceeds 80 characters; contains 84 characters

                // caching in production could improve performance. For that when

Line exceeds 80 characters; contains 81 characters

                // creating the middleware instance specify the cache config name by

Line exceeds 80 characters; contains 84 characters

                // using it's second constructor argument:
                // `new RoutingMiddleware($this, '_cake_routes_')`

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

Inline comments must end in full-stops, exclamation marks, or question marks

                ->add(new RoutingMiddleware($this))

Space found before object operator

Object operator not indented correctly; expected 12 spaces but found 16

                // Parse various types of encoded request bodies so that they are

Line exceeds 80 characters; contains 81 characters

                // available as array through $request->getData()
                // https://book.cakephp.org/4/en/controllers/middleware.html#body-parser-middleware

Inline comments must end in full-stops, exclamation marks, or question marks

                ->add(new BodyParserMiddleware())

Space found before object operator

Object operator not indented correctly; expected 12 spaces but found 16

                // Cross Site Request Forgery (CSRF) Protection Middleware
                // https://book.cakephp.org/4/en/controllers/middleware.html#cross-site-request-forgery-csrf-middleware

Inline comments must end in full-stops, exclamation marks, or question marks

                ->add(new CsrfProtectionMiddleware([

Space found before object operator

Object operator not indented correctly; expected 12 spaces but found 16

                            'httponly' => true,

Array key not indented correctly; expected 20 spaces but found 28

                        ]))

Array close brace not indented correctly; expected 16 spaces but found 24

Array closing indentation error, expected 16 spaces but found 24

                ->add(new AuthenticationMiddleware($this));

Object operator not indented correctly; expected 12 spaces but found 16

Space found before object operator

        return $middlewareQueue;
    }

    /**
     * Bootrapping for CLI application.
     *
     * That is when running commands.
     *
     * @return void

If there is no return value for a function, there must not be a @return tag.

     */
    protected function bootstrapCli(): void {

Opening brace should be on a new line

        try {
            $this->addPlugin('Bake');
        } catch (MissingPluginException $e) {

Expected newline after closing brace

            // Do not halt if the plugin is missing

Inline comments must end in full-stops, exclamation marks, or question marks

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

        }

        $this->addPlugin('Migrations');

        // Load more plugins here

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

Inline comments must end in full-stops, exclamation marks, or question marks

    }

    /**
     * Returns a service provider instance.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request Request

Parameter comment must end with a full stop

Parameter comment must be on the next line

     * @return \Authentication\AuthenticationServiceInterface

Separate the @param and @return sections by a blank line.

     */
    public function getAuthenticationService(ServerRequestInterface $request): AuthenticationServiceInterface {

Opening brace should be on a new line

The method parameter $request is never used

        $service = new AuthenticationService();

        // Define where users should be redirected to when they are not authenticated

Inline comments must end in full-stops, exclamation marks, or question marks

Line exceeds 80 characters; contains 85 characters

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

        $service->setConfig([
            'unauthenticatedRedirect' => Router::url([
                'prefix' => 'Admin',
                'plugin' => null,
                'controller' => 'Users',
                'action' => 'login',
            ]),
            'queryParam' => 'redirect',
        ]);

        $fields = [
            IdentifierInterface::CREDENTIAL_USERNAME => 'email',
            IdentifierInterface::CREDENTIAL_PASSWORD => 'password'

A comma should follow the last multiline array item. Found: 'password'

        ];
        // Load the authenticators. Session should be first.
        $service->loadAuthenticator('Authentication.Session');
        $service->loadAuthenticator('Authentication.Form', [
            'fields' => $fields,
            'loginUrl' => Router::url([
                'prefix' => 'Admin',
                'plugin' => null,
                'controller' => 'Users',
                'action' => 'login',
            ]),
        ]);

        // Load identifiers

Inline comments must end in full-stops, exclamation marks, or question marks

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

        $service->loadIdentifier('Authentication.Password', compact('fields'));

        return $service;
    }

}