RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 07:41:43 +03:00
Code Issues Projects Releases Wiki Activity

Applied some php-cs-fixer magic

Browse Source
This commit is contained in:
Christophe Coevoet 2012-05-23 00:33:01 +02:00
parent 84ad827c89
commit 04b075736f
15 changed files with 84 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,2 +1,2 @@
vendor/
vendor/
composer.lock

2
Annotation/ApiDoc.php
View File

@ -40,7 +40,7 @@ class ApiDoc
{
if (isset($data['formType'])) {
$this->formType = $data['formType'];
} else if (isset($data['filters'])) {
} elseif (isset($data['filters'])) {
foreach ($data['filters'] as $filter) {
if (!isset($filter['name'])) {
throw new \InvalidArgumentException('A "filter" element has to contain a "name" attribute');

1
DependencyInjection/Configuration.php
View File

@ -11,7 +11,6 @@
namespace Nelmio\ApiDocBundle\DependencyInjection;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

8
Extractor/ApiDocExtractor.php
View File

@ -150,7 +150,7 @@ class ApiDocExtractor
* - route
*
* @param string $controller
* @param Route $route
* @param Route $route
* @return array|null
*/
public function get($controller, $route)
@ -172,9 +172,9 @@ class ApiDocExtractor
* - annotation
* - route
*
* @param ApiDoc $annotation
* @param Route $route
* @param \ReflectionMethod $method
* @param ApiDoc $annotation
* @param Route $route
* @param \ReflectionMethod $method
* @return array
*/
protected function getData(ApiDoc $annotation, Route $route, \ReflectionMethod $method)

12
Formatter/AbstractFormatter.php
View File

@ -56,22 +56,22 @@ abstract class AbstractFormatter implements FormatterInterface
/**
* Format a single array of data
*
* @param array $data
* @param array $data
* @return string|array
*/
protected abstract function renderOne(array $data);
abstract protected function renderOne(array $data);
/**
* Format a set of resource sections.
*
* @param array $collection
* @param array $collection
* @return string|array
*/
protected abstract function render(array $collection);
abstract protected function render(array $collection);
/**
* @param ApiDoc $apiDoc
* @param Route $route
* @param ApiDoc $apiDoc
* @param Route $route
* @return array
*/
protected function getData(ApiDoc $apiDoc, Route $route)

8
Formatter/FormatterInterface.php
View File

@ -19,17 +19,17 @@ interface FormatterInterface
/**
* Format a collection of documentation data.
*
* @param array $collection
* @param array $collection
* @return string|array
*/
function format(array $collection);
public function format(array $collection);
/**
* Format documentation data for one route.
*
* @param ApiDoc $apiDoc
* @param Route $route
* @param Route $route
* return string|array
*/
function formatOne(ApiDoc $apiDoc, Route $route);
public function formatOne(ApiDoc $apiDoc, Route $route);
}

2
Formatter/HtmlFormatter.php
View File

@ -11,8 +11,6 @@
namespace Nelmio\ApiDocBundle\Formatter;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\Routing\Route;
use Symfony\Component\Templating\EngineInterface;
class HtmlFormatter extends AbstractFormatter

2
Parser/FormTypeParser.php
View File

@ -47,7 +47,7 @@ class FormTypeParser
* - required
* - description
*
* @param AbstractType $type
* @param AbstractType $type
* @return array
*/
public function parse(AbstractType $type)

2
Tests/Fixtures/Controller/TestController.php
View File

@ -58,7 +58,7 @@ class TestController
*
* @ApiDoc()
*
* @param int $id A nice comment
* @param int $id A nice comment
* @param int $page
*/
public function myCommentedAction()

3
Tests/Fixtures/Controller/TestServiceController.php
View File

@ -11,9 +11,6 @@
namespace Nelmio\ApiDocBundle\Tests\Fixtures\Controller;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpFoundation\Response;
class TestServiceController extends TestController
{
}

36
Tests/Fixtures/NelmioApiDocTestBundle.php
View File

@ -1,18 +1,18 @@
<?php
/*
* This file is part of the NelmioApiDocBundle.
*
* (c) Nelmio <hello@nelm.io>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Nelmio\ApiDocBundle\Tests\Fixtures;
use Symfony\Component\HttpKernel\Bundle\Bundle;
class NelmioApiDocTestBundle extends Bundle
{
}
<?php
/*
* This file is part of the NelmioApiDocBundle.
*
* (c) Nelmio <hello@nelm.io>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Nelmio\ApiDocBundle\Tests\Fixtures;
use Symfony\Component\HttpKernel\Bundle\Bundle;
class NelmioApiDocTestBundle extends Bundle
{
}

1
Tests/Fixtures/app/AppKernel.php
View File

@ -31,7 +31,6 @@ while ($dir !== $lastDir) {
}
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\HttpKernel\Kernel;
/**

4
Tests/WebTestCase.php
View File

@ -37,14 +37,14 @@ abstract class WebTestCase extends BaseWebTestCase
return static::$kernel->getContainer();
}
static protected function getKernelClass()
protected static function getKernelClass()
{
require_once __DIR__.'/Fixtures/app/AppKernel.php';
return 'Nelmio\ApiDocBundle\Tests\Functional\AppKernel';
}
static protected function createKernel(array $options = array())
protected static function createKernel(array $options = array())
{
$class = self::getKernelClass();

27
Tests/bootstrap.php
View File

@ -1,13 +1,14 @@
<?php
function includeIfExists($file) {
if (file_exists($file)) {
return include $file;
}
}
if ((!$loader = includeIfExists(__DIR__.'/../vendor/autoload.php')) && (!$loader = includeIfExists(__DIR__.'/../../../../../autoload.php'))) {
die('You must set up the project dependencies, run the following commands:'.PHP_EOL.
'curl -s http://getcomposer.org/installer | php'.PHP_EOL.
'php composer.phar install'.PHP_EOL);
}
<?php
function includeIfExists($file)
{
if (file_exists($file)) {
return include $file;
}
}
if ((!$loader = includeIfExists(__DIR__.'/../vendor/autoload.php')) && (!$loader = includeIfExists(__DIR__.'/../../../../../autoload.php'))) {
die('You must set up the project dependencies, run the following commands:'.PHP_EOL.
'curl -s http://getcomposer.org/installer | php'.PHP_EOL.
'php composer.phar install'.PHP_EOL);
}

64
composer.json
View File

@ -1,32 +1,32 @@
{
"name": "nelmio/api-doc-bundle",
"description": "Generates documentation for your REST API from annotations",
"keywords": ["api", "documentation", "doc", "rest"],
"type": "symfony-bundle",
"license": "MIT",
"authors": [
{
"name": "Nelmio",
"homepage": "http://nelm.io"
},
{
"name": "Symfony Community",
"homepage": "https://github.com/nelmio/NelmioApiDocBundle/contributors"
}
],
"require": {
"symfony/framework-bundle": "2.1.*",
"symfony/twig-bundle": "2.1.*",
"symfony/form": "2.1.*"
},
"require-dev": {
"symfony/css-selector": "2.1.*",
"symfony/browser-kit": "2.1.*",
"symfony/validator": "2.1.*",
"symfony/yaml": "2.1.*"
},
"autoload": {
"psr-0": { "Nelmio\\ApiDocBundle": "" }
},
"target-dir": "Nelmio/ApiDocBundle"
}
{
"name": "nelmio/api-doc-bundle",
"description": "Generates documentation for your REST API from annotations",
"keywords": ["api", "documentation", "doc", "rest"],
"type": "symfony-bundle",
"license": "MIT",
"authors": [
{
"name": "Nelmio",
"homepage": "http://nelm.io"
},
{
"name": "Symfony Community",
"homepage": "https://github.com/nelmio/NelmioApiDocBundle/contributors"
}
],
"require": {
"symfony/framework-bundle": "2.1.*",
"symfony/twig-bundle": "2.1.*",
"symfony/form": "2.1.*"
},
"require-dev": {
"symfony/css-selector": "2.1.*",
"symfony/browser-kit": "2.1.*",
"symfony/validator": "2.1.*",
"symfony/yaml": "2.1.*"
},
"autoload": {
"psr-0": { "Nelmio\\ApiDocBundle": "" }
},
"target-dir": "Nelmio/ApiDocBundle"
}