gggeek / db-3v4l

app/src/Controller/DocController.php

<?php

Missing file doc comment

namespace Db3v4l\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

The type Symfony\Bundle\FrameworkBundle\Controller\AbstractController was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Routing\Annotation\Route;

The type Symfony\Component\Routing\Annotation\Route was not found. Maybe you did not declare it correctly or list all dependencies?

/**

Missing short description in doc comment

 * @Route("/doc")
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class DocController extends AbstractController
{
    /// @todo get this injected
    protected $docRoot = '/var/www/doc';

    /**

Missing short description in doc comment

     * @Route("/list", name="doc_list")
     */

Missing @return tag in function comment

    public function list()
    {
        $docs = glob($this->docRoot . '/*.md');
        array_walk($docs, function(&$path, $key) {$path = basename($path);});

The parameter $key is not used and could be removed.

It seems like $docs can also be of type false; however, parameter $array of array_walk() does only seem to accept array, maybe add an additional type check?

Expected 1 space after FUNCTION keyword; 0 found

Opening brace must be the last content on the line

Closing brace must be on a line by itself

        return $this->render('Doc/list.html.twig', ['docs' => $docs]);
    }

    /**

Missing short description in doc comment

     * @Route("/view/{filename}", name="doc_view")
     *
     * @param string $filename

Parameter tags must be defined first in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return \Symfony\Component\HttpFoundation\Response

The type Symfony\Component\HttpFoundation\Response was not found. Maybe you did not declare it correctly or list all dependencies?

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function displayFile($filename)
    {
        // sanitize
        $filename = basename($filename);

        $filename = $this->docRoot . '/' . $filename;

        if (!is_file($filename)) {
            throw $this->createNotFoundException("The doc file '$filename' does not exist");
        }

        /// @todo allow different types of doc format
        return $this->render('Doc/File/markdown.html.twig', ['file' => basename($filename), 'markup' => file_get_contents($filename)]);
    }
}