EntityViewMethods::getEntityNameSingular()

Completed

Push — master ( 37b943...607dad )

by Filipe

created 2016-05-25 18:11 UTC

↳ Parent: EntityViewMethods

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	1
ccs	0
cts	0
cp	0
nc	1

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc\Controller;

use Slick\Common\Log;
use Slick\Filter\StaticFilter;
use Slick\Mvc\Exception\Service\EntityNotFoundException;
use Slick\Orm\EntityInterface;

/**
 * Entity View Methods
 * 
 * @package Slick\Mvc\Controller
 * @author  Filipe Silva <[email protected]>
 */
trait EntityViewMethods
{

    /**
     * Add a warning flash message
     *
     * @param string $message
     * @return self
     */
    abstract public function addWarningMessage($message);

    /**
     * Get missing entity warning message
     * 
     * @param mixed $entityId
     * 
     * @return string
     */
    protected function getMissingEntityMessage($entityId)
    {
        $singleName = $this->getEntityNameSingular();
        return "The {$singleName} with ID {$entityId} was not found.";
    }

    /**
     * Redirect callback after missing entity detection
     * 
     * @return $this|\Slick\Mvc\ControllerInterface|static
     */
    protected function redirectFromMissingEntity()
    {
        return $this->redirect($this->getBasePath());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Handles the request to view an entity
     * 
     * @param int $entityId
     */
    public function show($entityId = 0)
    {
        $entityId = StaticFilter::filter('text', $entityId);
        try {
            $entity = $this->getEntity($entityId);
            $this->set($this->getEntityNameSingular(), $entity);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (EntityNotFoundException $caught) {
            Log::logger()->addNotice($caught->getMessage());
            $this->addWarningMessage(
                $this->getMissingEntityMessage($entityId)
            );
            $this->redirectFromMissingEntity();
        }
        
    }

    /**
     * Gets entity with provided primary key
     *
     * @param mixed $entityId
     *
     * @return EntityInterface
     *
     * @throws EntityNotFoundException If no entity was found with
     *   provided primary key
     */
    abstract protected function getEntity($entityId);

    /**
     * Get entity singular name used on controller actions
     *
     * @return string
     */
    abstract protected function getEntityNameSingular();
}

1		<?php
2
3		/**
4		* This file is part of slick/mvc package
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace Slick\Mvc\Controller;
11
12		use Slick\Common\Log;
13		use Slick\Filter\StaticFilter;
14		use Slick\Mvc\Exception\Service\EntityNotFoundException;
15		use Slick\Orm\EntityInterface;
16
17		/**
18		* Entity View Methods
19		*
20		* @package Slick\Mvc\Controller
21		* @author Filipe Silva <[email protected]>
22		*/
23		trait EntityViewMethods
24		{
25
26		/**
27		* Add a warning flash message
28		*
29		* @param string $message
30		* @return self
31		*/
32		abstract public function addWarningMessage($message);
33
34		/**
35		* Get missing entity warning message
36		*
37		* @param mixed $entityId
38		*
39		* @return string
40		*/
41	2	protected function getMissingEntityMessage($entityId)
42		{
43	2	$singleName = $this->getEntityNameSingular();
44	2	return "The {$singleName} with ID {$entityId} was not found.";
45		}
46
47		/**
48		* Redirect callback after missing entity detection
49		*
50		* @return $this\|\Slick\Mvc\ControllerInterface\|static
51		*/
52	2	protected function redirectFromMissingEntity()
53		{
54	2	return $this->redirect($this->getBasePath());
		0 ignored issues – show Bug introduced 2016-05-25 12:07 UTC by Report Bug Copy Issue Report It seems like `getBasePath()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Bug introduced 2016-05-25 12:07 UTC by Report Bug Copy Issue Report The method `redirect()` does not exist on `Slick\Mvc\Controller\EntityViewMethods`. Did you maybe mean `redirectFromMissingEntity()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
55		}
56
57		/**
58		* Handles the request to view an entity
59		*
60		* @param int $entityId
61		*/
62	4	public function show($entityId = 0)
63		{
64	4	$entityId = StaticFilter::filter('text', $entityId);
65		try {
66	4	$entity = $this->getEntity($entityId);
67	2	$this->set($this->getEntityNameSingular(), $entity);
		0 ignored issues – show Bug introduced 2016-05-25 12:07 UTC by Report Bug Copy Issue Report It seems like `set()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
68	3	} catch (EntityNotFoundException $caught) {
69	2	Log::logger()->addNotice($caught->getMessage());
70	2	$this->addWarningMessage(
71	2	$this->getMissingEntityMessage($entityId)
72	1	);
73	2	$this->redirectFromMissingEntity();
74		}
75
76	4	}
77
78		/**
79		* Gets entity with provided primary key
80		*
81		* @param mixed $entityId
82		*
83		* @return EntityInterface
84		*
85		* @throws EntityNotFoundException If no entity was found with
86		* provided primary key
87		*/
88		abstract protected function getEntity($entityId);
89
90		/**
91		* Get entity singular name used on controller actions
92		*
93		* @return string
94		*/
95		abstract protected function getEntityNameSingular();
96		}

slickframework / mvc

Push — master ( 37b943...607dad )

EntityViewMethods::getEntityNameSingular()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like