Laravel 5.8 – From The Ground Up

Laravel 5.8 Tutorial From Scratch – e36 – Artisan Commands (Closure) – Part 3

welcome back this is part three of artisan commands in this episode we're going to be talking about the closure based commands available in laravel now

in the previous two episodes we work in a full-fledged class that was a console command however levo offers another convenient way of having commands and that is through a closure for very

simple commands this approach is quite good so let me show you how to find the file first if we jump into our routes directory we've worked with web and we've worked with API but there's

another one here for console and this allows us to define a closure based console command so this is pretty cool check this out so there is a command in here already

and that is in spire let's run that now and see what it does PHP artisan in spire it always seems impossible until it is done so this command just picks out a quote and sends

it back to the user pretty cool command so it's actually using this inspire class and just calling the quote on it and if we look at this inspired command we see there's

a handful of commands in here that it chooses from and then it's calling the random method on it so all we're getting is a random quote from someone pretty cool command this is a very simple

command and obviously this is a great use for it let's add our own now I want to make a simple command to clean out any companies that are not being used in our project so we're gonna fetch any

company that's not being used and we're gonna delete that record so how can we handle that we'll say artisan command and what's our command going to be well contact is our prefix

so we'll say contact company – clean and then as a second parameter you have to pass in a closure now in here this is no different than the handle method from our actual command so I'm gonna say just

for now this info and I will just say cleaning command that's a deep alright there we go alright so let's run PHP artisan and if we scroll up we do have this second command right here now to

add the description we can pass that to the end of this and just say describe cleans up on used companies alright so now if we run PHP artisan again

cleans up unused companies pretty cool so we have added a command inline using a closure so how can we fetch all of the unused companies so check this out we could say company and that is being

imported here at the top use app company if you don't add that in then you will get a company not found exception so we'll say company where doesn't have and what is the relationship that we are

looking for where the company doesn't have any customers remember if we go to the company model remember that company has customers so this is the relationship that we are using so

companies where doesn't have any customers and let's just get them for now I will die and dump that I just want to show you what it actually outputs let's run PHP artisan contact company

clean and sure enough we get a list of companies nine to be exact now obviously eight because it is zero based index so none of these have any customers so we can safely delete all of them so now

let's chain everything together and do the command in one big swoop so we'll say get them and then each one what I want you to do is run them through this closure we're gonna be

receiving a company right here and we can say company delete this and then maybe we'll use the warning delete it and then let's pass in that company's name that way we know what we actually

delete it does that make sense we're gonna grab the company model and then where it doesn't have any customers then we're going to get that so at this stage what we have is a collection of

companies that don't have any customers then we're going to take each one and we're going to run them through this closure now this closure it's going to receive each of those companies as a

very then we're going to call the delete method on it and then we're simply going to output something back to the user so they know that we actually completed

something great let's try it out I'm gonna run that one more time that's PHP artisan contact company clean alright and sure enough we delete a de F company

a test company new company a bunch of banana companies and then cool company now if we run that again then of course we don't get anything if we head back to our browser hit refresh we successfully

cleaned up our companies obviously there was only one company ABC company here so let's add a new company so what is the company name new company phone number yes alright so now we have this new

company so let's add a new customer email at email com and let's make sure that we use that new company so we added that customer and of course now new company is being used so if we go back

and try to do a clean up we don't clean anything because both of those companies are correct so I will actually go ahead and delete this record so now there are no customers associated with that second

company and I will run our command one more time and sure enough we deleted it because there was nothing associated with it so let's recap everything that we took care of if we go back to

phpstorm we made a new artisan command but this time we made it inside the console routes file first we went to routes and we found that console dot PHP we did

explore this inspire command which all it does is it randomly generates a quote and gives it back to the user but then we added our own artisan command using this signature right here and what it

does is it goes through our companies and anything that does not have a customer associated to it we're going to take each one of those and we're going to delete them and then we're going to

output out something back to the user so that we know exactly what we did now this is a cool little command and it joined our other command that we already had made if we go to PHP artisan

we do see that we have two commands now that we've put together this first one of course is a class-based command and this second one is a closure based command now there's a good use case for

either one but I think that you get the point for a simple command something like this works great if you have a command that is a little bit more robust and it's got a lot of logic in it

probably its own dedicated class will be a better place for it this command here as an inline command is kind of already pushing the boundaries I think of what should be a closure based command it's

got about ten lines of code in it and it's getting a little big so anything bigger than this should probably go in its own class now this is another place for you to be able to experiment with a

command this is a great way for you to dive into commands and start using everything in the command and then when you're ready you can refactor it to its own class so it's a great place to

experiment so keep that in mind whenever you're trying to find a little playground for you to experiment with some stuff this is a great place for you to do it so with that we've covered all

of the basics of artists and commands as always if you have any questions drop them in the comments below and I'll try to answer those for you and so with that in the next lesson we'll move on to

something new

Let’s start talking about how to create our very own artisan command. In part 3, let’s add a command to clean up any used companies in our database. We will do this by adding a closure-based command in the routes file.

For the best experience, follow along in our interactive school at https://www.coderstape.com

DigitalOcean Referral
https://m.do.co/c/7dce5364ef4d

Resources
Course Source Code
https://github.com/coderstape/laravel-58-from-scratch

Hit us up on Twitter with any questions or comments @codertape (https://twitter.com/CodersTape)

About This Course

Ready to get started on your path to Laravel Artisan? In this series, we are breaking down all of the basics of Laravel to get you comfortable using the world’s most popular PHP framework. Let’s get started!