Tag: PHP

Datatables con Laravel 6

Para sacarle partido a DataTables en Laravel, vamos a hacer una integración utilizando la librería original y un paquete especialmente creado por  Arjay Angeles (Yajra) que nos facilitará el manejo de la opción server-side de datatables.

Ya sabemos que DataTables es un plugin de jQuery para renderizar tablas de forma sencilla y con muchas funcionalidades. Por lo que, necesitaremos incluir jQuery en nuestro proyecto.

Instalación yajra/laravel-datatables

Para el uso de Datatables en Laravel, vamos a utilizar este paquete que nos facilitará mucho las cosas: jQuery DataTables API for Laravel 4|5|6

Lo instalamos vía composer

composer require yajra/laravel-datatables-oracle:"~9.0"

Toda la documentación la podemos obtener en https://yajrabox.com/docs/laravel-datatables/master/installation

Instalación DataTables

Instalaremos la librería de datatables utilizando NPM Node.JS

npm install --save datatables.net-dt

Para utilizarlo vamos a entrar a nuestro app.js e incluiremos

// DataTables
import dt from 'datatables.net-dt';

¿Listos para trabajar?

Vamos a utilizar nuestro modelo User para este ejemplo. En mi tabla tengo los datos que voy a mostrar a continuación, pero si quieres seguir el ejemplo con los datos que tienes en tu modelo, solamente tienes que cambiar las columnas de la tabla HTML y los datos del recurso.

Vamos a añadir en el documento a renderizar la estructura básica de HTML (views\users\index.blade.php)

<table id="users-table" class="table table-hover table-primary w-100">
    <thead>
        <tr>
            <th>ID</th>
            <th>Nombre</th>
            <th>Apellidos</th>
            <th>Sexo</th>
            <th>Email</th>
        </tr>
    </thead>
    <tbody></tbody>
</table>

Necesitaremos generar una URL para obtener los datos del recurso (routes\web.php)

Route::get('users/list', ['as' => 'users.list', 'uses' => 'UserController@usersList']);

Para la llamada a recuperar datos, añadiremos la utilización de la librería en el controlador (app\Http\Controllers\UserController.php)

use Yajra\DataTables\Facades\DataTables;

En el mismo controlador, crearemos un método userList() que recuperará los datos con una consulta y utilizaremos la función datatables (PHP) para crear una respuesta de tipo JSON.


/**
 * Devuelve el listado en JSON de los usuarios
 *
 * @param User $user
 * @param Request $request
 * @return void
 */
public function usersList(User $user, Request $request){

    // Usuarios
    return datatables($user->get())->toJson();
}

Ahora volvemos a abrir resources\js\app.js y añadiremos la función datatables (JS) que nos renderizará los datos en la tabla. Para hacer la llamada, utilizamos una propiedad (columns) con las columnas correspondientes.

¡Mucho Ojo! Tienen que ser el mismo número de columnas que el “thead” de la tabla HTML.

$('#users-table').DataTable({
    processing: true,
    serverSide: true,
    language: {
        "url": "//cdn.datatables.net/plug-ins/1.10.20/i18n/Spanish.json"
    },
    ajax: {
        url: "/users/list",
        dataSrc: "data",
        type: "GET"
    },
    columns: [
        { data: 'id' },
        { data: 'nombre' },
        { data: 'apellidos' },
        { data: 'sexo' },
        { data: 'email' }
    ],
});

Yo estoy usando VueJS para trabajar. Vamos a utilizar el hook mounted y dentro de ella la función vm.$nextTick que lo que hará es accionar el código una vez se haya renderizado la vista completa.

if ($('#users-index').length > 0) {
    const users_index = new Vue({
        el: '#users-index',
        data: {
            usersTable: null
        },
        mounted() {
            this.$nextTick(function() {
                // Código que se ejecutará solo después de
                // haber renderizado la vista completa

                this.getDataTableUsers()
            })
        },
        methods: {
            getDataTableUsers: function() {
                this.usersTable = $('#users-table').DataTable({
                    processing: true,
                    serverSide: true,
                    language: {
                        "url": "//cdn.datatables.net/plug-ins/1.10.20/i18n/Spanish.json"
                    },
                    ajax: {
                        url: "/users/list",
                        dataSrc: "data",
                        type: "GET"
                    },
                    columns: [
                        { data: 'id' },
                        { data: 'nombre' },
                        { data: 'apellidos' },
                        { data: 'sexo' },
                        { data: 'email' }
                    ],
                });
            }
        }
    })
}

Si no estás utilizando VUE, puedes utilizar jQuery y accionar la renderización.

$(document).ready(function() {
    var table = $('#users-table').DataTable({
        processing: true,
        serverSide: true,
        language: {
            "url": "//cdn.datatables.net/plug-ins/1.10.20/i18n/Spanish.json"
        },
        ajax: {
            url: "/users/list",
            dataSrc: "data",
            type: "GET"
        },
        columns: [
            { data: 'id' },
            { data: 'nombre' },
            { data: 'apellidos' },
            { data: 'sexo' },
            { data: 'email' }
        ],
    });
});

Crear Helpers personalizados en Laravel 6

Los «helpers» son métodos o funciones de ayuda que nos facilitan acciones de modificación o tratamiento de datos.

Laravel ya tiene unos helpers definidos que pueden ayudarte. Pero, ¿Y si necesitas definir tus propias funciones de ayuda?

¿Qué tipo de funciones querrías definir en este archivo?

Por ejemplo, podríamos necesitar una función que reciba por parámetro una fecha con formato año/mes/día (Y/m/d) y darle el formato de día/mes/año (d/m/Y).

Para ello vamos a crear nuestro archivo y lo publicaremos en app/helpers.php

Dentro añadiremos la función de ayuda:

<?php
/**
 * Función que nos devuelve la fecha formateada en Español 
 *
 * @param [type] $date
 * @return void
 */
function formatDateToEsp($date){

    return date("d/m/Y", strtotime($date));

}

Para cargar los helpers en nuestra aplicación, vamos a abrir el archivo composer.json, buscamos la clave autoload y ahí añadiremos una nueva clave «files» que contendrá dentro la ruta de nuestro archivo helpers.php:

"autoload": {
        "psr-4": {
            "App\\": "app/"
        },
        "files": [
            "App/helpers.php"
        ],
        "classmap": [
            "database/seeds",
            "database/factories"
        ]
    },

Una vez aplicado, abriremos nuestra consola en la carpeta raíz y escribiremos composer dump-autoload.

$ composer dump-autoload
Generating optimized autoload files

Una vez terminado podremos revisar en nuestro composer.lock las líneas añadidas:

"autoload": {
                "files": [
                    "src/Illuminate/Foundation/helpers.php",
                    "src/Illuminate/Support/helpers.php"
                ],
                "psr-4": {
                    "Illuminate\\": "src/Illuminate/"
                }
            },

Ahora podremos aplicar esta función, por ejemplo, a un listado de datos:

<table class="table align-items-center table-flush">
	<thead class="thead-light">
		<tr>
			<th scope="col">ID</th>
			<th scope="col">FECHA</th>
		</tr>
	</thead>
	<tbody>
		@foreach ($datos as $dato)
			<tr>
				<td>{{ $dato->id }}</td>
				<td>{{ formatDateToEsp($dato->fecha) }}</td>
			</tr>
		@endforeach
	</tbody>
</table>

FECHA SIN FORMATEAR

FECHA FORMATEADA CON FUNCIÓN HELPER

DataTables ssp.class.php para SQL SERVER

SSP Class original

https://github.com/DataTables/DataTables/blob/master/examples/server_side/scripts/ssp.class.php

Mejoras SSP Class con respecto al original

static function data_output()
Modificado la sección de Formatter para añadir el ID único al tr de la tabla
static function filter()
Añadido MAYÚSCULAS en las columnas para mejorar la búsqueda de strings
static function limit()
Añadido «LIMIT» PARA SQL SERVER
static function complex()
Modificación en la construcción de la sentencia principal de SQL (Main query) para SQL SERVER anteriores al 2012 ya que NO existe OFFSET.
static function sql_connect()
Añadido condiciones para añadir conexión a SQL Server.

HTML Ejemplo

<table id="consentimiento-datatable" class="display">
	<thead>
		<tr role="row">
			<th>Código</th>
			<th>Tabla</th>
			<th>Nombre</th>
			<th>Email</th>
			<th>Fecha Envío</th>
			<th>Fecha Aceptación</th>
			<th>Fecha Alta</th>
			<th>Fecha Baja</th>
			<th>DNI</th>
		</tr>
	</thead>
	<tfoot>
		<tr>
			<td>Código</td>
			<td>Tabla</td>
			<td>Nombre</td>
			<td>Email</td>
			<td>Fecha Envío</td>
			<td>Fecha Aceptación</td>
			<td>Fecha Alta</td>
			<td>Fecha Baja</td>
			<td>DNI</td>
		</tr>
	</tfoot>
</table>

Configuración JAVASCRIPT

<script type="text/javascript" charset="utf-8">
var table;
$(document).ready(function() {
	/* CREACIÓN TABLA DINÁMICA - DATATABLE */
	table = $('#consentimiento-datatable').DataTable({
		"lengthMenu": [
			[20, 25, 50, 100, 250, -1],
			[20, 25, 50, 100, 250, "Todas las entradas"]
		],
		select: true,
		dom: 'lBfrtip',
		"processing": true,
		"serverSide": true,
		"ajax": "./AJAX/acceso.php",
		"columns": [
			{ "data": "Codigo" },
			{ "data": "Tabla" },
			{ "data": "Nombre" },
			{ "data": "Email" },
			{ 
				"class": "fechaEnvio", 
				"data": "FechaEnvio" 
			},
			{ 
				"class": "fechaAceptacion", 
				"data": "FechaAceptacion" 
			},
			{ 
				"class": "fechaAlta", 
				"data": "FechaAlta" 
			},
			{ 
				"class": "fechaBaja", 
				"data": "FechaBaja" 
			},
			{ "data": "DNI" }
		]
	});
</script>

Configuración inicial de DataTables (./AJAX/acceso.php)

//Parámetros de conexión al SQL Server
$serverName = "PC\SQLEXPRESS";
$database = "DATABASE";
$connectionOptions = array(
    "Database" => $database,
    "UID" => "",
    "PWD" => ""
);
/*
    * DataTables server-side processing script.
    *
    * See http://datatables.net/usage/server-side for full details on the server-
    * side processing requirements of DataTables.
    *
    * @license MIT - http://datatables.net/license_mit
    */

    /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
    * Easy set variables
    */

    // DB table to use
    $table = '[DATABASE].[dbo].[Table]';

    // Table's primary key
    $primaryKey = 'Codigo';

    // Array of database columns which should be read and sent back to DataTables.
    // The `db` parameter represents the column name in the database, while the `dt`
    // parameter represents the DataTables column identifier. In this case object
    // parameter names
    $columns = array(
        array(
            'db' => 'Codigo AS DT_RowId',
            'dt' => 'DT_RowId',
            'formatter' => function( $d, $row ) {
                // Technically a DOM id cannot start with an integer, so we prefix
                // a string. This can also be useful if you have multiple tables
                // to ensure that the id is unique with a different prefix
                return 'row_'.$d;
            }
        ),
        array( 'db' => 'Codigo',  'dt' => 'Codigo' ),
        array( 'db' => 'Tabla',   'dt' => 'Tabla' ),
        array( 'db' => 'Nombre',   'dt' => 'Nombre' ),
        array( 'db' => 'Email',     'dt' => 'Email' ),
        array( 'db' => '[Fecha Envio]', 'dt' => 'FechaEnvio' ),
        array( 'db' => '[Fecha Aceptacion]', 'dt' => 'FechaAceptacion' ),
        array( 'db' => '[Fecha Alta]', 'dt' => 'FechaAlta' ),
        array( 'db' => '[Fecha Baja]', 'dt' => 'FechaBaja' ),
        array( 'db' => 'DNI',     'dt' => 'DNI' )
    );

    // Parámetros de conexión a BASE DE DATOS
    // SqlserverVer: MySQL, Sqlserver
    // SqlserverVer: 2008, 2009... NULL (POSTERIOR 2012)
    $sql_details = array(
        "type" => "Sqlserver",
        "server_version" => 2008,
        'user' => $connectionOptions['UID'],
        'pass' => $connectionOptions['PWD'],
        'db'   => $database,
        'host' => $serverName
    );

    /**
     * Clase SSP
     * Controla el acceso a la base de datos y las consultas para DataTables
     */
    require( 'ssp.class.php' );

    echo json_encode(
        SSP::complex($_GET, $sql_details, $table, $primaryKey, $columns, null, "(Tabla IN ('ALUMNO','CONTACTO','PRUEBA'))")
    );

SSP Class de DataTables (./AJAX/ssp.class.php)

<?php
/*
 * Helper functions for building a DataTables server-side processing SQL query
 *
 * The static functions in this class are just helper functions to help build
 * the SQL used in the DataTables demo server-side processing scripts. These
 * functions obviously do not represent all that can be done with server-side
 * processing, they are intentionally simple to show how it works. More complex
 * server-side processing operations will likely require a custom script.
 *
 * See http://datatables.net/usage/server-side for full details on the server-
 * side processing requirements of DataTables.
 *
 * @license MIT - http://datatables.net/license_mit
 */
// REMOVE THIS BLOCK - used for DataTables test environment only!
/* $file = $_SERVER['DOCUMENT_ROOT'].'/datatables/pdo.php';
if ( is_file( $file ) ) {
	include( $file );
}*/

class SSP
{

	private static $serverType;
	private static $serverTypeVer  = NULL;

	/**
	 * Create the data output array for the DataTables rows
	 *
	 *  @param  array $columns Column information array
	 *  @param  array $data    Data from the SQL get
	 *  @return array          Formatted data in a row based format
	 */
	static function data_output($columns, $data)
	{
		$out = array();
		for ($i = 0, $ien = count($data); $i < $ien; $i++) {
			$row = array();

			for ($j = 0, $jen = count($columns); $j < $jen; $j++) {
				$column = $columns[$j];
				// Is there a formatter?
				if (isset($column['formatter'])) {

					// 	Formatter para añadir el ID único al tr de la tabla
					// 	Si el identificador de la columna de DataTable 'dt' es DT_RowId
					// 	añadirá la columna aunque esté duplicada en la sentencia SQL ya que en vez
					// 	de utilizar 'db' como columna utilizará el 'dt' que hacer referencia a: 
					// 	column AS DT_RowId
					/* 	$columns = array(
							array(
								'db' => 'Codigo AS DT_RowId',
								'dt' => 'DT_RowId',
								'formatter' => function( $d, $row ) {
									// Technically a DOM id cannot start with an integer, so we prefix
									// a string. This can also be useful if you have multiple tables
									// to ensure that the id is unique with a different prefix
									return 'row_'.$d;
								}
							)
						);
					*/

					if ($column['dt'] == 'DT_RowId') {
						$row[$column['dt']] = $column['formatter']($data[$i][$column['dt']], $data[$i]);
					} else {
						$row[$column['dt']] = $column['formatter']($data[$i][$column['db']], $data[$i]);
					}
				} else {

					// Eliminamos corchetes SQL SERVER
					$dbColumn = str_ireplace(array('[', ']'), array('', ''), $columns[$j]['db']);
					$row[$column['dt']] = $data[$i][$dbColumn];
				}
			}
			$out[] = $row;
		}
		return $out;
	}
	/**
	 * Database connection
	 *
	 * Obtain an PHP PDO connection from a connection details array
	 *
	 *  @param  array $conn SQL connection details. The array should have
	 *    the following properties
	 *     * host - host name
	 *     * db   - database name
	 *     * user - user name
	 *     * pass - user password
	 *  @return resource PDO connection
	 */
	static function db($conn)
	{
		if (is_array($conn)) {
			return self::sql_connect($conn);
		}
		return $conn;
	}
	/**
	 * Paging
	 *
	 * Construct the LIMIT clause for server-side processing SQL query
	 *
	 *  @param  array $request Data sent to server by DataTables
	 *  @param  array $columns Column information array
	 *  @return string SQL limit clause
	 */
	static function limit($request, $columns)
	{
		$limit = '';
		if (isset($request['start']) && $request['length'] != -1) {

			// "LIMIT" PARA SQL SERVER
			if (self::$serverType == 'Sqlserver') {
				// SQL SERVER >= 2012
				if (empty(self::$serverTypeVer)) {
					$limit = " OFFSET " . intval($request['start']) . " ROWS FETCH NEXT " . intval($request['length']) . " ROWS ONLY";

					// SQL SERVER < 2012
				} elseif (self::$serverTypeVer < 2012) {
					$limit = " row > " . intval($request['start']) . " and row <= " . (intval($request['start']) + intval($request['length'])) . " ";
				}
			} else {
				$limit = " LIMIT " . intval($request['start']) . ", " . intval($request['length']);
			}
		}
		return $limit;
	}
	
	/**
	 * Ordering
	 *
	 * Construct the ORDER BY clause for server-side processing SQL query
	 *
	 *  @param  array $request Data sent to server by DataTables
	 *  @param  array $columns Column information array
	 *  @return string SQL order by clause
	 */
	static function order($request, $columns)
	{
		$order = '';
		if (isset($request['order']) && count($request['order'])) {
			$orderBy = array();
			$dtColumns = self::pluck($columns, 'dt');
			for ($i = 0, $ien = count($request['order']); $i < $ien; $i++) {
				// Convert the column index into the column data property
				$columnIdx = intval($request['order'][$i]['column']);
				$requestColumn = $request['columns'][$columnIdx];
				$columnIdx = array_search($requestColumn['data'], $dtColumns);
				$column = $columns[$columnIdx];
				if ($requestColumn['orderable'] == 'true') {
					$dir = $request['order'][$i]['dir'] === 'asc' ?
						'ASC' : 'DESC';
					$orderBy[] = $column['db'] . ' ' . $dir;
				}
			}
			if (count($orderBy)) {
				$order = 'ORDER BY ' . implode(', ', $orderBy);
			}
		}
		return $order;
	}

	/**
	 * Searching / Filtering
	 *
	 * Construct the WHERE clause for server-side processing SQL query.
	 *
	 * NOTE this does not match the built-in DataTables filtering which does it
	 * word by word on any field. It's possible to do here performance on large
	 * databases would be very poor
	 *
	 *  @param  array $request Data sent to server by DataTables
	 *  @param  array $columns Column information array
	 *  @param  array $bindings Array of values for PDO bindings, used in the
	 *    sql_exec() function
	 *  @return string SQL where clause
	 */
	static function filter($request, $columns, &$bindings)
	{
		$globalSearch = array();
		$columnSearch = array();
		$dtColumns = self::pluck($columns, 'dt');
		if (isset($request['search']) && $request['search']['value'] != '') {
			$str = $request['search']['value'];
			for ($i = 0, $ien = count($request['columns']); $i < $ien; $i++) {
				$requestColumn = $request['columns'][$i];
				$columnIdx = array_search($requestColumn['data'], $dtColumns);
				$column = $columns[$columnIdx];
				if ($requestColumn['searchable'] == 'true') {

					// MAYÚSCULAS para mejorar la búsqueda de strings
					$binding = self::bind($bindings, '%' . mb_strtoupper($str) . '%', PDO::PARAM_STR);
					$globalSearch[] = " UPPER(" . $column['db'] . ") LIKE " . $binding;
				}
			}
		}
		// Individual column filtering
		if (isset($request['columns'])) {
			for ($i = 0, $ien = count($request['columns']); $i < $ien; $i++) {
				$requestColumn = $request['columns'][$i];
				$columnIdx = array_search($requestColumn['data'], $dtColumns);
				$column = $columns[$columnIdx];
				$str = $requestColumn['search']['value'];
				if (
					$requestColumn['searchable'] == 'true' &&
					$str != ''
				) {

					// MAYÚSCULAS para mejorar la búsqueda de strings
					$binding = self::bind($bindings, '%' . mb_strtoupper($str) . '%', PDO::PARAM_STR);
					$columnSearch[] = " UPPER(" . $column['db'] . ") LIKE " . $binding;
				}
			}
		}
		// Combine the filters into a single string
		$where = '';
		if (count($globalSearch)) {
			$where = '(' . implode(' OR ', $globalSearch) . ')';
		}
		if (count($columnSearch)) {
			$where = $where === '' ?
				implode(' AND ', $columnSearch) : $where . ' AND ' . implode(' AND ', $columnSearch);
		}
		if ($where !== '') {
			$where = 'WHERE ' . $where;
		}
		return $where;
	}
	/**
	 * Perform the SQL queries needed for an server-side processing requested,
	 * utilising the helper functions of this class, limit(), order() and
	 * filter() among others. The returned array is ready to be encoded as JSON
	 * in response to an SSP request, or can be modified if needed before
	 * sending back to the client.
	 *
	 *  @param  array $request Data sent to server by DataTables
	 *  @param  array|PDO $conn PDO connection resource or connection parameters array
	 *  @param  string $table SQL table to query
	 *  @param  string $primaryKey Primary key of the table
	 *  @param  array $columns Column information array
	 *  @return array          Server-side processing response array
	 */
	static function simple($request, $conn, $table, $primaryKey, $columns)
	{
		$bindings = array();
		$db = self::db($conn);
		// Build the SQL query string from the request
		$limit = self::limit($request, $columns);
		$order = self::order($request, $columns);
		$where = self::filter($request, $columns, $bindings);
		// Main query to actually get the data
		$data = self::sql_exec(
			$db,
			$bindings,
			"SELECT " . implode(", ", self::pluck($columns, 'db')) . "
			 FROM $table
			 $where
			 $order
			 $limit"
		);
		// Data set length after filtering
		$resFilterLength = self::sql_exec(
			$db,
			$bindings,
			"SELECT COUNT({$primaryKey})
			 FROM   $table
			 $where"
		);
		$recordsFiltered = $resFilterLength[0][0];
		// Total data set length
		$resTotalLength = self::sql_exec(
			$db,
			"SELECT COUNT({$primaryKey})
			 FROM   $table"
		);
		$recordsTotal = $resTotalLength[0][0];
		/*
		 * Output
		 */
		return array(
			"draw"            => isset($request['draw']) ?
				intval($request['draw']) : 0,
			"recordsTotal"    => intval($recordsTotal),
			"recordsFiltered" => intval($recordsFiltered),
			"data"            => self::data_output($columns, $data)
		);
	}
	/**
	 * The difference between this method and the simple one, is that you can
	 * apply additional where conditions to the SQL queries. These can be in
	 * one of two forms:
	 *
	 * * 'Result condition' - This is applied to the result set, but not the
	 *   overall paging information query - i.e. it will not effect the number
	 *   of records that a user sees they can have access to. This should be
	 *   used when you want apply a filtering condition that the user has sent.
	 * * 'All condition' - This is applied to all queries that are made and
	 *   reduces the number of records that the user can access. This should be
	 *   used in conditions where you don't want the user to ever have access to
	 *   particular records (for example, restricting by a login id).
	 *
	 *  @param  array $request Data sent to server by DataTables
	 *  @param  array|PDO $conn PDO connection resource or connection parameters array
	 *  @param  string $table SQL table to query
	 *  @param  string $primaryKey Primary key of the table
	 *  @param  array $columns Column information array
	 *  @param  string $whereResult WHERE condition to apply to the result set
	 *  @param  string $whereAll WHERE condition to apply to all queries
	 *  @return array          Server-side processing response array
	 */
	static function complex($request, $conn, $table, $primaryKey, $columns, $whereResult = null, $whereAll = null)
	{
		$bindings = array();
		$db = self::db($conn);

		$whereAllSql = '';
		// Build the SQL query string from the request
		$limit = self::limit($request, $columns);
		$order = self::order($request, $columns);
		$where = self::filter($request, $columns, $bindings);
		$whereResult = self::_flatten($whereResult);
		$whereAll = self::_flatten($whereAll);

		if ($whereResult) {
			$where = $where ?
				$where . ' AND ' . $whereResult : 'WHERE ' . $whereResult;
		}

		if ($whereAll) {
			$where = $where ?
				$where . ' AND ' . $whereAll : 'WHERE ' . $whereAll;
			$whereAllSql = 'WHERE ' . $whereAll;
		}

		if (self::$serverType == 'Sqlserver' &&  !empty(self::$serverTypeVer) && self::$serverTypeVer < 2012) {
			// SQL SERVER ES MUY RARO
			// Main query to actually get the data
			// Modificado para SQL SERVER anteriores al 2012 ya que NO existe OFFSET.
			$imploded = implode(", ", self::pluck($columns, 'db'));
			$data = self::sql_exec(
				$db,
				$bindings,
				"SELECT $imploded
				FROM (SELECT $imploded, row_number() over ($order) as row from $table $where) A
				WHERE
				$limit
				$order"
			);
		} else {

			// Main query to actually get the data
			$data = self::sql_exec(
				$db,
				$bindings,
				"SELECT " . implode(", ", self::pluck($columns, 'db')) . "
				FROM $table
				$where
				$order
				$limit"
			);
		}

		// Data set length after filtering
		$resFilterLength = self::sql_exec(
			$db,
			$bindings,
			"SELECT COUNT({$primaryKey})
			FROM $table
			$where"
		);

		$recordsFiltered = $resFilterLength[0][0];

		// Total data set length
		$resTotalLength = self::sql_exec(
			$db,
			"",
			"SELECT COUNT({$primaryKey})
			FROM $table 
			$whereAllSql"
		);

		$recordsTotal = $resTotalLength[0][0];

		/*
		 * Output
		 */
		return array(
			"draw"            => isset($request['draw']) ? intval($request['draw']) : 0,
			"recordsTotal"    => intval($recordsTotal),
			"recordsFiltered" => intval($recordsFiltered),
			"data"            => self::data_output($columns, $data)
		);
	}
	/**
	 * Connect to the database
	 *
	 * @param  array $sql_details SQL server connection details array, with the
	 *   properties:
	 *     * host - host name
	 *     * db   - database name
	 *     * user - user name
	 *     * pass - user password
	 * @return resource Database connection handle
	 */
	static function sql_connect($sql_details)
	{
		try {

			if ($sql_details['type'] == 'Sqlserver') {
				$db = @new PDO(
					"sqlsrv:Server=" . $sql_details['host'] . ";Database=" . $sql_details['db'],
					$sql_details['user'],
					$sql_details['pass'],
					array(PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION)
				);

				self::$serverType = $sql_details['type'];
				self::$serverTypeVer = $sql_details['server_version'];
			} else {
				$db = @new PDO(
					"mysql:host={$sql_details['host']};dbname={$sql_details['db']}",
					$sql_details['user'],
					$sql_details['pass'],
					array(PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION)
				);
			}
		} catch (PDOException $e) {
			self::fatal(
				"An error occurred while connecting to the database. " .
					"The error reported by the server was: " . $e->getMessage()
			);
		}
		return $db;
	}
	/**
	 * Execute an SQL query on the database
	 *
	 * @param  resource $db  Database handler
	 * @param  array    $bindings Array of PDO binding values from bind() to be
	 *   used for safely escaping strings. Note that this can be given as the
	 *   SQL query string if no bindings are required.
	 * @param  string   $sql SQL query to execute.
	 * @return array         Result from the query (all rows)
	 */
	static function sql_exec($db, $bindings, $sql = null)
	{
		// Argument shifting
		if ($sql === null) {
			$sql = $bindings;
		}

		/* var_dump($sql);
		die(); */

		$stmt = $db->prepare($sql);

		// var_dump($bindings);

		// Bind parameters
		if (is_array($bindings)) {
			for ($i = 0, $ien = count($bindings); $i < $ien; $i++) {
				$binding = $bindings[$i];
				$stmt->bindValue($binding['key'], $binding['val'], $binding['type']);
			}
		}

		/* echo var_dump($stmt);
		die(); */

		// Execute
		try {
			$stmt->execute();
		} catch (PDOException $e) {
			self::fatal("An SQL error occurred: " . $e->getMessage());
		}

		// Return all
		return $stmt->fetchAll(PDO::FETCH_BOTH);
	}

	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
	 * Internal methods
	 */
	/**
	 * Throw a fatal error.
	 *
	 * This writes out an error message in a JSON string which DataTables will
	 * see and show to the user in the browser.
	 *
	 * @param  string $msg Message to send to the client
	 */
	static function fatal($msg)
	{
		echo json_encode(array(
			"error" => $msg
		));
		exit(0);
	}

	/**
	 * Create a PDO binding key which can be used for escaping variables safely
	 * when executing a query with sql_exec()
	 *
	 * @param  array &$a    Array of bindings
	 * @param  *      $val  Value to bind
	 * @param  int    $type PDO field type
	 * @return string       Bound key to be used in the SQL where this parameter
	 *   would be used.
	 */
	static function bind(&$a, $val, $type)
	{
		$key = ':binding_' . count($a);
		$a[] = array(
			'key' => $key,
			'val' => $val,
			'type' => $type
		);
		return $key;
	}

	/**
	 * Pull a particular property from each assoc. array in a numeric array, 
	 * returning and array of the property values from each item.
	 *
	 *  @param  array  $a    Array to get data from
	 *  @param  string $prop Property to read
	 *  @return array        Array of property values
	 */
	static function pluck($a, $prop)
	{
		$out = array();
		for ($i = 0, $len = count($a); $i < $len; $i++) {
			$out[] = $a[$i][$prop];
		}
		return $out;
	}

	/**
	 * Return a string from an array or a string
	 *
	 * @param  array|string $a Array to join
	 * @param  string $join Glue for the concatenation
	 * @return string Joined string
	 */
	static function _flatten($a, $join = ' AND ')
	{
		if (!$a) {
			return '';
		} else if ($a && is_array($a)) {
			return implode($join, $a);
		}
		return $a;
	}
}

DataTables: Tried to bind parameter number 65536. SQL Server supports a maximum of 2100 parameters.

Podemos encontrar este error en el método complex() de la librería ssp.class.php de DataTables. Esta función en casos normales debería funcionar, pero resulta que si utilizas el filtro de repente nos salta este error.

«error»:»An SQL error occurred: SQLSTATE[IMSSP]: Tried to bind parameter number 65536. SQL Server supports a maximum of 2100 parameters.

¿Qué está pasando?

Vamos a empezar con entender que hace la función sql_exec. Esta función ejecuta la sql utilizando variables Bind para realizar la ejecución de los filtros Where. La función que realiza la sustitución es bindValue que se ejecuta siempre que $bindings sea un array()

// Bind parameters
if ( is_array( $bindings ) ) {
    for ( $i=0, $ien=count($bindings) ; $i<$ien ; $i++ ) {
        $binding = $bindings[$i];
        $stmt->bindValue( $binding['key'], 
        $binding['val'], $binding['type'] );
    }
}

En la ejecución del método complex() hay 3 llamadas al sql_exec:

  1. La prímera (main query) que nos devuelve los datos. 
  2. La segunda (Data set length after filtering) que nos devuelve el número total de registros filtrados.
  3. La tercera (Total data set length) que es el total de registros sin filtrar.

La que nos da el error es la tercera llamada. En esta llamada intenta utilizar la variable $bindings que sustituiría los valores del Where.  Pero la variable Where que se utiliza es $whereAllSql que NO TIENE NINGÚN VALOR A SUSTITUIR.

$whereAllSql es un parámetro que le podemos pasar al método complex() para realizar la consulta por defecto. Por ejemplo un listado de alumnos donde siempre queremos que aparezcan los de la sección A. Añadiríamos a ese parámetro el texto correspondiente a la cláusula where:

SSP::complex($_GET, $sql_details, $table, $primaryKey, $columns, null, "(section='A')")

SOLUCIÓN

Por lo que el error lo podemos controlar de forma sencilla. La solución  es enviar el parámetro $bindings vacío a la función sql_exec que nos da el error:

Código Original

// Total data set length
$resTotalLength = self::sql_exec( $db, 
$bindings,
"SELECT COUNT({$primaryKey})
FROM   $table 
$whereAllSql"
);

Código Nuevo

// Total data set length
$resTotalLength = self::sql_exec( $db, 
"",
"SELECT COUNT({$primaryKey})
FROM   $table 
$whereAllSql"
);

Moodle: $CFG variables

La variable global $CFG y sus propiedades se definen en lib/setup.php

// Directorio raíz
$CFG->dirroot

// URL raíz
$CFG->wwwroot

// Directorio de Librerías
$CFG->libdir

// Directorio Temporal
$CFG->tempdir

// Directorio Caché
$CFG->cachedir

Moodle Error: Output can not be buffered before instantiating table_dataformat_export_format

Lo que nos dice este error es que no debe haber ningún tipo de Output si vamos a realizar una exportación.

Aún dejando limpio el HTML, no era capaz de eliminar este error por lo que buscando en el código eliminé la excepción y lo sustituí por un ob_clean().

En lib/table_lib.php buscamos el constructor de la case table_dataformat_export_format y realizamos la operación:

if (ob_get_length()) {
            // EXCEPTION was not helping
            // Is this the solution? It solves problem when exporting
            ob_clean();
            // throw new coding_exception("Output can not be buffered before instantiating table_dataformat_export_format");
        }

Por el momento nos dejará realizar la exportación sin problema, pero no sé si esta sea la mejor solución.

MOODLE Mostrar Tabla de Datos HTML con flexible_table

Vamos a partir de la base en la que no sé nada sobre la API de Moodle. Buscando información, he encontrado que NO HAY CASI NADA DE INFORMACIÓN / DOCUMENTACIÓN / EJEMPLOS.

Por lo que voy a compartir una mini guía personal y algunos recursos que he utilizado para poder mostrar una tabla dinámica que incluye paginación, ordenación y exportación de datos.

Para ello vamos a crear nuestra propia clase partiendo de la clase table_sql la cual extiende la clase flexible_table.

// Esta clase se encuentra en 
// lib\tablelib.php
class table_sql extends flexible_table{
}


// Crearemos nuestra propia clase en nuestra carpeta
// personal o en la misma carpeta lib
class table_sql_pers extends table_sql {
}

La idea de crear otra clase a partir de la table_sql es añadir un nuevo parámetro al método set_sql y personalizar así nuestra MySql Query sin tener que modificar la clase original.

En el mismo archivo he creado la clase para la gestión de alumnos creando una query personalizada dividiendo las partes de SELECT FROM WHERE y GROUP BY en variables para poder añadir los datos que necesitemos:

<?php

require "$CFG->libdir/tablelib.php";

/**
 * Clase de gestión personalizada de Alumnos
 * Métodos:
 * 		LIstado
 * 		Importación
 */

class GestionAlumnos{

	/**
	 * Variable FIELDS para SELECT
	 *
	 * @var string
	 */
	private $selectAlumnosFields = "
		{user}.`id`,
		DATE_FORMAT(
			FROM_UNIXTIME({user}.`timecreated`),
			'%d/%m/%Y %H:%i:%s'
		) AS `timecreated`,
		DATE_FORMAT(
			FROM_UNIXTIME({user}.`timemodified`),
			'%d/%m/%Y %H:%i:%s'
		) AS `timemodified`,
		{user}.`username` AS `username`
	";

	/**
	 * Variable FROM con las tablas y JOINS
	 *
	 * @var string
	 */
	private $selectAlumnosFrom = "
	(
		(
			(
				(
					(
						(
							(
								(
									(
										{role_assignments}
										LEFT JOIN {user} ON(
											(
												{user}.`id` = {role_assignments}.`userid`
											)
										)
									)
									LEFT JOIN {context} ON(
										(
											{role_assignments}.`contextid` = {context}.`id`
										)
									)
								)
							)
							JOIN {user_info_data} ON(
								(
									{user}.`id` = {user_info_data}.`userid`
								)
							)
						)
						JOIN {user_enrolments} ON(
							(
								{user_enrolments}.`userid` = {user}.`id`
							)
						)
					)
					JOIN {enrol} ON(
						(
							{enrol}.`id` = {user_enrolments}.`enrolid`
						)
					)
				)
				JOIN {course} ON(
					(
						{course}.`id` = {enrol}.`courseid`
					)
				)
			)
		)
	)
	";

	/**
	 * Variable WHERE
	 *
	 * @var string
	 */
	private $selectAlumnosWhere = "
		(
			NOT(
				(
					{user}.`firstname` LIKE '%\\_%'
				)
			)
		)
		AND (
			{user_info_data}.`fieldid` = 1
		)
		AND (
			{role_assignments}.`roleid` = 5
		)
	";

	/**
	 * Variable GROUP BY
	 *
	 * @var string
	 */
	private $selectAlumnosGroupBy = "
		{user}.`id`,
		{user}.`timecreated`,
		{user}.`timemodified`,
		{user}.`username`
	";

	/**
	 * Variable con las columnas que vamos a mostrar de la query original
	 *
	 * @var array
	 */
	protected $columns = array(
		'id',
		'username',
		'timecreated',
		'timemodified'
	);

	/**
	 * Cabeceras para el listado de la tabla HTML
	 *
	 * @var array
	 */
	protected $headers = array(
		'ID',
		'Usuario',
		'F. Crea.',
		'F. Modif.'
	);

	protected $database;
	protected $baseUrl;

	/**
	 * Constructor al que pasamos el recurso de BBDD
	 * y la URL para mostrar los links de paginación,
	 * ordenación en la tabla de datos
	 *
	 * @param [type] $DB
	 * @param [type] $baseUrl
	 */
	public function __construct($DB, $baseUrl)
	{
		$this->database = $DB;
		$this->baseUrl = $baseUrl;
	}

	/**
	 * Setea las columnas para mostrar solamente las que necesitamos
	 *
	 * @param array $columns
	 * @return void
	 */
	public function setColumns($columns = array()){
		$this->columns = $columns;
	}

	/**
	 * Undocumented function
	 *
	 * @param array $headers
	 * @return void
	 */
	public function setHeaders($headers = array()){
		$this->headers = $headers;
	}

	/**
	 * Crea la tabla para mostrar el listado de alumnos
	 * Devuelve el recurso $table que se podrá utilizar 
	 * para renderizar la tabla con el método out()
	 * Ejemplo: $table->out(15, true); 
	 * 
	 * Lo hacemos así para poder verificar cuando se hace un renderizado en HTML
	 * o una exportación ya que a la hora de exportar no debemos mostrar más que
	 * los datos. En la página donde llamamos esta clase y sus métodos debemos
	 * utilizar la siguiente condición antes de mostrar los headers / footers o
	 * cualquier tipo de $OUTPUT:
	 * if (!$table->is_downloading()) {
	 * 		echo $OUTPUT->header();
	 * 		echo $OUTPUT->footer();
	 * }
	 *
	 * @return $table
	 */
	public function getListAlumnosHTML(){

		$table = new table_sql_alumnos('listado-alumnos');

		$download = optional_param('download', '', PARAM_ALPHA);
		$table->is_downloading($download, 'Listado de Alumnos', 'Listado');

		$table->define_columns($this->columns);

		$table->define_headers($this->headers);

		$table->set_sql(
			$this->selectAlumnosFields,
			$this->selectAlumnosFrom,
			$this->selectAlumnosWhere,
			array(),
			$this->selectAlumnosGroupBy
		);

		$table->define_baseurl($this->baseUrl);

		return $table;
	}
}


/**
 * Extendemos la clase para modificar el método set_sql y añadir un nuevo parámetro $groupBy
 */
class table_sql_alumnos extends table_sql {

	/**
     * Set the sql to query the db. Query will be :
     *      SELECT $fields FROM $from WHERE $where
     * Of course you can use sub-queries, JOINS etc. by putting them in the
     * appropriate clause of the query.
     */

	/**
	 * MODIFICADO del original para añadir el parámetro GROUP BY
	 */
    function set_sql($fields, $from, $where, array $params = array(), $groupBy) {
        $this->sql = new stdClass();
        $this->sql->fields = $fields;
        $this->sql->from = $from;
        $this->sql->where = $where;
        $this->sql->params = $params;
        $this->sql->groupBy = $groupBy;
    }

    /**
     * Query the db. Store results in the table object for use by build_table.
     *
     * @param int $pagesize size of page for paginated displayed table.
     * @param bool $useinitialsbar do you want to use the initials bar. Bar
     * will only be used if there is a fullname column defined for the table.
     */
    function query_db($pagesize, $useinitialsbar=true) {
        global $DB;
        if (!$this->is_downloading()) {
            if ($this->countsql === NULL) {
                $this->countsql = 'SELECT COUNT(1) FROM '.$this->sql->from.' WHERE '.$this->sql->where;
                $this->countparams = $this->sql->params;
            }
            $grandtotal = $DB->count_records_sql($this->countsql, $this->countparams);
            if ($useinitialsbar && !$this->is_downloading()) {
                $this->initialbars($grandtotal > $pagesize);
            }

            list($wsql, $wparams) = $this->get_sql_where();
            if ($wsql) {
                $this->countsql .= ' AND '.$wsql;
                $this->countparams = array_merge($this->countparams, $wparams);

                $this->sql->where .= ' AND '.$wsql;
                $this->sql->params = array_merge($this->sql->params, $wparams);

                $total  = $DB->count_records_sql($this->countsql, $this->countparams);
            } else {
                $total = $grandtotal;
            }

            $this->pagesize($pagesize, $total);
        }

        // Fetch the attempts
        $sort = $this->get_sql_sort();
        if ($sort) {
            $sort = "ORDER BY $sort";
		}
		
		/**
		 * MODIFICADO del original para añadir GROUP BY
		 */
        $sql = "SELECT
                {$this->sql->fields}
                FROM {$this->sql->from}
                WHERE {$this->sql->where}
				GROUP BY {$this->sql->groupBy}
				{$sort}";

        if (!$this->is_downloading()) {
            $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
        } else {
            $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
        }
    }
}

Este bloque es el que utilizaremos para renderizar nuestro HTML:

<?php

/**
 * Contiene la clase para la gestión de Alumnos
 */
require_once('./lib/GestionAlumnos.php');

$title = "Gestión de Alumnos";

$download = optional_param('download', '', PARAM_ALPHA);
$baseUrl = $CFG->wwwroot."/gestion_alumnos.php";
$gestAlumnos = new GestionAlumnos($DB,$baseUrl);
$table = $gestAlumnos->getListAlumnosHTML();

// Si no se está exportando, mostramos el HTML
if (!$table->is_downloading()) {

    $PAGE->set_title($title);
    $PAGE->set_heading($title);
    $PAGE->set_cacheable(false);
    $PAGE->navbar->ignore_active();
    $PAGE->set_url('/gestion_alumnos.php');

    $PAGE->navbar->add($title, new moodle_url(substr($PAGE->url, 0, strpos($PAGE->url, '?'))));
    $PAGE->set_pagelayout('frametop');

    echo $OUTPUT->header();
    echo '<link rel="stylesheet" type="text/css" href="https://code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css">';

?>

<style>
    #tabs{
        min-height: 1150px;height:100%;margin-top:10px
    }
</style>

<h2><?= $title ?></h2>

<div id="tabs">
    <ul>
        <li><a href="#listado">Listado Alumnos</a></li>
	</ul>
	<div id="listado">
		<?php
			$table->out(15, true); 
		?>
    </div>
</div>

<script src="https://code.jquery.com/jquery-1.12.4.js"></script>
<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.js"></script>
<script>
$(function() {
    $("#tabs").tabs();
});
</script>

<?php
    echo $OUTPUT->footer();
}else{
    $table->out(15, true); 
}

?>

RECURSOS

  • Moodle Docs: https://docs.moodle.org/dev/lib/tablelib.php
  • Moodle Forums (Entrar como Invitado): https://moodle.org/mod/forum/discuss.php?d=335786

Fatal error: Call to undefined function money_format()

Si estamos trabajando con WAMP o XAMPP puede que nos topemos con este error.

( ! ) Fatal error: Call to undefined function money_format()

Según la documentación de PHP La función money_format() sólo está definida si el sistema tiene capacidad strfmon. Por ejemplo, Windows no lo hace, así que money_format() no está definido en Windows.

Para solventarlo crearemos un archivo que adjuntaremos en nuestro php.ini

Abre el php.ini y busca la línea con la palabra «auto_prepend_file» y sustituye el valor vacío con

auto_prepend_file = "C:\wamp64\money_format.php"

Ahora crea el archivo en la misma ruta con la siguiente función de PHP

<?php

function money_format($formato, $valor)
{
    if (setlocale(LC_MONETARY, 0) == 'C') {
        return number_format($valor, 2);
    }

    $locale = localeconv();

    $regex = '/^' . // Inicio da Expressao
        '%' . // Caractere %
        '(?:' . // Inicio das Flags opcionais
        '\=([\w\040])' . // Flag =f
        '|' .
        '([\^])' . // Flag ^
        '|' .
        '(\+|\()' . // Flag + ou (
        '|' .
        '(!)' . // Flag !
        '|' .
        '(-)' . // Flag -
        ')*' . // Fim das flags opcionais
        '(?:([\d]+)?)' . // W Largura de campos
        '(?:#([\d]+))?' . // #n Precisao esquerda
        '(?:\.([\d]+))?' . // .p Precisao direita
        '([in%])' . // Caractere de conversao
        '$/'; // Fim da Expressao

    if (!preg_match($regex, $formato, $matches)) {
        trigger_error('Formato invalido: ' . $formato, E_USER_WARNING);
        return $valor;
    }

    $opcoes = array(
        'preenchimento' => ($matches[1] !== '') ? $matches[1] : ' ',
        'nao_agrupar' => ($matches[2] == '^'),
        'usar_sinal' => ($matches[3] == '+'),
        'usar_parenteses' => ($matches[3] == '('),
        'ignorar_simbolo' => ($matches[4] == '!'),
        'alinhamento_esq' => ($matches[5] == '-'),
        'largura_campo' => ($matches[6] !== '') ? (int) $matches[6] : 0,
        'precisao_esq' => ($matches[7] !== '') ? (int) $matches[7] : false,
        'precisao_dir' => ($matches[8] !== '') ? (int) $matches[8] : $locale['int_frac_digits'],
        'conversao' => $matches[9]
    );

    if ($opcoes['usar_sinal'] && $locale['n_sign_posn'] == 0) {
        $locale['n_sign_posn'] = 1;
    } elseif ($opcoes['usar_parenteses']) {
        $locale['n_sign_posn'] = 0;
    }
    if ($opcoes['precisao_dir']) {
        $locale['frac_digits'] = $opcoes['precisao_dir'];
    }
    if ($opcoes['nao_agrupar']) {
        $locale['mon_thousands_sep'] = '';
    }

    $tipo_sinal = $valor >= 0 ? 'p' : 'n';
    if ($opcoes['ignorar_simbolo']) {
        $simbolo = '';
    } else {
        $simbolo = $opcoes['conversao'] == 'n' ? $locale['currency_symbol']
            : $locale['int_curr_symbol'];
    }
    $numero = number_format(
        abs($valor),
        $locale['frac_digits'],
        $locale['mon_decimal_point'],
        $locale['mon_thousands_sep']
    );


    $sinal = $valor >= 0 ? $locale['positive_sign'] : $locale['negative_sign'];
    $simbolo_antes = $locale[$tipo_sinal . '_cs_precedes'];

    $espaco1 = $locale[$tipo_sinal . '_sep_by_space'] == 1 ? ' ' : '';

    $espaco2 = $locale[$tipo_sinal . '_sep_by_space'] == 2 ? ' ' : '';

    $formatado = '';
    switch ($locale[$tipo_sinal . '_sign_posn']) {
        case 0:
            if ($simbolo_antes) {
                $formatado = '(' . $simbolo . $espaco1 . $numero . ')';
            } else {
                $formatado = '(' . $numero . $espaco1 . $simbolo . ')';
            }
            break;
        case 1:
            if ($simbolo_antes) {
                $formatado = $sinal . $espaco2 . $simbolo . $espaco1 . $numero;
            } else {
                $formatado = $sinal . $numero . $espaco1 . $simbolo;
            }
            break;
        case 2:
            if ($simbolo_antes) {
                $formatado = $simbolo . $espaco1 . $numero . $sinal;
            } else {
                $formatado = $numero . $espaco1 . $simbolo . $espaco2 . $sinal;
            }
            break;
        case 3:
            if ($simbolo_antes) {
                $formatado = $sinal . $espaco2 . $simbolo . $espaco1 . $numero;
            } else {
                $formatado = $numero . $espaco1 . $sinal . $espaco2 . $simbolo;
            }
            break;
        case 4:
            if ($simbolo_antes) {
                $formatado = $simbolo . $espaco2 . $sinal . $espaco1 . $numero;
            } else {
                $formatado = $numero . $espaco1 . $simbolo . $espaco2 . $sinal;
            }
            break;
    }

    if ($opcoes['largura_campo'] > 0 && strlen($formatado) < $opcoes['largura_campo']) {
        $alinhamento = $opcoes['alinhamento_esq'] ? STR_PAD_RIGHT : STR_PAD_LEFT;
        $formatado = str_pad(
            $formatado,
            $opcoes['largura_campo'],
            $opcoes['preenchimento'],
            $alinhamento
        );
    }
    return $formatado;
}

Maximum execution time of 360 seconds exceeded wamp

A veces al desarrollar en nuestro ordenador local con WAMP, queremos subir un archivo de SQL demasiado extenso vía phpMyAdmin. Este puede generar un error de «Max Execution Time Exceeded».

Para evitar este error modificaremos unas lineas del Alias de PphMyAdmin «C:\wamp64\alias\phpmyadmin.conf»:

Alias /phpmyadmin "c:/wamp64/apps/phpmyadmin4.8.4/"

<Directory "c:/wamp64/apps/phpmyadmin4.8.4/">
   Options +Indexes +FollowSymLinks +MultiViews
   AllowOverride all
  <IfDefine APACHE24>
    Require local
  </IfDefine>
  <IfDefine !APACHE24>
      Order Deny,Allow
      Deny from all
      Allow from localhost ::1 127.0.0.1
  </IfDefine>
  # To import big file you can increase values
  #php_admin_value upload_max_filesize 128M
  #php_admin_value post_max_size 128M
  #php_admin_value max_execution_time 360
  #php_admin_value max_input_time 360
  php_admin_value upload_max_filesize 1024M
  php_admin_value post_max_size 1024M
  php_admin_value max_execution_time 1800
  php_admin_value max_input_time 1800
</Directory>

Descargar PDF base64 con Symfony

Para hacer la recuperación de un archivo, en este caso un PDF, que está almacenado en nuestra base de datos como un BLOB para luego realizar el return añadiendo las cabeceras necesarias para realizar la acción de «Descargar» cuando llamemos a esta URL.

En este ejemplo sencillo, recuperamos el PDF utilizando una función ficticia en la que supuestamente recuperamos los datos del PDF en bruto (raw) y codificado en base64.

El segundo paso es decodificar ese raw utilizando la función base64_decode().

El último paso es crear la respuesta con los métodos que nos da la clase Response. A esta respuesta le vamos a añadir las cabeceras necesarias para poder decirle al navegador que es lo que tiene que hacer con este archivo.

En este caso lo que queremos es descargarlo. Por lo que añadiremos las cabeceras Content-Description y Content-Disposition:

$response->headers->set(‘Content-Description’, ‘File Transfer’);

$response->headers->set(‘Content-Disposition’, ‘attachment; filename=»Archivo.pdf»‘);
Con esto, al realizar una consulta a la ruta creada directamente nos descargará el PDF.
¡Importante! Si vas a realizar la consulta con un formulario, no te olvides de colocar el atributo enctype en tu etiqueta FORM.
<form id="pruebaPDF" method="post" enctype="multipart/form-data">
<?php
namespace App\Controller;
use Symfony\Component\HttpFoundation\Response;
    /**
    * @Route("/show-pdf", name="show_pdf")
    */
    public function getPDFDocument()
    {
        $result = getPdfFromRaw();
        $pdf = base64_decode($result->PDF);
        $response = new Response($pdf);
        $response->headers->set('Content-Type', 'application/octet-stream');
        $response->headers->set('Content-Description', 'File Transfer');
        $response->headers->set('Content-Disposition', 'attachment; filename="Archivo.pdf"');
        // $response->headers->set('Expires', '0');
        // $response->headers->set('Content-Transfer-Encoding', 'binary');
        $response->headers->set('Content-length', strlen($pdf));
        $response->headers->set('Cache-Control', 'no-cache private');
        // $response->headers->set('Pragma', 'public');
        // Send headers before outputting anything
        $response->sendHeaders();
        return $response;
    }