Skip to content

Commit

Permalink
Add PHPDoc and fix some CS
Browse files Browse the repository at this point in the history
  • Loading branch information
qsomazzi committed Apr 14, 2015
1 parent 54987d7 commit 1815917
Show file tree
Hide file tree
Showing 117 changed files with 705 additions and 150 deletions.
6 changes: 6 additions & 0 deletions Admin/Admin.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@
use Doctrine\Common\Util\ClassUtils;
use Sonata\AdminBundle\Datagrid\Pager;

/**
* Class Admin
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
abstract class Admin implements AdminInterface, DomainObjectInterface
{
const CONTEXT_MENU = 'menu';
Expand Down
6 changes: 6 additions & 0 deletions Admin/AdminExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@

use Knp\Menu\ItemInterface as MenuItemInterface;

/**
* Class AdminExtension
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
abstract class AdminExtension implements AdminExtensionInterface
{
/**
Expand Down
6 changes: 5 additions & 1 deletion Admin/AdminExtensionInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/*
* This file is part of the Sonata package.
*
Expand All @@ -21,7 +22,10 @@
use Knp\Menu\ItemInterface as MenuItemInterface;

/**
* Interface AdminExtensionInterface
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
interface AdminExtensionInterface
{
Expand All @@ -41,7 +45,7 @@ public function configureListFields(ListMapper $list);
public function configureDatagridFilters(DatagridMapper $filter);

/**
* @param ShowMapper $filter
* @param ShowMapper $show
*/
public function configureShowFields(ShowMapper $show);

Expand Down
7 changes: 7 additions & 0 deletions Admin/AdminHelper.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/*
* This file is part of the Sonata package.
*
Expand All @@ -18,6 +19,12 @@
use Sonata\AdminBundle\Util\FormViewIterator;
use Sonata\AdminBundle\Util\FormBuilderIterator;

/**
* Class AdminHelper
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
class AdminHelper
{
protected $pool;
Expand Down
6 changes: 6 additions & 0 deletions Admin/AdminInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
use Symfony\Component\Translation\TranslatorInterface;
use Symfony\Component\HttpFoundation\Request;

/**
* Interface AdminInterface
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
interface AdminInterface
{
/**
Expand Down
8 changes: 8 additions & 0 deletions Admin/FieldDescriptionCollection.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/*
* This file is part of the Sonata package.
*
Expand All @@ -8,8 +9,15 @@
* file that was distributed with this source code.
*
*/

namespace Sonata\AdminBundle\Admin;

/**
* Class FieldDescriptionCollection
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
class FieldDescriptionCollection implements \ArrayAccess, \Countable
{
protected $elements = array();
Expand Down
7 changes: 6 additions & 1 deletion Admin/FieldDescriptionInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,14 @@

namespace Sonata\AdminBundle\Admin;

/**
* Interface FieldDescriptionInterface
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
interface FieldDescriptionInterface
{

/**
* set the field name
*
Expand Down
6 changes: 6 additions & 0 deletions Admin/Pool.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@

use Symfony\Component\DependencyInjection\ContainerInterface;

/**
* Class Pool
*
* @package Sonata\AdminBundle\Admin
* @author Thomas Rabaix <[email protected]>
*/
class Pool
{
protected $container = null;
Expand Down
7 changes: 3 additions & 4 deletions Block/AdminListBlockService.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,15 @@
use Sonata\BlockBundle\Block\BlockContextInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\CoreBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\BlockBundle\Block\BaseBlockService;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;

/**
* Class AdminListBlockService
*
* @author Thomas Rabaix <[email protected]>
* @package Sonata\AdminBundle\Block
* @author Thomas Rabaix <[email protected]>
*/
class AdminListBlockService extends BaseBlockService
{
Expand Down
9 changes: 3 additions & 6 deletions Block/AdminSearchBlockService.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,16 @@
use Symfony\Component\HttpFoundation\Response;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;

use Sonata\AdminBundle\Form\FormMapper;
use Sonata\CoreBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Admin\Pool;

use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\BlockBundle\Block\BaseBlockService;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

/**
* Class AdminSearchBlockService
*
* @author Thomas Rabaix <[email protected]>
* @package Sonata\AdminBundle\Block
* @author Thomas Rabaix <[email protected]>
*/
class AdminSearchBlockService extends BaseBlockService
{
Expand Down
4 changes: 2 additions & 2 deletions Block/AdminStatsBlockService.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
use Sonata\BlockBundle\Block\BlockContextInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Sonata\CoreBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\BlockBundle\Block\BaseBlockService;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;

/**
* Class AdminStatsBlockService
*
* @package Sonata\AdminBundle\Block
* @author Thomas Rabaix <[email protected]>
*/
class AdminStatsBlockService extends BaseBlockService
Expand Down
6 changes: 6 additions & 0 deletions Builder/BuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Admin\AdminInterface;

/**
* Interface BuilderInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface BuilderInterface
{
/**
Expand Down
7 changes: 6 additions & 1 deletion Builder/DatagridBuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Datagrid\DatagridInterface;

/**
* Interface DatagridBuilderInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface DatagridBuilderInterface extends BuilderInterface
{

/**
* @abstract
*
Expand Down
7 changes: 6 additions & 1 deletion Builder/FormContractorInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Form\FormFactoryInterface;

/**
* Interface FormContractorInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface FormContractorInterface extends BuilderInterface
{

/**
* @abstract
*
Expand Down
6 changes: 6 additions & 0 deletions Builder/ListBuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionCollection;

/**
* Interface ListBuilderInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface ListBuilderInterface extends BuilderInterface
{
/**
Expand Down
7 changes: 6 additions & 1 deletion Builder/RouteBuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Route\RouteCollection;

/**
* Interface RouteBuilderInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface RouteBuilderInterface
{

/**
* @param \Sonata\AdminBundle\Admin\AdminInterface $admin
* @param \Sonata\AdminBundle\Route\RouteCollection $collection
Expand Down
6 changes: 6 additions & 0 deletions Builder/ShowBuilderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionCollection;

/**
* Interface ShowBuilderInterface
*
* @package Sonata\AdminBundle\Builder
* @author Thomas Rabaix <[email protected]>
*/
interface ShowBuilderInterface extends BuilderInterface
{
/**
Expand Down
8 changes: 6 additions & 2 deletions Command/CreateClassCacheCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,16 @@
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\Output;
use Symfony\Component\ClassLoader\ClassCollectionLoader;

/**
* Class CreateClassCacheCommand
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class CreateClassCacheCommand extends ContainerAwareCommand
{

/**
* {@inheritDoc}
*/
Expand Down
8 changes: 6 additions & 2 deletions Command/ExplainAdminCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\Output;

/**
* Class ExplainAdminCommand
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class ExplainAdminCommand extends ContainerAwareCommand
{

/**
* {@inheritDoc}
*/
Expand Down
7 changes: 5 additions & 2 deletions Command/GenerateAdminCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@
use Symfony\Component\Console\Question\ConfirmationQuestion;

/**
* @author Marek Stipek <[email protected]>
* @author Simon Cosandey <[email protected]>
* Class GenerateAdminCommand
*
* @package Sonata\AdminBundle\Command
* @author Marek Stipek <[email protected]>
* @author Simon Cosandey <[email protected]>
*/
class GenerateAdminCommand extends ContainerAwareCommand
{
Expand Down
8 changes: 6 additions & 2 deletions Command/GenerateObjectAclCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\Output;

use Sonata\AdminBundle\Util\ObjectAclManipulatorInterface;

/**
* Class GenerateObjectAclCommand
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class GenerateObjectAclCommand extends ContainerAwareCommand
{
/**
Expand Down
7 changes: 6 additions & 1 deletion Command/ListAdminCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\Output;

/**
* Class ListAdminCommand
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class ListAdminCommand extends ContainerAwareCommand
{
/**
Expand Down
8 changes: 6 additions & 2 deletions Command/SetupAclCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\Output;

use Sonata\AdminBundle\Util\AdminAclManipulatorInterface;

/**
* Class SetupAclCommand
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class SetupAclCommand extends ContainerAwareCommand
{
/**
Expand Down
6 changes: 6 additions & 0 deletions Command/Validators.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@

namespace Sonata\AdminBundle\Command;

/**
* Class Validators
*
* @package Sonata\AdminBundle\Command
* @author Thomas Rabaix <[email protected]>
*/
class Validators
{
/**
Expand Down
Loading

0 comments on commit 1815917

Please sign in to comment.