How do I write to the console from a Laravel Controller

Question

So I have a Laravel controller   class YeahMyController extends BaseController       public function getSomething             Console  info  mymessage        lt -- what do I put here          return  yeahoutputthistotheresponse             Currently  I m running the application using artisan  which runs PHP s built-in development web server under the hood    php artisan serve   I would like to log console messages to the STDOUT pipe for the artisan process

User · Answer

If you want to log to STDOUT you can use any of the ways Laravel provides; for example (from wired00's answer):

Log::info('This is some useful information.');

The STDOUT magic can be done with the following (you are setting the file where info messages go):

Log::useFiles('php://stdout', 'info');

Word of caution: this is strictly for debugging. Do no use anything in production you don't fully understand.

User · Answer

Bit late to this   I m surprised that no one mentioned Symfony s VarDumper component that Laravel includes  in part  for its dd    and lesser-known  dump    utility functions     dumpMe   new App User    name    gt   Cy Rossignol        new Symfony Component VarDumper Dumper CliDumper   - gt dump        new Symfony Component VarDumper Cloner VarCloner   - gt cloneVar  dumpMe       There s a bit more code needed  but  in return  we get nice formatted  readable output in the console mdash especially useful for debugging complex objects or arrays     App User   17    attributes  array 1        name    gt   Cy Rossignol         fillable  array 3       0   gt   name      1   gt   email      2   gt   password         guarded  array 1       0   gt             primaryKey   id     casts        dates        relations           etc            To take this a step further  we can even colorize the output  Add this helper function to the project to save some typing    function toConsole  var          dumper   new Symfony Component VarDumper Dumper CliDumper         dumper- gt setColors true         dumper- gt dump  new Symfony Component VarDumper Cloner VarCloner   - gt cloneVar  var        If we re running the app behind a full webserver  like Apache or Nginx mdash not artisan serve   we can modify this function slightly to send the dumper s prettified output to the log  typically storage logs laravel log    function toLog  var          lines      Dump           dumper   new Symfony Component VarDumper Dumper CliDumper         dumper- gt setColors true        dumper- gt setOutput function   line  use   amp  lines              lines      line                dumper- gt dump  new Symfony Component VarDumper Cloner VarCloner   - gt cloneVar  var         Log  debug implode PHP EOL   lines           and  of course  watch the log using      tail -f storage logs laravel log   PHP s error log   works fine for quick  one-off inspection of simple values  but the functions shown above take the hard work out of debugging some of Laravel s more complicated classes

User · Answer

The question relates to serving via artisan and so Jrop s answer is ideal in that case  I e  error log logging to the apache log   However  if your serving via a standard web server then simply use the Laravel specific logging functions    Log  info  This is some useful information       Log  warning  Something could be going wrong       Log  error  Something is really going wrong       With current versions of laravel like this for info   info  This is some useful information       This logs to Laravel s log file located at  laravel storage logs laravel- lt date gt  log  laravel 5 0   Monitor the log - linux osx  tail -f  laravel storage logs laravel- lt date gt  log   Laravel 5 0 http   laravel com docs 5 0 errors Laravel 4 2  http   laravel com docs 4 2 errors

User · Answer

If you want the fancy command IO from Laravel  like styling  asking and table  then I created this class below  Instructions  I have not fully verified everywhere that it is THE cleanest solution etc  but it works nice  but I only tested it from within a unit test case  under Laravel 5 5    So most probably you can use it however you like    cmd   new ConsoleCommand    cmd- gt error  Aw snap      cmd- gt table  headers   rows    answer    cmd- gt ask  Tell me  what do you need        even Symfony s progress bar  cmd- gt outputStyle- gt progressStart 5      set n   100   here 100  is 5 steps   cmd- gt outputStyle- gt progressAdvance      you can call it n times  cmd- gt outputStyle- gt progressFinish       set to 100    Or course you can also wrap in your own facade  or some static singleton etc  or anyway you wish   The class itself  class ConsoleCommand extends  Illuminate Console Command       protected  name    NONEXISTENT       protected  hidden   true       public  outputSymfony      public  outputStyle       public function   construct  argInput   null                parent    construct              this- gt input   new  Symfony Component Console Input StringInput  argInput             this- gt outputSymfony   new  Symfony Component Console Output ConsoleOutput             this- gt outputStyle   new  Illuminate Console OutputStyle  this- gt input   this- gt outputSymfony             this- gt output    this- gt outputStyle

User · Answer

I haven t tried this myself  but a quick dig through the library suggests you can do this    output   new Symfony Component Console Output ConsoleOutput     output- gt writeln   lt info gt my message lt  info gt       I couldn t find a shortcut for this  so you would probably want to create a facade to avoid duplication

User · Answer

I wanted my logging information to be sent to stdout because it s easy to tell Amazon s Container service  ECS  to collect stdout and send it to CloudWatch Logs  So to get this working  I added a new stdout entry to my config logging php file like so        stdout    gt             driver    gt   monolog            handler    gt  StreamHandler  class           with    gt                 stream    gt   php   stdout                       level    gt   info            Then I simply added  stdout  as one of the channels in the stack log channel        default    gt  env  LOG CHANNEL    stack          stack    gt             driver    gt   stack            channels    gt    stdout    daily             This way  I still get logs in a file for local development  or even on the instance if you can access it   but more importantly they get sent to the stdout which is saved in CloudWatch Logs

User · Answer

You can use echo and prefix   033   simple   Artisan  command  mycommand   function         echo   033         Start          n         And change color text   if  App  environment        production         echo   033 0 33m         WARNING          033 0m n

User · Answer

Here s another way to go about it   stdout   fopen  php   stdout    w    fwrite  stdout   Hello  World     PHP EOL    The PHP EOL adds new line

User · Answer

In Laravel 6 there is a channel called  stderr   See config logging php    stderr    gt         driver    gt   monolog        handler    gt  StreamHandler  class       formatter    gt  env  LOG STDERR FORMATTER         with    gt             stream    gt   php   stderr               In your controller   use Illuminate Support Facades Log   Log  channel  stderr  - gt info  Something happened

User · Answer

For better explain Dave Morrissey s answer I have made these steps for wrap  with Console Output class in a laravel facade   1  Create a Facade in your prefer folder  in my case app Facades    class ConsoleOutput extends Facade     protected static function getFacadeAccessor           return  consoleOutput           2  Register a new Service Provider in app Providers as follow   class ConsoleOutputServiceProvider extends ServiceProvider     public function register        App  bind  consoleOutput   function            return new  Symfony Component Console Output ConsoleOutput                     3  Add all this stuffs in config app php file  registering the provider and alias      providers    gt         other providers     App Providers ConsoleOutputServiceProvider  class       aliases    gt        other aliases     ConsoleOutput    gt  App Facades ConsoleOutput  class        That s it  now in any place of your Laravel application  just call your method in this way   ConsoleOutput  writeln  hello      Hope this help you

User · Answer

Aha   This can be done with the following PHP function   error log  Some message here       Found the answer here  Print something in PHP built-in web server

User · Answer

It s very simple   You can call it from anywhere in APP    out   new  Symfony Component Console Output ConsoleOutput     out- gt writeln  Hello from Terminal

[php] How do I write to the console from a Laravel Controller?

Examples related to php

Examples related to laravel

Examples related to logging

Examples related to console