{"id":27421,"date":"2017-03-17T11:39:06","date_gmt":"2017-03-17T09:39:06","guid":{"rendered":"https:\/\/mamchenkov.net\/wordpress\/?p=27421"},"modified":"2017-03-17T11:39:06","modified_gmt":"2017-03-17T09:39:06","slug":"cakephp-3-remove-shell-welcome-header","status":"publish","type":"post","link":"https:\/\/mamchenkov.net\/wordpress\/2017\/03\/17\/cakephp-3-remove-shell-welcome-header\/","title":{"rendered":"CakePHP 3 : Remove Shell Welcome Header"},"content":{"rendered":"\n

CakePHP 3\u00a0has an excellent support for command line Shells, Tasks, and Console Tools<\/a>. \u00a0There are a few that are bundled with the framework itself, and that come from a variety of plugins. \u00a0And, of course, you can have your own commands, specific to your application.<\/p>\n

\r\n$ .\/bin\/cake\r\n\r\nWelcome to CakePHP v3.4.3 Console\r\n---------------------------------------------------------------\r\nApp : src\r\nPath: \/home\/leonid\/Work\/cakephp_test\/src\/\r\nPHP : 7.0.16\r\n---------------------------------------------------------------\r\nCurrent Paths:\r\n\r\n* app:  src\r\n* root: \/home\/leonid\/Work\/cakephp_test\r\n* core: \/home\/leonid\/Work\/cakephp_test\/vendor\/cakephp\/cakephp\r\n\r\nAvailable Shells:\r\n\r\n[Bake] bake\r\n\r\n[DebugKit] benchmark, whitespace\r\n\r\n[Migrations] migrations\r\n\r\n[CORE] cache, i18n, orm_cache, plugin, routes, server\r\n\r\n[app] console\r\n\r\nTo run an app or core command, type `cake shell_name [args]`\r\nTo run a plugin command, type `cake Plugin.shell_name [args]`\r\nTo get help on a specific command, type `cake shell_name --help`\r\n<\/pre>\n
There is one tiny little annoyance though. \u00a0Sometimes, it’s useful to get an output of the CakePHP Shell and use it in another script. \u00a0For example, you might need to get a list of all loaded plugins and loop over them, performing another action, outside of CakePHP. \u00a0Say, in a bash script. \u00a0Getting a list of loaded plugins is easy with the bundled shell like so:<\/p>\n
\r\n$ .\/bin\/cake plugin loaded\r\n\r\nWelcome to CakePHP v3.4.3 Console\r\n---------------------------------------------------------------\r\nApp : src\r\nPath: \/home\/leonid\/Work\/cakephp_test\/src\/\r\nPHP : 7.0.16\r\n---------------------------------------------------------------\r\nBake\r\nDebugKit\r\nMigrations\r\n<\/pre>\n
But, as you can see, the output is not very useful for machine processing. The welcome header is in the way. \u00a0Sure, you can parse it out with regular expressions, or even a simple line count. \u00a0But that lacks elegance. \u00a0Is there a better way? \u00a0I thought there was.<\/p>\n
My first approach was to use the –quiet option, which, I thought, would leave me with just the needed output. \u00a0It turns out, that’s not what it does. \u00a0It strips out all the output, and there is no list of plugins at all.<\/p>\n
The second approach worked out better. \u00a0I learned about it from this thread<\/a>. \u00a0The solution is to extend the needed CakePHP shell and overwrite the protected _welcome()<\/em> method. \u00a0Here’s the content of the newly created application level shell in src\/Shell\/PluginShell.php<\/em>:<\/p>\n
\r\n<?php\r\nnamespace App\\Shell;\r\n\r\nuse Cake\\Shell\\PluginShell as Shell;\r\n\r\nclass PluginShell extends Shell\r\n{\r\n    \/**\r\n     * Silence the welcome message\r\n     *\r\n     * @return void\r\n     *\/\r\n    protected function _welcome()\r\n    {\r\n    }\r\n}\r\n<\/pre>\n
And now running the same command as before produces a cleaner output:<\/p>\n
\r\n$ .\/bin\/cake plugin loaded\r\nBake\r\nDebugKit\r\nMigrations\r\n<\/pre>\n
This now can be easily used in other scripts without any need for regular expressions and other trimming techniques.<\/p>\n\n","protected":false},"excerpt":{"rendered":"\n
CakePHP 3\u00a0has an excellent support for command line Shells, Tasks, and Console Tools. \u00a0There are a few that are bundled with the framework itself, and that come from a variety of plugins. \u00a0And, of course, you can have your own commands, specific to your application. $ .\/bin\/cake Welcome to CakePHP v3.4.3 Console ————————————————————— App : … Continue reading CakePHP 3 : Remove Shell Welcome Header<\/span><\/a><\/p>\n\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"CakePHP 3 : Remove Shell Welcome Header #CakePHP #WebDev #PHP #CLI","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false,"_links_to":"","_links_to_target":""},"categories":[1,18,62,1334],"tags":[1537,1960,38,1330],"keyring_services":[],"class_list":["post-27421","post","type-post","status-publish","format-standard","hentry","category-general","category-programming","category-technology","category-web-work","tag-cakephp","tag-command-line","tag-php","tag-web-development"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t