phpdoc modulos phpspreadsheet

\modulos\phpspreadsheet

Módulo concreto phpspreadsheet. Implementa PhpOffice/PhpSpreadsheet versión 1.15.0.
Nota: Todos los índices se trabajan en base 1.

Extiende: \modulo

Propiedades

xls (protegido)

Tipo: \PhpOffice\PhpSpreadsheet\Spreadsheet
Instancia de Spreadsheet.

Métodos

crear()

Crea un nuevo libro.
Devuelve: \modulos\phpspreadsheet

obtenerInstancia()

Devuelve la instancia de Spreadsheet.
Devuelve: \PhpOffice\PhpSpreadsheet\Spreadsheet

obtenerHoja()

Devuelve la instancia de la hoja actual.
Devuelve: \PhpOffice\PhpSpreadsheet\Worksheet

abrir($ruta)

Abre un libro.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$ruta	string	Ruta local.

Devuelve: \modulos\phpspreadsheet

obtenerHojas()

Devuelve el listado de hojas del libro.
Devuelve: array

establecerHoja($hoja)

Establece la hoja activa.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$hoja	string	Nombre de la hoja.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: establecerHoja($hoja)

Establece la hoja activa.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$hoja	int	Número de hoja, comenzando desde 0.

Devuelve: \modulos\phpspreadsheet

obtenerArray()

Devuelve el contenido de la hoja completa, como array.
Devuelve: array

escribirFila($numero,$datos[,$columna])

Escribe una fila, tomando cada elemento de un array como una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$numero	int	Número de fila, comenzando desde 1.
$datos	array	Datos a escribir.
$columna	string	Columna inicial.	Si	'A'

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: escribirFila($numero,$datos[,$columna])

Escribe una fila, tomando cada elemento de un array como una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$numero	int	Número de fila, comenzando desde 1.
$datos	array	Datos a escribir.
$columna	int	Índice de la columna inicial, comenzando desde 1.	Si	'A'

Devuelve: \modulos\phpspreadsheet

leerFila($numero)

Lee una fila y devuelve el contenido de sus celdas como un array.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$numero	int	Número de fila, comenzando desde 1.

Devuelve: array

obtenerDimensionesHoja()

Devuelve un objeto [fila,columna] con los índices (base 1) de la última celda de la hoja.
Devuelve: object

escribirCelda($a,$b[,$c])

Escribe una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$a	string	Coordenada.
$b	string	Valor.
$c	string	No aplica.	Si	null

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: escribirCelda($a,$b[,$c])

Escribe una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$a	string	Número de columna, comenzando desde 1.
$b	string	Número de fila, comenzando desde 1.
$c	string	Valor	Si	null

Devuelve: \modulos\phpspreadsheet

leerCelda($a[,$b])

Lee una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$a	string	Coordenada.
$b	null	No aplica.	Si	null

Devuelve: string

Sobrecarga 2: leerCelda($a[,$b])

Lee una celda.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$a	int	Índice de la columna, comenzando desde 1.
$b	int	Índice de la fila, comenzando desde 1.	Si	null

Devuelve: string

combinar($rango)

Combina un rango de celdas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango como coordenadas Excel.

Devuelve: \modulos\phpspreadsheet

negrita($rango[,$desactivar])

Aplica formato negritaa un rango de celdas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango como coordenadas Excel.
$desactivar	bool	Especificar true para desactivar la negrita.	Si	false

Devuelve: \modulos\phpspreadsheet

color($rango,$color)

Aplica un color de texto a un rango de celdas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango como coordenadas Excel.
$color	string	Color en RGB hexagesimal.

Devuelve: \modulos\phpspreadsheet

fondo($rango,$color)

Aplica un color de fondo a un rango de celdas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango como coordenadas Excel.
$color	string	Color en RGB hexagesimal.

Devuelve: \modulos\phpspreadsheet

ajustarTamano($rango)

Ajusta el tamaño de las columnas al contenido.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Nombre de la columna o rango de columnas como coordenadas Excel (ejemplo: A:Z).

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: ajustarTamano($rango)

Ajusta el tamaño de las columnas al contenido.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Número de columna, comenzando desde 1.

Devuelve: \modulos\phpspreadsheet

anchoColumna($columna,$ancho)

Establece el ancho de la columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Nombre de la columna o rango de columnas como coordenadas Excel (ejemplo: A:Z).
$ancho	int	Ancho a establecer.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: anchoColumna($columna,$ancho)

Establece el ancho de la columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Número de columna, comenzando desde 1.
$ancho	int	Ancho a establecer.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 3: anchoColumna($columna,$ancho)

Establece el ancho de la columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Nombre de la columna inicial.
$ancho	array	Lista de tamaños a establecer desde la columna inicial hacia la derecha.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 4: anchoColumna($columna,$ancho)

Establece el ancho de la columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Número de columna inicial, comenzando desde 1.
$ancho	array	Lista de tamaños a establecer desde la columna inicial hacia la derecha.

Devuelve: \modulos\phpspreadsheet

congelarFilas($numero)

Congela las filas hasta la fila especificada inclusive.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$numero	int	Número de fila a congelar, comenzando desde 1.

Devuelve: \modulos\phpspreadsheet

congelarColumnas($columna)

Congela las columnas hasta la columna especificada inclusive.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Nombre de la columna.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: congelarColumnas($columna)

Congela las columnas hasta la columna especificada inclusive.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	int	Número de la columna, comenzando desde 1.

Devuelve: \modulos\phpspreadsheet

congelarFilasColumnas($fila,$columna)

Congela las filas y columnas hasta la coordenada especificada inclusive.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$fila	int	Número de fila, comenzando desde 1.
$columna	string	Nombre de la columna.

Devuelve: \modulos\phpspreadsheet

Sobrecarga 2: congelarFilasColumnas($fila,$columna)

Congela las filas y columnas hasta la coordenada especificada inclusive.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$fila	int	Número de fila, comenzando desde 1.
$columna	int	Número de fila, comenzando desde 1.

Devuelve: \modulos\phpspreadsheet

aplicarFormato($rango,$formato)

Aplica el formato al rango de celdas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango como coordenadas Excel.
$formato	array	Array de formato. Ver: https://phpspreadsheet.readthedocs.io/en/latest/topics/recipes/#styles

Devuelve: \modulos\phpspreadsheet

guardarXlsx($ruta)

Guarda el libro actual en formato xlsx.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$ruta	string	Ruta local.

Devuelve: \modulos\phpspreadsheet

obtenerCoordenada($columna,$fila)

Devuelve la coordenada de la celda dado sus números de fila y columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	int	Índice de la columna, comenzando desde 1.
$fila	int	Índice de la fila, comenzando desde 1.

Devuelve: string

obtenerColumna($columna)

Devuelve el nombre de la columna dado su índice.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	int	Índice de la columna, comenzando desde 1.

Devuelve: string

obtenerIndice($columna)

Devuelve el índice de una columna, en base 1, dado su nombre.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$columna	string	Columna.

Devuelve: int

obtenerRango($rango)

Dado un rango, devuelve un array de índices de columna.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$rango	string	Rango a procesar. Puede ser un índice de columna (comenzando desde 1), una letra o un rango con formato A:Z.

Devuelve: array