Bundle - getBundleViewPath() method - verify name of bundle

This commit is contained in:
Meritoo
2017-12-21 22:43:45 +01:00
parent 0e4c33241e
commit 7d23ff59d1
3 changed files with 108 additions and 12 deletions

View File

@@ -0,0 +1,34 @@
<?php
/**
* (c) Meritoo.pl, http://www.meritoo.pl
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Meritoo\Common\Exception\Bundle;
use Exception;
/**
* An exception used while name of bundle is incorrect
*
* @author Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
* @copyright Meritoo.pl
*/
class IncorrectBundleNameException extends Exception
{
/**
* Class constructor
*
* @param string $bundleName Incorrect name of bundle
*/
public function __construct($bundleName)
{
$template = 'Name of bundle \'%s\' is incorrect. It should start with big letter and end with "Bundle". Is'
. ' there everything ok?';
$message = sprintf($template, $bundleName);
parent::__construct($message);
}
}

View File

@@ -8,6 +8,8 @@
namespace Meritoo\Common\Utilities;
use Meritoo\Common\Exception\Bundle\IncorrectBundleNameException;
/**
* Useful methods for bundle
*
@@ -17,12 +19,14 @@ namespace Meritoo\Common\Utilities;
class Bundle
{
/**
* Returns path to view / template of given bundle
* Returns path of given bundle to view / template with given extension
*
* @param string $viewPath Path of the view / template, e.g. "MyDirectory/my-template"
* @param string $bundleName Full name of the bundle, e.g. "MyExtraBundle"
* @param string $extension (optional) Extension of the view / template
* @return string|null
*
* @throws IncorrectBundleNameException
*/
public static function getBundleViewPath($viewPath, $bundleName, $extension = 'html.twig')
{
@@ -34,6 +38,13 @@ class Bundle
return null;
}
/*
* Given name of bundle is invalid?
*/
if (!Regex::isValidBundleName($bundleName)) {
throw new IncorrectBundleNameException($bundleName);
}
/*
* Path of the view / template doesn't end with given extension?
*/