Update docs

Author: curry684

README.md

@@ -9,66 +9,18 @@
 [![SensioLabs Insight](https://img.shields.io/sensiolabs/i/05d79ba2-cba4-4201-a17a-2868c51f9c6c.svg)](https://insight.sensiolabs.com/projects/05d79ba2-cba4-4201-a17a-2868c51f9c6c)
 
 This bundle provides convenient integration of the popular [DataTables](https://datatables.net/) jQuery library
-for realtime AJAX tables in your Symfony 3.3+ or 4.0+ application. Older versions of Symfony [will not be supported](https://github.com/omines/datatables-bundle/issues/1).
+for realtime Ajax tables in your Symfony 3.3+ or 4.0+ application.
 
 Unlike other bundles providing similar functionality we decoupled the implementation of the DataTables logic
 completely from the source of the data. Therefore it is possible to implement your own custom adapters for
 every possible data source. Doctrine ORM comes bundled already, we intend to provide popular choices like
 Elastica, Doctrine DBAL and MongoDB out of the box as well. 
 
-## Installation
+## Documentation
 
-To install, use composer:
+[Visit the documentation with extensive code samples](https://omines.github.io/datatables-bundle/).
 
-```bash
-$ composer require omines/datatables-bundle
-```
-Then add the bundle to your kernel's bundle registration:
-```php
-public function registerBundles()
-{
-    ...
-    new \Omines\DataTablesBundle\DataTablesBundle(),
-    ...
-}
-```
-
-## Usage
-
-To render the most basic table with predefined data, implement a controller like this:
-```php
-use Omines\DataTablesBundle\DataTablesTrait;
-use Omines\DataTablesBundle\Adapter\ArrayAdapter;
-use Omines\DataTablesBundle\Column\TextColumn;
-
-class MyController
-{
-    use DataTablesTrait;
-    
-    public function showAction(Request $request)
-    {
-        $table = $this->createDataTable()
-            ->add('firstName', TextColumn::class)
-            ->add('lastName', TextColumn::class)
-            ->createAdapter(ArrayAdapter::class, [
-                ['firstName' => 'Donald', 'lastName' => 'Trump'],
-                ['firstName' => 'Barack', 'lastName' => 'Obama'],
-            ])
-            ->handleRequest($request);
-        
-        if ($request->isXmlHttpRequest()) {
-            return $table->getResponse();
-        }
-        
-        $this->render('list.html.twig', ['datatable' => $table]);
-    }
-}
-
-```
-Now in your Twig template render the required HTML and JS with:
-```twig
-{{ datatable(datatable)) }}
-```
+The documentation below is pending move to the external site.
 
 #### Making a separate datatable type
 

docs/source/index.html.md

@@ -77,12 +77,12 @@ class MyController extends Controller
 ```
 This trivial bit of code in your controller prepares a fully functional DataTables instance for use.
 
-The <code>DataTablesTrait</code> is included to expose 2 methods in your controller for easy instantiation.
-The `createDataTable` function is used in this example, the other one will be covered later. On the DataTable
-instance we add 2 columns of type `TextColumn`, and we bind it to an adapter providing a static array as the
+The optional <code>DataTablesTrait</code> is included to expose convenience methods in your controller for
+easy instantiation. The `createDataTable` function is used in this example. On the DataTable instance we 
+add 2 columns of type `TextColumn`, and we bind it to an adapter providing a static array as the
 source of the data.
 
-The `handleRequest` function will take care of handling any postbacks, similar to how Symfony's Form component
+The `handleRequest` function will take care of handling any callbacks, similar to how Symfony's Form component
 works. If it turns out the request originated from a callback we let the table provide the controller response,
 otherwise we render a template with the table provided as a parameter.
 
@@ -111,9 +111,67 @@ string with the configured settings required for initialization.
 
 And that's it, the library will take it from here and your table will be shown on your webpage!
 
-# Options
+# Configuration
 
-Option | Default | Description
------- | ------- | -----------
-name   | dt      | The name of the DataTable. Used mainly to separate callbacks in case multiple tables are used on the same page.
+```yaml
+datatables:
 
+    # Load i18n data from DataTables CDN or locally
+    language_from_cdn:    true
+
+    # Persist request state automatically
+    request_state:        true
+
+    # Default class attribute to apply to the root table elements
+    class_name:           ~
+
+    # Default HTTP method to be used for callbacks
+    method:               POST # One of "GET"; "POST"
+
+    # Default translation domain to be used
+    translation_domain:   messages
+
+    # If and where to enable the DataTables Filter module
+    column_filter:        null # One of "thead"; "tfoot"; "both"; null
+
+    # Default options to load into DataTables
+    options:
+        # Default table options
+
+    # Default template to be used for DataTables HTML
+    template:             ~
+
+    # Default service used to render templates
+    renderer:             Omines\DataTablesBundle\Twig\TwigRenderer
+```
+
+Global configuration of the bundle is done in your config file. The default configuration is shown here,
+and should be fine in most cases. Most settings can be overridden per table, but for most applications
+you will want to make changes at the global level so they are applied everywhere, providing a uniform
+look and feel.
+
+The following settings only exist at the configuration level:
+
+Option | Type | Description
+------ | ---- | ------- | -----------
+template | string | Default template to be used for rendering the basic HTML table in your templates.
+renderer | string | Service used to render the table HTML, which must implement the <code>DataTableRendererInterface</code>.  
+
+The other settings correspond to table level settings, and the `options` are passed (almost) verbatim
+to the DataTables clientside constructor. Refer to the sections below for details on individual settings
+and options.
+
+## Settings
+
+These settings can all be defined both at the global config level and overridden per table.
+
+Setting | Type | Default | Description
+------- | ---- | ------- | -----------
+name   | string | dt | The name of the DataTable. Used mainly to separate callbacks in case multiple tables are used on the same page.
+method | string | POST | Use `GET` or `POST` to define the HTTP method used by callbacks.
+class_name | string | | Class to apply to the `<table>` element in generated tables. Separate multiple classes with a space.
+column_filter | string | *null* | When using column level filters set this to `thead`, `tfoot` or `both` to specify where to render them.
+language_from_cdn | bool | true | Either loads DataTables' own translations from CDN (default) or have them provided by your own Symfony translation files.
+translation_domain | string | messages | Default translation domain used in the table structure.
+
+## Options

tests/Fixtures/AppBundle/Controller/CustomQueryController.php

@@ -15,6 +15,7 @@
 use Omines\DataTablesBundle\Controller\DataTablesTrait;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Tests\Fixtures\AppBundle\DataTable\Type\CustomQueryTableType;
 
 /**
@@ -29,7 +30,10 @@ class CustomQueryController extends Controller
     public function tableAction(Request $request)
     {
         $datatable = $this->createDataTableFromType(CustomQueryTableType::class, [], ['method' => Request::METHOD_GET]);
+        if ($datatable->handleRequest($request)->isCallback()) {
+            return $datatable->getResponse();
+        }
 
-        return $datatable->handleRequest($request)->getResponse();
+        throw new NotFoundHttpException('This exception must never be triggered');
     }
 }