Apuntes: Laravel Fullstack
He aprendido Laravel en trabajos como programador que he tenido.
Contenido
-
Añadir un proyecto a los sites-enabled de Laragon y a los hosts de Windows
-
La extención de navegador Fake Filler para llenar formularios
-
En un div hacer que cambie el cursor por una mano al posicionarlo encima
-
Laravel Debugbar se adjunta a lo que responde el Controlador
Trabajar en Laragon con proyectos de Laravel
En un trabajo que tuve me pidieron clonar un repositorio para agregarle 3 CRUD lo único que me dijeron fue hazlo con Laragon y composer.
Sabiendo nada de laravel y laragon y después de mucho buscar encontre esta forma de clonar y levantar el proyecto de Laravel.
Descargar e instalar Laragon
Ir a laragon y en la sección de descargas escoger la versión full. En caso de tener descargado y configurado Laragon o Laragon portable descartar este paso.
Clonar un repositorio de un proyecto de Laravel
Abrir una terminal de Laragon y posicionarla en la carpeta www de la instalacion de Laragon, después ejecutar
git clone url_del_proyecto
cd la_carpeta_del_proyecto_clonado
Levantar el sitio
Abrir una terminal en la raíz del proyecto clonado.
composer install
npm install
En Laragon dar click en el boton Database y después crear una base de datos (ej. basedatos1).
Crear un archivo .env a partir del archivo .env.example que se encuentra en la raíz de la carpeta del proyecto clonado. Dejar .env en el mismo directorio que .env.example.
Abrir el archivo .env y agregar la base de datos que se creo anteriormente.
archivo: .env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=basedatos1 <----- agregar aqui el nombre de la base de datos
DB_USERNAME=root <----- valor por defecto de Laragon
DB_PASSWORD= <----- valor por defecto de Laragon
Con la terminal (que sigue posicionada en la carpeta raíz del proyecto) hacer:
Generar una key
php artisan key:generate
Realizar las migraciones
php artisan migrate
Una vez me pasó que al hacer las migraciones me apareciera el error Unknown character set: 'utf8mb4'. Para solucionarlo se debe abrir el archivo config/database.php y
CAMBIAR LAS SIGUIENTES LINEAS
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_unicode_ci',
POR LAS SIGUIENTES
'charset' => 'utf8',
'collation' => 'utf8_unicode_ci',
Llenar la base de datos con registros de prueba usando el seeder. Si no pasa nada es porque el seeder esta vacío
php artisan db:seed
Construir los styles y scripts.
npm run <orden>
Las ordenes a ejecutar se encuentran en el archivo package.json que esta en la raiz de la carpeta del proyecto.
Se deben ejecutar las ordenes tipo npm run development.
A continuación se muestra un ejemplo:
archivo: package.json
"scripts": {
"dev": "npm run development", <---------------- EJECUTAR ESTO EN TERMINAL
"development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
"watch": "npm run development -- --watch", <---------------- EJECUTAR ESTO EN TERMINAL
"watch-poll": "npm run watch -- --watch-poll", <---------------- EJECUTAR ESTO EN TERMINAL
"hot": "cross-env NODE_ENV=development node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --hot --disable-host-check --config=node_modules/laravel-mix/setup/webpack.config.js",
"prod": "npm run production", <---------------- EJECUTAR ESTO EN TERMINAL
"production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --no-progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
},
En la ventana de laragon o su icono en la barra de tareas dar click derecho apache->ssl->habilitado.
Abrir un explorador como Firefox e introducir la ruta nombre_del_proyecto.test
donde:
nombre_del_proyecto es el nombre de la carpeta resultante de las instrucciones.
git clone url_del_proyecto
cd la_carpeta_del_proyecto_clonado
Si no muestra el sitio se puede intentar añadir el proyecto a los sites-enabled de Laragon y a los hosts de Windows.
Añadir un proyecto a los sites-enabled de Laragon y a los hosts de Windows
Nota: Si el proyecto esta dentro de varias carpetas ejemplo: proyecto/proyectoMaster/codigo/CRUDLaravel se aconseja dar click derecho sobre laragon->preferencias y desactivar la opción Crear automáticamente hosts virtuales para que Laragon no sobreescriba y destruya lo cambios que se muestran a continuación.
Desactivar Crear automáticamente hosts virtuales tiene el inconveniente de agregar manualmente todos los proyectos futuros a los sites-enabled de Laragon y a los hosts de Windows.
Sites-enabled de Laragon
Ir a la carpeta laragon->etc->apache2->sites-enabled La carpeta laragon se crea al instalar Laragon.
Crear un archivo auto.nombre_del_proyecto.test (ejemplo auto.CRUDLaravel.test) que tenga lo siguiente.
define ROOT "C:\laragon\www\CRUDLaravel\public"
define SITE "CRUDLaravel.test"
<VirtualHost *:80>
DocumentRoot "${ROOT}"
ServerName ${SITE}
ServerAlias *.${SITE}
<Directory "${ROOT}">
AllowOverride All
Require all granted
</Directory>
</VirtualHost>
<VirtualHost *:443>
DocumentRoot "${ROOT}"
ServerName ${SITE}
ServerAlias *.${SITE}
<Directory "${ROOT}">
AllowOverride All
Require all granted
</Directory>
SSLEngine on
SSLCertificateFile C:/laragon/etc/ssl/laragon.crt
SSLCertificateKeyFile C:/laragon/etc/ssl/laragon.key
</VirtualHost>
Sustituir define ROOT "C:\laragon\www\CRUDLaravel\public" por la ruta a la carpeta public del proyecto.
Sustituir define SITE "CRUDLaravel.test" por la carpeta del nombre del proyecto, este nombre se debe introducir como ruta al navegador
Hosts de Windows
Para agregar el proyecto a los Hosts de windows ir a C:\Windows\System32\drivers\etc y abrir el archivo hosts (Si no existe el archivo crearlo. El archivo no tiene extención) después agregar la siguiente linea y guardar (necesita permisos de administrador).
127.0.0.1 CRUDLaravel.test #laragon magic!
Sustituir CRUDLaravel.test por lo que hay en define SITE del paso anterior (define SITE "CRUDLaravel.test").
Recargar Laragon (o cerrarlo y abrirlo), abrir el navegador e introducir la ruta tal cual se puso (ej. CRUDLaravel.test), respetando mayusculas, minúsculas y/o guiones. Puede tardar en reconocer y mostrar el sitio.
Fuentes
-
Trabajar en Laragon con proyectos de Laravel: forum.laragon.org/topic/175 — Tutorial how to work with Laravel projects on Github (parece que ahora el sitio pide logearse 👎)
-
Unknown character set: ‘utf8mb4’: stackoverflow.com/questions/41835923 — Syntax error or access violation: 1115 Unknown character set: utf8mb4
Comandos php artisan que uso con frecuencia
php artisan migrate:fresh --seed
Destruye las tablas, migra de nuevo y corre el seeder con el factory si aplica.
php artisan make:migration create_users_table
Crea una nueva migración.
php artisan make:model Flight --migration
Crea un modelo y su migración. El nombre de la tabla en la migración saldrá en plural (Flight -> Flights).
php artisan make:factory CategoriaFactory --model=Categoria
Crea un factory relacionado a un modelo.
Fuente: youtube.com — Laravel 5.8 - Factorías y Faker [Tutorial en Español 2019]
php artisan make:middleware CheckAge
Crea un middleware.
Fuente: laravel.com/docs/7.x/middleware — Middleware
php artisan make:migration add_name_to_costs_table --table=costs
Crea una migración que modificará una tabla para cambiar o agregar columnas.
Fuente: stackoverflow.com/questions/16791613/ — Laravel Add a new column to existing table in a migration
La extención de navegador Fake Filler para llenar formularios
24 / Julio / 2022 | 0:19:00
En un trabajo que tuve me pedian hacer cambios a sistemas hechos en Laravel. En ocasiones eran muchos formularios con muchos campos a llenar.
Después de buscar en la sección de complementos de Firefox como llenar más rápido los formularios me encontré esta extención para el navegador.
Fake Filler para Firefox
Esta extención se encuentra aqui
Se debe agregar al navegador como cualquier otra extención.
Y eso es todo.
El único cambio que yo hice fue modificar como llenar un campo de formulario de tipo Date.
Modificar en Fake Filler el formato Date
Ir a la sección complementos de Firefox.
En los complementos buscar Fake Filler y dar click en Preferencias.
En las preferencias de Fake Filler ir a Custom Fields, buscar el campo Date y dar click en editar.
En la sección Template sustituir su contenido por DD/MM/YYYY y guardar los cambios.
En un div hacer que cambie el cursor por una mano al posicionarlo encima
Para hacer que en un blade de Laravel el mouse cambie por una mano al hacer un hover sobre un elemento encerrado en un <div></div> se puede hacer lo siguiente.
Usar el helper str de Laravel en un Blade
Para hacer rápido una tarea que me pedían usé el helper str upper de Laravel directamente en un blade.
A continuación se muestra un ejemplo de como hacerlo.
Laravel Debugbar se adjunta a lo que responde el Controlador
Debugbar for Laravel es una herramienta muy útil y usada para el desarrollo. Lo que hace es poner información relevante de vistas, peticiones, consultas a base de datos, entre otros, como en la siguiente imagen:
Descripción de un problema que tuve con Laravel Debugbar
En un trabajo que tuve estaba usando el API de WhatsApp en un proyecto de Laravel.
Para la parte del webhook que usé para recibir mensajes de respuesta tuve un problema al abrir la conexión.
Los pasos para abrir la conexión eran:
- Dar de alta un token para el webhook en WhatsApp.
- Guardar el token en local, yo usé el
.env. - Hacer una ruta para verificar que el token en local y de WhatsApp coincidan. Si coinciden retornar un valor
hub_challengepara que WhatsApp abra la conexión y empiecen a llegar mensajes al proyecto en Laravel.
El problema en sí
No se abría la conexión porque el HTML del Laravel Debugbar se adjuntaba a la respuesta del controlador. Provocando que se mande valor hub_challenge con más información no necesaria.
Revisando en el panel de control de WhatsApp API noté que en el webhook decía algo como:
Se espera un valor de hub challenge de: 1234567
Pero se recibió: 1234567<html><body> ESTE HTML ES DEL LARAVEL DEBUGBAR </body></html>
A veces lo cambiaba por:
Se espera un valor de hub challenge de: 1234567
Pero se recibió: 1234567"/ux7...."
Donde "/ux7...." hace referencia al caracter < pero codificado como UTF-8 o algún otro.
Solución
Según Debugbar for Laravel es posible desactivarlo en tiempo de ejecución. Yo lo usé en mi controlador donde se abre la conexión.
\Debugbar::disable();
Código de ejemplo
Es un código de ejemplo muy tosco. No recomiendo usarlo tal cual está pero ejemplifica la solución a mi problena de inicio.
/*======= WhatsAppController.php =======*/
public function verifyWebhook(Request $request)
{
/*==================================================
//Primero que todo, en esta sección
//De acuerdo con la documentación de WhatsApp
//Se deben hacer las verificaciones correspondientes
==================================================*/
\Debugbar::disable();//Se desactiva Laravel Debugbar antes de responder
if($request["hub_verify_token"] == env('WHATSAPP_WEBHOOK_TOKEN')){
return response($request["hub_challenge"]);//Se hace el response a WhatsApp
}
}
Fuente: github.com/barryvdh/laravel-debugbar — Enabling/Disabling on run time
Algunos helpers de Laravel que me han sacado de apuros
Laravel incluye una variedad de funciones de PHP de clase helper global. Muchas de estas funciones son usadas por el propio Laravel. Pero pueden ser utilizados por los desarrolladores en sus proyectos si se desea.
Usar helpers facilita el desarrollo y la escritura de código limpio.
Helper data_get()
En un trabajo que tuve usaba una API de terceros. En algunos endpoints de la API me llegaban arrays anidados con la información que necesitaba pero también mucha basura anidada.
El helper data_get fue útil para saltarme la anidación basura y obtener lo que si me sirve.
Ejemplo, si me llega un array como:
$data = ['products' =>
['desk' =>
['price' => 100
]
]
];
Para obtener el valor númerico 100 se debe hacer:
$data = ['products' =>
['desk' =>
['price' => 100
]
]
];
$price = data_get($data, 'products.desk.price');
// 100
Habrá ocasiones en que llegue un array más complejo y es necesario saltarse niveles hasta la key que se necesita.
$entry = array (
'entry' =>
array (
0 =>
array (
'noutil1' => '0000',
'noutil2' => '2222',
'noutil3' => '1111',
'noutil4' =>
array (
0 =>
array (
'noutil5' =>
array (
'noutil6' => '33333',
'noutil7' =>
array (
'noutil8' => '4444',
),
'noutil9' =>
array (
0 =>
array (
'noutil10' =>
array (
'noutil11' => '5555',
),
),
),
'datamuyimportante' =>
array (
0 =>
array (
'infoutil' => 'Información muy importante',
'infouti2' => 'Información que también es muy importante'
)
)
)
)
)
)
)
)
//salta niveles y al llegar a datamuyimportante se queda con array 0
//no confundir con el 0 el tercer parametro de data_get, que es el valor retornado si la key especificada no puede ser encontrada
$section_datamuyimportante = data_get($entry, '*.*.*.*.datamuyimportante.0', 0);
Fuente: laravel.com/docs — data_get()
prepend y pluck
No son helpers, son métodos de Collections pero los pongo igualmente en esta sección.
Yo uso prepend y pluck para obtener contenido de la base de datos y “convertirlo” a un formato fácil de implementar en una lista desplegable <select></select>.
/*======= UserController.php =======*/
use App\Models\User;
public function index(Request $request)
{
$users = User::pluck('name','id')->prepend('Seleccione usuario','');
return view('users.index', compact('users'));
}
Fuentes:
Helper Arr::collapse() para obtener un solo array de un array de arrays
Me ha pasado que en un Controlador hay que hacer un for o un foreach para obtener algún resultado.
Puede haber el problema que en cada iteración se obtiene un resultado complejo en forma de array y se vacía en otro array.
De esto se obtiene un array de arrays y se debe colapsar para continuar con el flujo de trabajo.
use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
Fuente: laravel.com/docs — Arr::collapse()
Helper data_fill para rellenar un array
data_fill pone un valor en un array anidado.
He usado data_fill() para muchas cosas.
La sitación que más recuerdo es usarlo en una API para poner un redireccionamiento. Pero el ejemplo que se muestra es de la documentación de Laravel.
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
Fuente: laravel.com/docs — data_fill()
Crear tu propio Helper en Laravel
Esta manera de hacer el helper propio es la recomendada por el colectivo de php en stackoverflow. No estoy seguro de lo que significa, pero suena importante.
Paso 1: Crear el archivo Helper.php
Si no existe, crear la carpeta Helpers en app\Helpers\. Después crear el archivo Helper.php en app\Helpers\.
En Helper.php escribir lo siguiente:
======= Helper.php =======
<?php // Code within app\Helpers\Helper.php
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
Use Exception;
namespace App\Helpers;
class Helper
{
public static function unaFuncionUtil(string $string)
{
return strtoupper($string);
}
}
Paso 2: Agregar el Helper.php a los aliases
En config/app.php, en la sección de aliases agregar el Helper. En mi caso la sección de aliases se ve asi:
'aliases' => Facade::defaultAliases()->merge([
// 'Example' => App\Facades\Example::class,
'Helper' => App\Helpers\Helper::class,
])->toArray(),
Paso 3: Usar la terminal
Con la terminal en la raíz del proyecto escribir:
composer dump-autoload
Usar el helper
En los archivos blade se usa como:
{ { Helper::unaFuncionUtil('hola!') } }
o
{!! Helper::unaFuncionUtil('hola!') !!}
En los archivos php se usa como:
Helper::unaFuncionUtil('hola!')
Ejemplo de código
En mi proyecto mascotas.
Este es el Helper.
Este es el aliases en app.php
Fuente: stackoverflow.com/questions/28290332 — How to create custom helper functions in Laravel
Agregar una nueva versión de PHP a Laragon
Hay veces en la que será necesario cambiar la versión de PHP, por ejemplo, para usar Laravel 10 se necesita PHP 8 pero se tiene en la PC una versión inferior.
En estos casos se debe cambiar la versión de PHP a una más nueva y es lo que se verá en este apartado con el ejemplo de agregar PHP 8 a Laragon.
Obtener PHP 8 y agregarlo a Laragon
Se debe ir a php.net/downloads y dar click en los descargables para windows (Windows downloads) de la versión de PHP que se quiera, que en este caso el la versión PHP 8.3.1.
Después escoger una versión, por ejemplo, la versión PHP 8.3.1 Non Thread Safe (nts). Hay que descargar el .zip y descomprimirlo en la carpeta laragon/bin/php que es donde se instaló Laragon.
Cambiar la versión de PHP de Laragon
Abrir Laragon.
Con Laragon abierto dar click derecho en cualquier parte de la ventana de Laragon y después seleccionar:
PHP -> Version -> php-8.3.1
Puede ser requerido (o no) actualizar composer después de cambiar la versión de PHP.
Actualizar composer
Abrir la terminal de Laragon.
Después actualizar composer con composer self-update
Puede haber errores al actualizar de tipo:
Composer update failed: composer.phar could not be written.
Como se muestra en el siguiente hilo de GitHub.
La solución recomendada es: Cambiar a otra versión de PHP hasta encontrar alguna que no muestre errores. Si se desea usar Laravel 10 o superior se sugiere que la versión de PHP a la que se cambie sea >= 8.1.