updated docs

Author: phpsa

README.md

@@ -99,10 +99,6 @@ in your controller override the following params:
 
 ## Filtering
 
-
-
-
-
  ### stable option that will be removed once experimental stable
 
 For the get command you can filter by using the following url patterns
@@ -146,28 +142,28 @@ Add to your allowedScopes and can then be called in url as `?ageNull=1` for wher
 
 
 
-### Experimental v5 currently
+### Filtering 
 
 - use the url pattern `filters[column][operator]=value` eg `filters[age][>]=18&filters[title][contains]=testing`
 
 | Seperator | Description                                     | Example                | Result                                    |
 | --------- | ----------------------------------------------- | ---------------------- | ----------------------------------------- |
 | empty / _`=`_ / `is` / `equals`    | Equals                                          | ?filters[field]=hello / ?filters[field][is]=hello  | select ... where field = 'hello'          |
-| _`!=`_ / `!is` / `!equals` / `not_equals`  | Not Equals                                      | ?filter[field][!is]=hello  | select ... where field != 'hello'         |
-| _`>`_ / `greater_than`    | Greater Than                                    | ?filter[field][greater_than]=5      | select ... where field > 5                |
-| _`>=`_ / `greater_than_or_equal_to` / `greater_or_equal` / `gte`  | Greater Or Equal to                             | ?filter[field][greater_or_equal]=5     | select ... where field >= 5               |
-| _`<`_  / `less_than`   | Less Than                                       | ?filter[field][<]=5      | select ... where field <> 5               |
-| _`<=`_ / `less_than_or_equal_to` / `less_or_equal` / `lte`  | Less Or Equal to                                | ?filter[field][less_or_equal]=5     | select ... where field <= 5               |
-| _`~`_  / `contains`   | Contains (LIKE with wildcard on both sides)     | ?filter[field][contains]=hello  | select ... where field like '%hello%'     |
-| _`^`_  / `starts_with`   | Starts with (LIKE with wildcard on end)         | ?filter[field][starts_with]=hello  | select ... where field like 'hello%'      |
-| _`$`_  / `ends_with`   | Ends with (LIKE with wildcard on start)         | ?filter[field][ends_with]=hello  | select ... where field like 'hello%'      |
-| _`!~`_ / `!contains` / `not_contains`  | Not Contains (LIKE with wildcard on both sides) | ?filter[field][!contains]=hello | select ... where field not like '%hello%' |
-| _`!^`_ / `!starts_with` / `not_starts_with`   | Not Starts with (LIKE with wildcard on end)     | ?filter[field][!^]=hello | select ... where field not like 'hello%'  |
-| _`!$`_ / `!ends_with` /   `not_ends_with`   | Not Ends with (LIKE with wildcard on start)     | ?filter[field][!$]=hello | select ... where field not like 'hello%'  |
-| `in`   | in    | ?filter[field][in]=1,2,3 | select ... where field in(1,2,3)  |
-| `not_in`  / `!in`  | NOT in    | ?filter[field][in]=1,2,3 | select ... where field not in(1,2,3)  |
-| `has`   | has    | ?filter[field][has] | select ... where exists(field join)  |
-| `not_has`  / `!has`  | NOT has    | ?filter[field][!has] | select ... where not exists (field join)  |
+| _`!=`_ / `!is` / `!equals` / `not_equals`  | Not Equals                                      | ?filters[field][!is]=hello  | select ... where field != 'hello'         |
+| _`>`_ / `greater_than`    | Greater Than                                    | ?filters[field][greater_than]=5      | select ... where field > 5                |
+| _`>=`_ / `greater_than_or_equal_to` / `greater_or_equal` / `gte`  | Greater Or Equal to                             | ?filters[field][greater_or_equal]=5     | select ... where field >= 5               |
+| _`<`_  / `less_than`   | Less Than                                       | ?filters[field][<]=5      | select ... where field <> 5               |
+| _`<=`_ / `less_than_or_equal_to` / `less_or_equal` / `lte`  | Less Or Equal to                                | ?filters[field][less_or_equal]=5     | select ... where field <= 5               |
+| _`~`_  / `contains`   | Contains (LIKE with wildcard on both sides)     | ?filters[field][contains]=hello  | select ... where field like '%hello%'     |
+| _`^`_  / `starts_with`   | Starts with (LIKE with wildcard on end)         | ?filters[field][starts_with]=hello  | select ... where field like 'hello%'      |
+| _`$`_  / `ends_with`   | Ends with (LIKE with wildcard on start)         | ?filters[field][ends_with]=hello  | select ... where field like 'hello%'      |
+| _`!~`_ / `!contains` / `not_contains`  | Not Contains (LIKE with wildcard on both sides) | ?filters[field][!contains]=hello | select ... where field not like '%hello%' |
+| _`!^`_ / `!starts_with` / `not_starts_with`   | Not Starts with (LIKE with wildcard on end)     | ?filters[field][!^]=hello | select ... where field not like 'hello%'  |
+| _`!$`_ / `!ends_with` /   `not_ends_with`   | Not Ends with (LIKE with wildcard on start)     | ?filters[field][!$]=hello | select ... where field not like 'hello%'  |
+| `in`   | in    | ?filters[field][in]=1,2,3 | select ... where field in(1,2,3)  |
+| `not_in`  / `!in`  | NOT in    | ?filters[field][in]=1,2,3 | select ... where field not in(1,2,3)  |
+| `has`   | has    | ?filters[field][has] | select ... where exists(field join)  |
+| `not_has`  / `!has`  | NOT has    | ?filters[field][!has] | select ... where not exists (field join)  |
 
 * Null = `filters[age]=NULL` will generate `where age is null`
 
@@ -386,6 +382,16 @@ you can override responses for each point by overriding the following protected
 - handleUpdateResponse
 - handleDestroyResponse
 
+## Perforance Tips
+
+### Cache Table column definitions
+-- introduced https://github.com/phpsa/laravel-api-controller/pull/118/files
+add the ability to cache the table definitions to reduce calls to fetch table columns, to enable either enable in the config file or set the `PHPSA_API_CACHE_TABLE_COLUMNS` variable to true.
+
+### Raw Pagination gets
+
+-- handleIndexAction will use full eloquent models, handleIndexActionRaw will bypass eloquent and use raw responses from the database.
+
 ## Security
 
 If you discover any security related issues, please email