Download vendor javascript files in CakePHP 3

Question

My problem is how to download .js files from the vendors folder in CakePHP 3.0. I enabled twitter bootstrap through composer. The .js file is located in the / vendor / twbs / bootstrap -sass / assets / javascripts / folder. I do not want to move it to webroot, because then I will break the automatic update functions provided by the composer. Any good suggestions? I do not want to duplicate files and lose the benefits of the composer ...

Answer 1

I have found a solution! If I use a composer, why not use it for this too, right? :)

In composer.json:

"scripts": { "post-install-cmd": "App\\Console\\Installer::postInstall", "post-update-cmd": "App\\Console\\Installer::postUpdate" } 

In src / Console / Installer.php:

 public static function postUpdate(Event $event) { $io = $event->getIO(); $rootDir = dirname(dirname(__DIR__)); static::copyTwitterBootstrapFiles($rootDir, $io); } public static function copyTwitterBootstrapFiles($dir, $io) { $bootstrapJsSource = $dir . '/vendor/twbs/bootstrap-sass/assets/javascripts/bootstrap.js'; $bootstrapJsDestination = $dir . '/webroot/js/bootstrap.js'; if (file_exists($bootstrapJsSource)) { copy($bootstrapJsSource, $bootstrapJsDestination); $io->write('Copied `bootstrap.js` file'); } } 

And finally, if you are using git, add webroot / bootstrap.js to .gitignore. PostUpdate starts after each composer update command, so if you want to run a script after every update of the actual package, simply use post-package-update instead of post-update-cmd.

Answer 2

Same with mutdsu answer, but with more details.

In composer.json in the scripts add the line:

 "post-update-cmd": "App\\Console\\Installer::postUpdate", 

it should show something like this:

 "scripts": { ... "post-update-cmd": "App\\Console\\Installer::postUpdate", ... }, 

In src / Console / Installer.php add these two static functions:

 public static function postUpdate(Event $event) { $io = $event->getIO(); $rootDir = dirname(dirname(__DIR__)); static::copyBootstrapAssets($rootDir, $io); } public static function copyBootstrapAssets($dir, $io) { $ds = DIRECTORY_SEPARATOR; $bootstrapAssetsDir = $dir . $ds . 'vendor' . $ds . 'twbs' . $ds . 'bootstrap' . $ds . 'dist' . $ds; $bootstrapCssAssetsDir = $bootstrapAssetsDir . 'css' . $ds; $bootstrapJsAssetsDir = $bootstrapAssetsDir . 'js' . $ds; $bootstrapFontAssetsDir = $bootstrapAssetsDir . 'fonts' . $ds; $webrootDir = $dir . $ds . 'webroot' . $ds; $cssDir = $webrootDir . 'css' . $ds; $jsDir = $webrootDir . 'js' . $ds; $fontDir = $webrootDir . 'fonts' . $ds; if (!file_exists($cssDir) && !is_dir($cssDir)) { mkdir($cssDir); } if (!file_exists($jsDir) && !is_dir($jsDir)) { mkdir($jsDir); } if (!file_exists($fontDir) && !is_dir($fontDir)) { mkdir($fontDir); } $cssAssets = [ 'bootstrap.min.css', 'bootstrap-theme.min.css', ]; $jsAssets = [ 'bootstrap.min.js', ]; $fontAssets = [ 'glyphicons-halflings-regular.eot', 'glyphicons-halflings-regular.svg', 'glyphicons-halflings-regular.ttf', 'glyphicons-halflings-regular.woff', 'glyphicons-halflings-regular.woff2', ]; foreach ($cssAssets as $asset) { if (file_exists($bootstrapCssAssetsDir . $asset)) { copy($bootstrapCssAssetsDir . $asset, $cssDir . $asset); $io->write('Copied `' . $asset . '` file'); } else { if (file_exists($cssDir . $asset)) { unlink($cssDir . $asset); } } } foreach ($jsAssets as $asset) { if (file_exists($bootstrapJsAssetsDir . $asset)) { copy($bootstrapJsAssetsDir . $asset, $jsDir . $asset); $io->write('Copied `' . $asset . '` file'); } else { if (file_exists($jsDir . $asset)) { unlink($jsDir . $asset); } } } foreach ($fontAssets as $asset) { if (file_exists($bootstrapFontAssetsDir . $asset)) { copy($bootstrapFontAssetsDir . $asset, $fontDir . $asset); $io->write('Copied `' . $asset . '` file'); } else { if (file_exists($fontDir . $asset)) { unlink($fontDir . $asset); } } } } 

If you are using git, be sure to add these lines to your .gitignore file:

 /webroot/css/bootstrap.min.css /webroot/css/bootstrap-theme.min.css /webroot/js/bootstrap.min.js /webroot/fonts/glyphicons-halflings-regular.eot /webroot/fonts/glyphicons-halflings-regular /webroot/fonts/glyphicons-halflings-regular.ttf /webroot/fonts/glyphicons-halflings-regular.woff /webroot/fonts/glyphicons-halflings-regular.woff2 /webroot/fonts/glyphicons-halflings-regular.woff2 

Answer 3

I don’t like copying files, so based on previous answers I created a function that creates links to bootstrap files. Please note that for Bootstrap4, which is now distributed without fonts.

 /** * Create Bootstrap4 assets links * * @param string $dir The application root directory. * @param \Composer\IO\IOInterface $io IO interface to write to console. * @return void */ public static function createBootstrapLinks($dir, $io) { $ds = DIRECTORY_SEPARATOR; if (!file_exists($dir . $ds . 'vendor' . $ds . 'twbs' . $ds . 'bootstrap')) { $io->write('Bootstrap is not installed. Include Bootstrap into project: composer require twbs/bootstrap'); return; } $bootstrapAssetsDir = realpath($dir . $ds . 'vendor' . $ds . 'twbs' . $ds . 'bootstrap' . $ds . 'dist'); $bootstrapAssets = [ 'css' => $bootstrapAssetsDir . $ds . 'css' . $ds, 'js' => $bootstrapAssetsDir . $ds . 'js' . $ds ]; $webrootDir = realpath($dir . $ds . 'webroot'); $webrootPathes = [ 'css' => $webrootDir . $ds . 'css' . $ds . 'bootstrap', 'js' => $webrootDir . $ds . 'js' . $ds . 'bootstrap' ]; foreach ($bootstrapAssets as $type => $asset) { if (!file_exists($asset)) { $io->write('Asset '' . $asset . '' does not exists. Unable to create link.'); continue; } $name = isset($webrootPathes[$type]) ? $webrootPathes[$type] : ($webrootDir . $type . $ds . 'bootstrap'); if (file_exists($name)) { switch(filetype($name)) { case 'link': $link_target = readlink($name); if ($link_target == $asset) { $io->write('Correct link to '' . $asset . '' already exists. Fine.'); } else { $io->write('Link '' . $name . '' already exists and points to ''. $link_target .''. Unable to create link.'); } break; case 'dir': $io->write('Dir '' . $name . '' already exists. Unable to create link.'); break; default: $io->write(filetype($name).' '' . $name . '' already exists. Unable to create link.'); break; } } else { $io->write('Link '' . $name . '' to '' . $asset . '' created. Fine.'); symlink($asset, $name); } } }