Skip to content

Commit e87c5a3

Browse files
yajrayajra
committed
Initial commit.
0 parents  commit e87c5a3

8 files changed

+222
-0
lines changed

‎contributing.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/yajra/laravel-datatables).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11+
12+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
13+
14+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
15+
16+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
17+
18+
19+
**Happy coding**!

‎debugger.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Debugging Mode
2+
3+
To enable debugging mode, just set ```APP_DEBUG=true``` and the package will include the queries and inputs used when processing the table.
4+
5+
> IMPORTANT: Please make sure that APP_DEBUG is set to false when your app is on production.

‎documentation.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
- Setup
2+
- [Installation](/docs/laravel-datatables/{{version}}/installation)
3+
- Getting Started
4+
- [Introduction](/docs/laravel-datatables/{{version}}/introduction)
5+
- Configuration
6+
- [Package Options](/docs/laravel-datatables/{{version}}/general-settings)
7+
- [Debugging Mode](/docs/laravel-datatables/{{version}}/debugger)
8+
- Others
9+
- [Security](/docs/laravel-datatables/{{version}}/security)
10+
- [Contributing](/docs/laravel-datatables/{{version}}/contributing)

‎general-settings.md

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# General Settings
2+
3+
You can change the package behavior by updating the configuration file.
4+
5+
The configuration file can be found at `config/datatables.php`.
6+
7+
```php
8+
// config/datatables.php
9+
10+
return [
11+
/**
12+
* DataTables search options.
13+
*/
14+
'search' => [
15+
/**
16+
* Smart search will enclose search keyword with wildcard string "%keyword%".
17+
* SQL: column LIKE "%keyword%"
18+
*/
19+
'smart' => true,
20+
21+
/**
22+
* Case insensitive will search the keyword in lower case format.
23+
* SQL: LOWER(column) LIKE LOWER(keyword)
24+
*/
25+
'case_insensitive' => true,
26+
27+
/**
28+
* Wild card will add "%" in between every characters of the keyword.
29+
* SQL: column LIKE "%k%e%y%w%o%r%d%"
30+
*/
31+
'use_wildcards' => false,
32+
],
33+
34+
/**
35+
* DataTables fractal configurations.
36+
*/
37+
'fractal' => [
38+
/**
39+
* Request key name to parse includes on fractal.
40+
*/
41+
'includes' => 'include',
42+
43+
/**
44+
* Default fractal serializer.
45+
*/
46+
'serializer' => 'League\Fractal\Serializer\DataArraySerializer',
47+
],
48+
49+
/**
50+
* DataTables script view template.
51+
*/
52+
'script_template' => 'datatables::script',
53+
54+
/**
55+
* DataTables internal index id response column name.
56+
*/
57+
'index_column' => 'DT_Row_Index',
58+
59+
/**
60+
* Namespaces used by the generator.
61+
*/
62+
'namespace' => [
63+
/**
64+
* Base namespace/directory to create the new file.
65+
* This is appended on default Laravel namespace.
66+
* Usage: php artisan datatables:make User
67+
* Output: App\DataTables\UserDataTable
68+
* With Model: App\User (default model)
69+
* Export filename: users_timestamp
70+
*/
71+
'base' => 'DataTables',
72+
73+
/**
74+
* Base namespace/directory where your model's are located.
75+
* This is appended on default Laravel namespace.
76+
* Usage: php artisan datatables:make Post --model
77+
* Output: App\DataTables\PostDataTable
78+
* With Model: App\Post
79+
* Export filename: posts_timestamp
80+
*/
81+
'model' => '',
82+
],
83+
84+
/**
85+
* PDF generator to be used when converting the table to pdf.
86+
* Available generators: excel, snappy
87+
* Snappy package: barryvdh/laravel-snappy
88+
* Excel package: maatwebsite/excel
89+
*/
90+
'pdf_generator' => 'excel',
91+
92+
/**
93+
* Snappy PDF options.
94+
*/
95+
'snappy' => [
96+
'options' => [
97+
'no-outline' => true,
98+
'margin-left' => '0',
99+
'margin-right' => '0',
100+
'margin-top' => '10mm',
101+
'margin-bottom' => '10mm',
102+
],
103+
'orientation' => 'landscape',
104+
],
105+
];
106+
];
107+
```

‎installation.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Installation
2+
3+
- [Installation](#installation)
4+
- [Requirements](#requirements)
5+
- [Installing Laravel-Datatables](#installing-laravel-datatables-oracle)
6+
- [Configuration](#configuration)
7+
8+
<a name="installation"></a>
9+
## Installation
10+
11+
<a name="requirements"></a>
12+
### Requirements
13+
14+
- [PHP >=5.5.9](http://php.net/)
15+
- [Laravel 5.0 or later](https://github.com/laravel/framework)
16+
- [DataTables jQuery Plugin Version 1.10.x](http://datatables.net/)
17+
18+
<a name="installing-laravel-datatables-oracle"></a>
19+
### Installing Laravel Datatables
20+
21+
Laravel Datatables can be installed with [Composer](http://getcomposer.org/doc/00-intro.md). More details about this package in Composer can be found [here](https://packagist.org/packages/yajra/laravel-datatables-oracle).
22+
23+
Run the following command in your project to get the latest version of the package:
24+
25+
```
26+
composer require yajra/laravel-datatables-oracle
27+
```
28+
29+
<a name="configuration"></a>
30+
### Configuration
31+
32+
Open the file ```config/app.php``` and then add following service provider.
33+
34+
```php
35+
'providers' => [
36+
// ...
37+
Yajra\Datatables\DatatablesServiceProvider::class,
38+
],
39+
```
40+
41+
After completing the step above, use the following command to publish configuration & assets:
42+
43+
```
44+
php artisan vendor:publish --tag=datatables
45+
```
46+

‎introduction.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Introduction
2+
3+
## jQuery DataTables API for Laravel
4+
This package is created to handle server-side works of DataTables jQuery Plugin via AJAX option by using the following engines:
5+
- Eloquent ORM
6+
- Fluent Query Builder
7+
- Collection.
8+
9+
```php
10+
use Yajra\Datatables\Facades\Datatables;
11+
12+
// Using Eloquent
13+
return Datatables::eloquent(User::query())->make(true);
14+
15+
// Using Query Builder
16+
return Datatables::queryBuilder(DB::table('users'))->make(true);
17+
18+
// Using Collection
19+
return Datatables::collection(User::all())->make(true);
20+
21+
// Using the Engine Factory
22+
return Datatables::of(User::query())->make(true);
23+
return Datatables::of(DB::table('users'))->make(true);
24+
return Datatables::of(User::all())->make(true);
25+
```

‎readme.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Laravel Datatables Documentation
2+
3+
## Contribution Guidelines
4+
5+
If you are submitting documentation for the **current stable release**, submit it to the corresponding branch.
6+
For example, documentation for Laravel Datatables 5.1 would be submitted to the `5.1` branch.
7+
Documentation intended for the next release of Laravel Datatables should be submitted to the `master` branch.

‎security.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security
2+
3+
If you discover any security related issues, please email [aqangeles@gmail.com](mailto:aqangeles@gmail.com) instead of using the issue tracker.

0 commit comments

Comments
 (0)