add some phpdoc

core/lib/Thelia/Action/Cart.php

@@ -41,6 +41,7 @@ use Thelia\Model\ConfigQuery;
  *
  * Class Cart
  * @package Thelia\Action
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
  */
 class Cart extends BaseAction implements EventSubscriberInterface
 {

core/lib/Thelia/Action/Customer.php

@@ -40,6 +40,14 @@ use Thelia\Core\Security\Exception\UsernameNotFoundException;
 use Propel\Runtime\Exception\PropelException;
 use Thelia\Core\Event\CustomerLoginEvent;
 
+/**
+ *
+ * customer class where all actions are managed
+ *
+ * Class Customer
+ * @package Thelia\Action
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class Customer extends BaseAction implements EventSubscriberInterface
 {
 

core/lib/Thelia/Cart/CartTrait.php

@@ -31,6 +31,13 @@ use Thelia\Core\HttpFoundation\Session\Session;
 use Thelia\Core\Event\TheliaEvents;
 use Thelia\Core\Event\CartEvent;
 
+/**
+ * managed cart
+ *
+ * Trait CartTrait
+ * @package Thelia\Cart
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 trait CartTrait
 {
     /**

core/lib/Thelia/Command/BaseModuleGenerate.php

@@ -22,6 +22,13 @@
 /*************************************************************************************/
 namespace Thelia\Command;
 
+/**
+ * base class for module commands
+ *
+ * Class BaseModuleGenerate
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 abstract class BaseModuleGenerate extends ContainerAwareCommand
 {
      protected $module;

core/lib/Thelia/Command/CacheClear.php

@@ -30,6 +30,14 @@ use Symfony\Component\Filesystem\Exception\IOException;
 
 use Thelia\Command\ContainerAwareCommand;
 
+/**
+ * clear the cache
+ *
+ * Class CacheClear
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ *
+ */
 class CacheClear extends ContainerAwareCommand
 {
     protected function configure()

core/lib/Thelia/Command/Install.php

@@ -29,6 +29,13 @@ use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Filesystem;
 use Thelia\Command\ContainerAwareCommand;
 
+/**
+ * try to install a new instance of Thelia
+ *
+ * Class Install
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class Install extends ContainerAwareCommand
 {
     /**

core/lib/Thelia/Command/ModuleGenerateCommand.php

@@ -27,6 +27,13 @@ use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
+/**
+ * generate a new Module
+ *
+ * Class ModuleGenerateCommand
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class ModuleGenerateCommand extends BaseModuleGenerate
 {
     protected function configure()

core/lib/Thelia/Command/ModuleGenerateModelCommand.php

@@ -31,6 +31,13 @@ use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
+/**
+ * generate class model for a specific module
+ *
+ * Class ModuleGenerateModelCommand
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class ModuleGenerateModelCommand extends BaseModuleGenerate
 {
     protected function configure()

core/lib/Thelia/Command/ModuleGenerateSqlCommand.php

@@ -30,6 +30,13 @@ use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
+/**
+ * generate sql for a specific module
+ *
+ * Class ModuleGenerateSqlCommand
+ * @package Thelia\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class ModuleGenerateSqlCommand extends BaseModuleGenerate
 {
     public function configure()

core/lib/Thelia/Core/Application.php

@@ -29,6 +29,12 @@ use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 
+/**
+ * cli application for Thelia
+ * Class Application
+ * @package Thelia\Core
+ * mfony\Component\HttpFoundation\Session\Session
+ */
 class Application extends BaseApplication
 {
 

core/lib/Thelia/Core/DependencyInjection/Compiler/RegisterListenersPass.php

@@ -31,6 +31,7 @@ use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  * @package Thelia\Core\DependencyInjection\Compiler
  *
  * Source code come from Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RegisterKernelListenersPass class
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
  */
 class RegisterListenersPass implements CompilerPassInterface
 {

core/lib/Thelia/Core/DependencyInjection/Compiler/RegisterParserPluginPass.php

@@ -31,7 +31,7 @@ use Symfony\Component\DependencyInjection\Reference;
  * Register parser plugins. These plugins shouild be tagged thelia.parser.register_plugin
  * in the configuration.
  *
- *
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
  */
 class RegisterParserPluginPass implements CompilerPassInterface
 {

core/lib/Thelia/Core/DependencyInjection/Compiler/RegisterRouterPass.php

@@ -28,6 +28,14 @@ use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\DependencyInjection\Reference;
 
+/**
+ *
+ * this compiler can add many router to symfony-cms routing
+ *
+ * Class RegisterRouterPass
+ * @package Thelia\Core\DependencyInjection\Compiler
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class RegisterRouterPass implements CompilerPassInterface
 {
 

core/lib/Thelia/Core/DependencyInjection/Loader/XmlFileLoader.php

@@ -36,6 +36,14 @@ use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Loader\FileLoader;
 
+/**
+ *
+ * Load, read and validate config xml files
+ *
+ * Class XmlFileLoader
+ * @package Thelia\Core\DependencyInjection\Loader
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class XmlFileLoader extends FileLoader
 {
     /**

core/lib/Thelia/Core/EventListener/ControllerListener.php

@@ -36,6 +36,7 @@ use Thelia\Core\Template\ParserContext;
  *
  * Class ControllerListener
  * @package Thelia\Core\EventListener
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
  */
 class ControllerListener implements EventSubscriberInterface
 {

core/lib/Thelia/Core/Factory/ActionEventFactory.php

@@ -25,6 +25,14 @@ namespace Thelia\Core\Factory;
 
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * *
+ * try to instanciate the good action class
+ *
+ * Class ActionEventFactory
+ * @package Thelia\Core\Factory
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class ActionEventFactory
 {
 

core/lib/Thelia/Core/HttpFoundation/Request.php

@@ -24,6 +24,13 @@ namespace Thelia\Core\HttpFoundation;
 
 use Symfony\Component\HttpFoundation\Request as BaseRequest;
 
+/**
+ * extends Symfony\Component\HttpFoundation\Request for adding some helpers
+ *
+ * Class Request
+ * @package Thelia\Core\HttpFoundation
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class Request extends BaseRequest
 {
 

core/lib/Thelia/Core/HttpFoundation/Session/Session.php

@@ -30,6 +30,14 @@ use Thelia\Model\CartQuery;
 use Thelia\Model\Cart;
 use Thelia\Tools\URL;
 
+/**
+ *
+ * extends mfony\Component\HttpFoundation\Session\Session for adding some helpers
+ *
+ * Class Session
+ * @package Thelia\Core\HttpFoundation\Session
+ * Symfony\Component\HttpFoundation\Request
+ */
 class Session extends BaseSession
 {
     // -- Language ------------------------------------------------------------

core/lib/Thelia/Core/Thelia.php

@@ -26,7 +26,7 @@ namespace Thelia\Core;
 /**
  * Root class of Thelia
  *
- * It extends Symfony\Component\HttpKernel\Kernel for changing some fonctionnality
+ * It extends Symfony\Component\HttpKernel\Kernel for changing some features
  *
  *
  * @author Manuel Raynaud <mraynaud@openstudio.fr>

core/lib/Thelia/Core/TheliaContainerBuilder.php

@@ -25,6 +25,13 @@ namespace Thelia\Core;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
+/**
+ * extends Symfony\Component\DependencyInjection\ContainerBuilder for changing some behavior
+ *
+ * Class TheliaContainerBuilder
+ * @package Thelia\Core
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class TheliaContainerBuilder extends ContainerBuilder
 {
 

core/lib/Thelia/Form/BaseForm.php

@@ -32,6 +32,13 @@ use Symfony\Component\Validator\Validation;
 use Thelia\Model\ConfigQuery;
 use Thelia\Tools\URL;
 
+/**
+ * Base form class for creating form objects
+ *
+ * Class BaseForm
+ * @package Thelia\Form
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 abstract class BaseForm
 {
     /**

core/lib/Thelia/Form/CartAdd.php

@@ -30,6 +30,11 @@ use Thelia\Model\ProductSaleElementsQuery;
 use Thelia\Model\ConfigQuery;
 use Thelia\Model\ProductQuery;
 
+/**
+ * Class CartAdd
+ * @package Thelia\Form
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class CartAdd extends BaseForm
 {
 

core/lib/Thelia/Form/CustomerCreation.php

@@ -27,6 +27,11 @@ use Symfony\Component\Validator\ExecutionContextInterface;
 use Thelia\Model\ConfigQuery;
 use Thelia\Model\CustomerQuery;
 
+/**
+ * Class CustomerCreation
+ * @package Thelia\Form
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class CustomerCreation extends BaseForm
 {
 

core/lib/Thelia/Form/CustomerModification.php

@@ -25,6 +25,11 @@ namespace Thelia\Form;
 
 use Symfony\Component\Validator\Constraints;
 
+/**
+ * Class CustomerModification
+ * @package Thelia\Form
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class CustomerModification extends BaseForm
 {
     /**

core/lib/Thelia/Tests/Cart/CartTraitTest.php

@@ -34,6 +34,7 @@ use Thelia\Model\Customer;
  *
  * Class CartTraitTest
  * @package Thelia\Tests\Cart\CartTraitTest
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
  */
 class CartTraitTest extends \PHPUnit_Framework_TestCase
 {

core/lib/Thelia/Tests/Command/BaseCommandTest.php

@@ -22,6 +22,13 @@
 /*************************************************************************************/
 namespace Thelia\Tests\Command;
 
+/**
+ * base class for testing command line command
+ *
+ * Class BaseCommandTest
+ * @package Thelia\Tests\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 abstract class BaseCommandTest extends \PHPUnit_Framework_TestCase
 {
     public function getKernel()

core/lib/Thelia/Tests/Command/CacheClearTest.php

@@ -28,6 +28,13 @@ use Thelia\Command\CacheClear;
 
 use Symfony\Component\Filesystem\Filesystem;
 
+/**
+ * test the cache:clear command
+ *
+ * Class CacheClearTest
+ * @package Thelia\Tests\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class CacheClearTest extends \PHPUnit_Framework_TestCase
 {
 

core/lib/Thelia/Tests/Command/ModuleGenerateCommandTest.php

@@ -27,6 +27,13 @@ use Symfony\Component\Filesystem\Filesystem;
 use Thelia\Core\Application;
 use Thelia\Command\ModuleGenerateCommand;
 
+/**
+ * test the module:generate command
+ *
+ * Class ModuleGenerateCommandTest
+ * @package Thelia\Tests\Command
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class ModuleGenerateCommandTest extends BaseCommandTest
 {
     protected $command;

core/lib/Thelia/Tests/Controller/DefaultControllerTest.php

@@ -26,6 +26,11 @@ namespace Thelia\Tests\Controller;
 use Symfony\Component\HttpFoundation\Request;
 use Thelia\Controller\Front\DefaultController;
 
+/**
+ * Class DefaultControllerTest
+ * @package Thelia\Tests\Controller
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class DefaultControllerTest extends \PHPUnit_Framework_TestCase
 {
 

core/lib/Thelia/Tests/Core/HttpFoundation/RequestTest.php

@@ -4,6 +4,13 @@ namespace Thelia\Tests\Core\HttpFoundation;
 
 use Thelia\Core\HttpFoundation\Request;
 
+/**
+ * the the helpers addinf in Request class
+ *
+ * Class RequestTest
+ * @package Thelia\Tests\Core\HttpFoundation
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class RequestTest extends \PHPUnit_Framework_TestCase
 {
 

core/lib/Thelia/Tests/Core/HttpFoundation/Session/SessionTest.php

@@ -28,6 +28,13 @@ use Thelia\Core\HttpFoundation\Session\Session;
 use Thelia\Model\Cart;
 use Thelia\Model\Customer;
 
+/**
+ * Test the helpers adding in Session class
+ *
+ * Class SessionTest
+ * @package Thelia\Tests\Core\HttpFoundation\Session
+ * @author Manuel Raynaud <mraynaud@openstudio.fr>
+ */
 class SessionTest extends \PHPUnit_Framework_TestCase
 {