├── .gitignore ├── README.md ├── SUMMARY.md ├── checklist.md ├── section-1.md ├── section-2.md ├── section-3.md ├── section-4.md ├── section-5.md └── section-6.md /.gitignore: -------------------------------------------------------------------------------- 1 | # Node rules: 2 | ## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 3 | .grunt 4 | 5 | ## Dependency directory 6 | ## Commenting this out is preferred by some people, see 7 | ## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git 8 | node_modules 9 | 10 | # Book build output 11 | _book 12 | 13 | # eBook build output 14 | *.epub 15 | *.mobi 16 | *.pdf -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Laravel Cookbook 2 | 3 | Laravel Cookbook based on author experiences in teaching Laravel Framework. This book intended to simplify the understanding on how to develop web applications with Laravel Framework. 4 | 5 | ## [Section 1: Data Preparation](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-1.md) 6 | 7 | In this section, developers will be exposed, how to prepare your data from scratch. Following are the basic steps in preparing data. 8 | 9 | 1. Create model & migration script 10 | 2. Setup Migration Script Schema 11 | 3. Setup Fillable 12 | 4. Run Migration Scripts 13 | 5. Setup Factory 14 | 6. Setup Seeder 15 | 7. Seed the Data 16 | 8. Seed the Data via Tinker 17 | 18 | ## [Section 2: How to create a page?](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-2.md) 19 | 20 | In web applications development, creating pages, we have a standard operation procedure \(SOP\). Following are the SOP and user cases in creating pages across web applications. 21 | 22 | 1. Route, View\(closure\) 23 | 2. Route, Controller & View \(string\) 24 | 3. Route, Controller & View \(blade template\) 25 | 4. Route, Controller, View \(Blade\), Data \(Eloquent\) 26 | 27 | ## [Section 3: Form and Validation](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-3.md) 28 | 29 | Forms and Validations are most common components in web applications development. In this section, developer should grasp the fundamental of creating forms and validations. 30 | 31 | 1. Form - Create, Update & Delete 32 | 2. Validation 33 | 1. Controller 34 | 2. Custom Request 35 | 36 | ## [Section 4: Relationship](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-4.md) 37 | 38 | Database design is the most critical and fundamental in web applications development. Managing relationship between tables is critical. In this section, developers should be able to grasp the SOP fo creating relationships between tables and how to query the data. Following are the basic relationships covered in this section. 39 | 40 | 1. One-to-one 41 | 2. One-to-many 42 | 3. Many-to-one 43 | 4. Many-to-many 44 | 45 | ## [Section 5: Common Request](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-5.md) 46 | 47 | Following are the common request in developing web applications. 48 | 49 | 1. Setup Multilingual 50 | 2. Setup Custom Validation Messages 51 | 52 | ## [Section 6: Intermediate Request](https://github.com/nasrulhazim/laravel-cookbook/blob/master/section-6.md) 53 | 54 | This section covered request from intermediate level developers. 55 | 56 | 1. Middleware 57 | 58 | ## [Checklist](https://github.com/nasrulhazim/laravel-cookbook/blob/master/checklist.md) 59 | 60 | In this section, the author have come up questions checklist as a test, to check either developers know and understand how to develop web applications with Laravel Framework. 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | * [Introduction](README.md) 4 | * [Section 1: Data Preparation](section-1.md) 5 | * [Section 2: How to create a page?](section-2.md) 6 | * [Section 3: Form and Validation](section-3.md) 7 | * [Section 4: Relationship](section-4.md) 8 | * [Section 5: Common Request](section-5.md) 9 | * [Section 6: Intermediate Request](section-6.md) 10 | * [Checklist](checklist.md) 11 | 12 | -------------------------------------------------------------------------------- /checklist.md: -------------------------------------------------------------------------------- 1 | # Checklist 2 | 3 | * [ ] How to create a new Laravel project? 4 | * [ ] How to create a page? 5 | * [ ] How to create a route? 6 | * [ ] How to create a controller? 7 | * [ ] How to create a view? 8 | * [ ] How to create users from tinker? 9 | * [ ] How to read a record? 10 | * [ ] How to read records? 11 | * [ ] How to create pagination? 12 | * [ ] How to create a form? 13 | * [ ] How to validate form using Request? 14 | * [ ] How to validate form in Controller? 15 | * [ ] How to insert a new record? 16 | * [ ] How to update a record? 17 | * [ ] How to create method spoofing? 18 | * [ ] How to get error messages from validators? 19 | * [ ] How to create a model and migration script together? 20 | * [ ] How to create a model factory? 21 | * [ ] How to create seeder file? 22 | * [ ] How to call model factory in seeder file? 23 | * [ ] How to call seeder file in `DatabaseSeeder.php`? 24 | * [ ] How to seed data? 25 | * [ ] How to create relationship? 26 | * [ ] How to setup custom validation error messages? 27 | * [ ] How to setup localization? 28 | * [ ] How to setup custom validation error messages with localization support? 29 | * [ ] How to register middleware? 30 | * [ ] How to use middleware? 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /section-1.md: -------------------------------------------------------------------------------- 1 | # Section 1: Data Preparation 2 | 3 | ## Create Model & Migration Script 4 | 5 | Run following command in terminal: 6 | 7 | ``` 8 | php artisan make:model Post -m 9 | ``` 10 | 11 | This will create a model named `Post.php` in `app` folder and a migration script `timestamp_create_posts_table.php` in `database\migrations` folder. 12 | 13 | ## Setup Migration Script Schema 14 | 15 | Open up your `timestamp_create_posts_table.php` in `database\migrations` folder and update the schema accordingly. 16 | 17 | ```php 18 | Schema::create('posts', function (Blueprint $table) { 19 | $table->increments('id'); 20 | $table->string('post'); 21 | $table->timestamps(); 22 | }); 23 | ``` 24 | 25 | Read more about [Creating Columns](https://laravel.com/docs/5.3/migrations#creating-columns) 26 | 27 | ## Setup Fillable 28 | 29 | In order to user `Post::create()` method, you need to define the `$fillable` property of the model class. 30 | 31 | ```php 32 | protected $fillable = [ 33 | 'post', 34 | ]; 35 | ``` 36 | 37 | ## Run Migration Scripts 38 | 39 | Run the following command to check the migration status: 40 | 41 | ``` 42 | php artisan migrate:status 43 | ``` 44 | 45 | If there's still `N` status, you can run the following command to run the migration scripts. 46 | 47 | ``` 48 | php artisan migrate 49 | ``` 50 | 51 | ## Setup Factory 52 | 53 | Where you define your data format, how it should be inserted when calling it from `factory()` helper. 54 | 55 | ```php 56 | $factory->define(App\Post::class, function (Faker\Generator $faker) { 57 | return [ 58 | 'post' => $faker->sentence, 59 | ]; 60 | }); 61 | ``` 62 | 63 | ## Setup Seeder 64 | 65 | Create a seeder file using following command: 66 | 67 | ```php 68 | php artisan make:seeder PostTableSeeder 69 | ``` 70 | 71 | Open `PostTableSeeder.php` located at `database\seeds` folder and call the factory for `Post`, as following in `run` method: 72 | 73 | ```php 74 | factory(\App\Post::class, 100)->create(); 75 | ``` 76 | 77 | ### How to Seed Data 78 | 79 | There's three ways in seeding data. 80 | 81 | #### Method 1 82 | 83 | Following command will seed data by calling `DatabaseSeeder.php`: 84 | 85 | ``` 86 | php artisan db:seed 87 | ``` 88 | 89 | #### Method 2 90 | 91 | Following command will seed data by calling seeder class name: 92 | 93 | ``` 94 | php artisan db:seed --class=PostSeeder 95 | ``` 96 | 97 | #### Method 3 98 | 99 | Following command will seed data after do the migration: 100 | 101 | ``` 102 | php artisan migrate --seed 103 | ``` 104 | 105 | -------------------------------------------------------------------------------- /section-2.md: -------------------------------------------------------------------------------- 1 | # Section 2: How to create a page 2 | 3 | ## Route 4 | 5 | Set Route - `routes/web.php` 6 | 7 | ```php 8 | Route::get('about-us','PageController@aboutUs') 9 | ``` 10 | 11 | ## Controller 12 | 13 | Create a controller - `php artisan make:controller PageController --resource` - and create a method `aboutUs` returning view from `pages.index`. 14 | 15 | ```php 16 | public function aboutUs() 17 | { 18 | return view('pages.index'); 19 | } 20 | ``` 21 | 22 | ### Pass Data to Blade Template 23 | 24 | There's 3 methods available on how to pass data from controller to blade template. 25 | 26 | #### Method 1 27 | 28 | ```php 29 | public function aboutUs() 30 | { 31 | $company = 'Cleanique Coders Resources'; 32 | $founder = 'Nasrul Hazim'; 33 | 34 | return view('pages.index') 35 | ->with('company', $company) 36 | ->with('founder', $founder); 37 | } 38 | ``` 39 | 40 | #### Method 2 41 | 42 | ```php 43 | public function aboutUs() 44 | { 45 | $company = 'Cleanique Coders Resources'; 46 | $founder = 'Nasrul Hazim'; 47 | 48 | return view('pages.index',[ 49 | 'company' => $company, 50 | 'founder' => $founder, 51 | ]); 52 | } 53 | ``` 54 | 55 | 56 | #### Method 3 57 | 58 | ```php 59 | public function aboutUs() 60 | { 61 | $company = 'Cleanique Coders Resources'; 62 | $founder = 'Nasrul Hazim'; 63 | 64 | return view('pages.index',compact('company','founder')); 65 | } 66 | ``` 67 | 68 | ## View 69 | 70 | Create the view - create new folder in `resources/views/` named `pages`. In `pages`, create `aboutUs.blade.php`. Add the following content: 71 | 72 | ```html 73 | @extends('layouts.app') 74 | 75 | @section('content') 76 |
77 |
78 |

About Us

79 |
80 |
81 | @endsection 82 | ``` 83 | -------------------------------------------------------------------------------- /section-3.md: -------------------------------------------------------------------------------- 1 | # Section 3: Form and Validation 2 | 3 | # Form 4 | 5 | Basic requirement to create a form 6 | 7 | - [ ] Form Element 8 | - [ ] Action - Form submission to where, basically a URL. 9 | - [ ] Method 10 | - [ ] CSRF Token 11 | - [ ] Method Spoofing - Read more [here](https://laravel.com/docs/5.3/routing#form-method-spoofing) 12 | 13 | ## Create 14 | 15 | ```php 16 |
17 | {{ csrf_token() }} 18 |
19 | ``` 20 | 21 | ## Update 22 | 23 | ```php 24 |
25 | {{ csrf_token() }} 26 | 27 | 28 | {{ method_field('PUT') }} 29 |
30 | ``` 31 | 32 | ## Delete 33 | 34 | ```php 35 |
36 | {{ csrf_token() }} 37 | 38 | 39 | {{ method_field('DELETE') }} 40 |
41 | ``` 42 | 43 | # How to create a validator 44 | 45 | Create custom request by running `php artisan make:request UserRequest`. 46 | 47 | Open `UserRequest.php` located at `app/Http/Requests`. 48 | 49 | Add validation rules for your form at `rules()` method: 50 | 51 | ```php 52 | return [ 53 | 'name' => 'required|min:6|max:255', 54 | 'email' => 'required|email|max:255|unique:users', 55 | 'password' => 'required|min:6|confirmed', 56 | ]; 57 | ``` 58 | 59 | Next, include `UserRequest` namespace in `UserController` - `use App\Http\Requests\UserRequest;`. 60 | 61 | Now in `UserController`'s `store(Request $request)` method, replace `store(Request $request)` with `store(UserRequest $request)`. 62 | 63 | ## To display error message 64 | 65 | Following are the sample to display an error message 66 | 67 | ```html 68 | @if ($errors->has('email')) 69 | 70 | {{ $errors->first('email') }} 71 | 72 | @endif 73 | ``` 74 | 75 | ## Authorization 76 | 77 | You may return to `true` in `UserRequest`'s `authorize()` method if there's no particular authorization required. 78 | 79 | ```php 80 | public function authorize() 81 | { 82 | return true; 83 | } 84 | ``` 85 | 86 | ## Validation from within Controller 87 | 88 | ```php 89 | $this->validate($request, [ 90 | 'name' => 'required|min:6|max:255', 91 | 'password' => 'required|min:6|confirmed', 92 | ]); 93 | ``` -------------------------------------------------------------------------------- /section-4.md: -------------------------------------------------------------------------------- 1 | # Section 4: Relationship 2 | 3 | 1. One-to-one 4 | 2. One-to-many 5 | 3. Many-to-one 6 | 4. Many-to-many 7 | 8 | You may have following relationships between your models, but following are the 3 basic steps required to setup relationship between tables. 9 | 10 | ## Setup Foreign Key 11 | 12 | Let say we want to have a user has many posts. 13 | 14 | Create migration script: 15 | 16 | ``` 17 | php artisan make:migration add_post_owner --table=posts 18 | ``` 19 | 20 | Open up the `timestamp_add_post_owner.php` migration script and add the following in `up` and `down` method respectively. 21 | 22 | ``` 23 | Schema::table('posts', function (Blueprint $table) { 24 | $table->integer('user_id')->unsigned()->after('id'); 25 | }); 26 | ``` 27 | 28 | Using `after('column_name')` used, in order to prevent the new column added at the end of the table columns. 29 | 30 | ``` 31 | Schema::table('posts', function (Blueprint $table) { 32 | $table->dropColumn('user_id'); 33 | }); 34 | ``` 35 | 36 | Then we run `php artisan migrate`. 37 | 38 | ## Update `ModelFactory.php` 39 | 40 | Update the `App\Post` model factory by adding `user_id`. 41 | 42 | ``` 43 | $factory->define(App\Post::class, function (Faker\Generator $faker) { 44 | return [ 45 | 'user_id' => $faker->randomElement(range(1, 100)), 46 | 'post' => $faker->paragraph, 47 | ]; 48 | }); 49 | ``` 50 | 51 | ## Define Relationships in Models 52 | 53 | Next we need to add relationship between related models, in this case we need `User` and `Post` model. 54 | 55 | For `User` model, a user has many posts, add the following method `app/User.php`: 56 | 57 | ```php 58 | public function posts() 59 | { 60 | return $this->hasMany('App\Post'); 61 | } 62 | ``` 63 | 64 | For `Post` model, a post belongs to user, add the following method `app/Post.php`: 65 | 66 | ```php 67 | public function user() 68 | { 69 | return $this->belongsTo('App\User'); 70 | } 71 | ``` 72 | 73 | ## Usage 74 | 75 | Once you're done setting up the relationships, you may use the models like: 76 | 77 | ```php 78 | $user = User::find(1); 79 | // just dump all the posts 80 | dd($user->posts); 81 | ``` 82 | 83 | ```php 84 | $post = Post::find(1); 85 | // echo the owner of the post 86 | $post->user->name; 87 | ``` -------------------------------------------------------------------------------- /section-5.md: -------------------------------------------------------------------------------- 1 | # Section 5: Common Request 2 | 3 | ## Setup Multilingual 4 | 5 | You can setup multilingual by configure `config/app.php`'s `locale` key or you may call `App::setLocale('my')` at run time. 6 | 7 | Then make sure the language set is exist by duplicate the `resources/lang/en` to `resources/lang/xx`. 8 | 9 | ## Setup Validation Messages 10 | 11 | Open up your `resources/lang/xx/validation.php` and update your key's values based on your language. -------------------------------------------------------------------------------- /section-6.md: -------------------------------------------------------------------------------- 1 | # Section 6: Advanced Request 2 | 3 | ## Middleware 4 | 5 | ### Register Middleware 6 | 7 | Open up `app/Http/Kernel.php` and update any of the `Kernel` class properties, depends on your need. 8 | 9 | To register middleware globally, use `$middleware` property. 10 | 11 | To register middleware in group, use `$middlewareGroups` property. 12 | 13 | To register middleware for route, use `$routeMiddleware` property. 14 | 15 | ### Middleware Usage 16 | 17 | There's two category, one from route and the other one from controller's constructor. 18 | 19 | #### From Controller 20 | 21 | ```php 22 | public function __construct() 23 | { 24 | $this->middleware('auth'); 25 | } 26 | ``` 27 | 28 | #### From Route 29 | 30 | ##### For Individual Route 31 | 32 | ```php 33 | Route::get('/contact-us', 'StaticPageController@contactUs')->name('static.contactUs')->middleware('auth'); 34 | ``` 35 | 36 | ##### For Group Route 37 | 38 | ```php 39 | Route::group([ 40 | 'middleware' => ['auth'], 41 | 'prefix' => 'admin', 42 | ], function () { 43 | Route::resource('users', 'UserController'); 44 | Route::resource('posts', 'PostController'); 45 | Route::resource('media', 'MediumController'); 46 | }); 47 | ``` --------------------------------------------------------------------------------