En este post vamos a seguir trabajando con documentos de Word a través de PHP con la librería PHPWord.

Hoy vamos a ver cómo trabajar con listas, tablas e imágenes (locales o de internet).

Recuerda leer la primera parte para ver cómo instalar la librería y cómo agregar cosas básicas.

Listas

Para agregar un elemento de una lista primeramente se debe crear una sección, y después llamar a addListItem con el texto y, opcionalmente, como segundo argumento, la profundidad.

La profundidad de una lista es el número de tabulaciones que tiene. Veamos el siguiente ejemplo:

Como tercer argumento se acepta una fuente en forma de arreglo, y como cuarto argumento un arreglo indicando el estilo de la lista, dentro del cual podemos especificar, por ejemplo, el tipo de “decorador” de la lista.

<?php
/**
 * Trabajar con documentos de Word y PHP usando PHPOffice
 *
 * Más tutoriales en: parzibyte.me/blog
 *
 * Ejemplo 4:
 * Listas
 */require_once "vendor/autoload.php";
use PhpOffice\PhpWord\Style\Language;
use PhpOffice\PhpWord\Style\ListItem;
$documento = new \PhpOffice\PhpWord\PhpWord();
$propiedades = $documento->getDocInfo();
$propiedades->setCreator("Luis Cabrera Benito");
$propiedades->setTitle("Listas");

$seccion = $documento->addSection();
$seccion->addListItem("Elemento con profundidad por defecto");
$seccion->addListItem("Elemento con profundidad 1", 1);
$seccion->addListItem("Elemento con profundidad 1", 1);
$seccion->addListItem("Elemento con profundidad 2", 2);
$seccion->addListItem("Elemento con profundidad 2", 2);
$seccion->addListItem("Elemento con profundidad 3", 3);
$seccion->addListItem("Elemento con profundidad 3", 3);
$fuente = [
    "name" => "Courier new",
    "size" => 20,
    "color" => "000000",
    "italic" => true,
];
$seccion->addListItem("Elemento con profundidad 1 y con fuente", 1, $fuente);
for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_SQUARE_FILLED", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_SQUARE_FILLED,
    ]);
}

for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_BULLET_FILLED", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_BULLET_FILLED,
    ]);
}

for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_BULLET_EMPTY", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_BULLET_EMPTY,
    ]);
}

for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_NUMBER", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_NUMBER,
    ]);
}

for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_NUMBER_NESTED", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_NUMBER_NESTED,
    ]);
}

for ($profundidad = 1; $profundidad < 4; $profundidad++) {
    $seccion->addListItem("Elemento con profundidad $profundidad, con fuente y tipo de lista TYPE_ALPHANUM", $profundidad, $fuente, [
        'listType' => ListItem::TYPE_ALPHANUM,
    ]);
}

# Para que no diga que se abre en modo de compatibilidad
$documento->getCompatibility()->setOoxmlVersion(15);
# Idioma español de México
$documento->getSettings()->setThemeFontLang(new Language("ES-MX"));

# Guardarlo
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($documento, "Word2007");

$objWriter->save("4-listas.docx");

Los decoradores o indicadores de la lista son esos puntos que van a la izquierda. Están definidos en PhpOffice\PhpWord\Style\ListItem con unas constantes.

El documento generado se puede ver aquí, dentro del código se generaron muchas listas con múltiples tipos.

Tablas con PHPWord

Las tablas se agregan a una sección con addTable; antes de ello se pueden registrar estilos de tablas (con addTableStyle($nombreDeEstilo, $estiloComoArreglo)) para usarlos más tarde al llamar a addTable($nombreDeEstilo)

Para agregar una fila se llama al método addRow de la tabla, y para agregar una celda a esa fila se llama al método addCell de la tabla, igualmente.

El método addCell devuelve una celda a la que le podemos adjuntar todo tipo de contenido, por ejemplo, texto, con addText.

<?php
/**
 * Trabajar con documentos de Word y PHP usando PHPOffice
 *
 * Más tutoriales en: parzibyte.me/blog
 *
 * Ejemplo 5:
 * Tablas
 * Nota: se utiliza la notación corta de arreglos [], que se pueden remplazar por array(),
 * más información en https://parzibyte.me/blog/2018/10/11/sintaxis-corta-array-php/
 */require_once "vendor/autoload.php";
use PhpOffice\PhpWord\SimpleType\Jc;
use PhpOffice\PhpWord\Style\Language;

$documento = new \PhpOffice\PhpWord\PhpWord();
$propiedades = $documento->getDocInfo();
$propiedades->setCreator("Luis Cabrera Benito");
$propiedades->setTitle("Tablas");

# Agregar texto...
/*
Todos los textos deben estar dentro de una sección
 */
$seccion = $documento->addSection();
$estiloTabla = [
    "borderColor" => "8bc34a",
    "alignment" => Jc::CENTER,
    "borderSize" => 5,
];
// Guardarlo para usarlo más tarde
$documento->addTableStyle("estilo1", $estiloTabla);

$tabla = $seccion->addTable("estilo1"); # Agregar tabla con el estilo que guardamos antes
$tabla->addRow(); # Agregar fila
$celda = $tabla->addCell(); # Agregar celda
$celda->addText("Dentro de una celda");
$celda = $tabla->addCell(); # Agregar celda
$celda->addText("Dentro de una celda");

# Un separador
$seccion->addText("Aquí otra tabla:");

# Otra tabla
$estiloTabla = [
    "borderColor" => "000000",
    "alignment" => Jc::LEFT,
    "borderSize" => 10,
    "cellMargin" => 10,
];
// Guardarlo para usarlo más tarde
$documento->addTableStyle("estilo2", $estiloTabla);
$tabla = $seccion->addTable("estilo2");
for ($fila = 0; $fila < 5; $fila++) {
    $tabla->addRow();
    for ($numeroCelda = 0; $numeroCelda < 5; $numeroCelda++) {
        $celda = $tabla->addCell();
        $celda->addText(sprintf("Posición %d x %d", $fila, $numeroCelda));
    }
}

# Otra tabla
$estiloTabla = [
    "borderColor" => "000000",
    "alignment" => Jc::RIGHT,
    "borderSize" => 30,
    "cellMargin" => 80,
];
// Guardarlo para usarlo más tarde
$documento->addTableStyle("estilo3", $estiloTabla);
$tabla = $seccion->addTable("estilo3");
$mascotas = [
    [
        "nombre" => "Maggie",
        "edad" => 3,
    ],
    [
        "nombre" => "Panqué",
        "edad" => 1,
    ],
    [
        "nombre" => "Guayaba",
        "edad" => 2,
    ],
];
# Encabezados
$fuente = [
    "name" => "Arial",
    "size" => 12,
    "color" => "000000",
];
$tabla->addRow();
$tabla->addCell()->addText("Nombre", $fuente);
$tabla->addCell()->addText("Edad", $fuente);

foreach ($mascotas as $mascota) {
    $tabla->addRow();
    $tabla->addCell()->addText($mascota["nombre"]);
    $tabla->addCell()->addText($mascota["edad"]);
}

# Para que no diga que se abre en modo de compatibilidad
$documento->getCompatibility()->setOoxmlVersion(15);
# Idioma español de México
$documento->getSettings()->setThemeFontLang(new Language("ES-MX"));

# Guardarlo
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($documento, "Word2007");

$objWriter->save("5-tablas.docx");

En el código se crean 3 tablas con distintos estilos, la primera se renderiza manualmente y se centra, la segunda con un ciclo y la tercera con un arreglo.

Puedes ver el documento aquí, el cual se ve así:

Los estilos (márgenes, colores, etcétera) se personalizan en el código.

Colocar imágenes dentro del documento de Word

Para agregar una imagen a un documento se debe crear una sección y a la sección agregarle la imagen con el método addImage que recibe dos argumentos: la ruta de la imagen y opcionalmente un arreglo con los estilos de la imagen.

La ruta de la imagen puede ser una URL de internet, solo hay que tener cuidado con no pasar esta URL desde la entrada del usuario por esas cosas de la seguridad. También puede ser la ruta de una imagen local.

El arreglo de los estilos es para personalizar algunas cosas como la altura y la anchura de la imagen.

<?php
/**
 * Trabajar con documentos de Word y PHP usando PHPOffice
 *
 * Más tutoriales en: parzibyte.me/blog
 *
 * Ejemplo 6:
 * Agregar imágenes
 * Nota: se utiliza la notación corta de arreglos [], que se pueden remplazar por array(),
 * más información en https://parzibyte.me/blog/2018/10/11/sintaxis-corta-array-php/
 */require_once "vendor/autoload.php";
use PhpOffice\PhpWord\Style\Language;
$documento = new \PhpOffice\PhpWord\PhpWord();
$propiedades = $documento->getDocInfo();
$propiedades->setCreator("Luis Cabrera Benito");
$propiedades->setTitle("Imágenes");

$seccion = $documento->addSection();
# Títulos. Solo modificando depth (el número)
$fuenteTitulo = [
    "name" => "Verdana",
    "size" => 20,
    "color" => "000000",
];
$documento->addTitleStyle(1, $fuenteTitulo);
$seccion->addTitle("Gopher", 1);
$seccion->addImage("gopher-2661632_640.jpg", [
    "width" => 100,
]);
$seccion->addText("Los geómidos son una familia de roedores castorimorfos conocidos vulgarmente como tuzas, taltuzas o ratas de abazones. Se encuentran en Canadá, Estados Unidos, México, América Central y Colombia. En México habitan seis especies que se encuentran en peligro de extinción. ");

$seccion->addTitle("Conejo", 1);
$seccion->addImage("conejo.jpg", [
    "width" => 320,
    "height" => 213,
]);
$seccion->addText("El conejo común o conejo europeo es una especie de mamífero lagomorfo de la familia Leporidae, y el único miembro actual del género Oryctolagus. Está incluido en la lista 100 de las especies exóticas invasoras más dañinas del mundo​ de la Unión Internacional para la Conservación de la Naturaleza.");

$seccion->addTitle("Imagen aleatoria de internet", 1);
$seccion->addImage("https://picsum.photos/200/300", [
    "width" => 200,
    "height" => 300,
]);
$seccion->addText("Lo de arriba es una imagen de internet");

# Para que no diga que se abre en modo de compatibilidad
$documento->getCompatibility()->setOoxmlVersion(15);
# Idioma español de México
$documento->getSettings()->setThemeFontLang(new Language("ES-MX"));

# Guardarlo
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($documento, "Word2007");

$objWriter->save("6-imagenes.docx");

Dentro del código agregamos encabezados, texto e imágenes para que al final resulte en algo así:

La tercer imagen es traída de internet desde la ruta https://picsum.photos/200/300.

Puedes ver el documento aquí. Las imágenes están en la misma ruta que el script de PHP, y puedes ver todo el contenido en el repositorio de GitHub.

Conclusión

Esta es la parte 2 de 3 del tutorial con PHPWord. Hemos visto cómo trabajar con listas, tablas e imágenes.

En la siguiente parte vamos a ver cómo poner marcas de agua, tablas de contenido (o índices, así les llamo yo) y gráficas de barras.

Recuerda que la parte 1 del tutorial está aquí, y que la documentación oficial está en este enlace.

Actualización: aquí está la parte 3.