addBreak

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addBreak

TRIAL / ADVANCED / PREMIUM

Inserts a line, column or page break into the Word document.

Description

public addBreak ( array $options )

This method allows the insertion of a break into the document.

line: inserts a standard line break.
column: inserts a column break, i.e. the text restarts to be rendered in the next column if the section has more than one column.
page: the contents continue in the next available page.

You may also include a line or column break in the middle of a paragraph via the addText method.

Parameters

options

The possible keys and values are (required options are shown with yellow background):

Key	Type	Description
type	string	The possible values are: 'line', 'column' and 'page'.
number	int	The number of breaks to include.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$text = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
    'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut ' .
    'enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut' .
    'aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit ' .
    'in voluptate velit esse cillum dolore eu fugiat nulla pariatur.';

$docx->addText($text);
$docx->addText($text);

$docx->addBreak(array('type' => 'line'));

$docx->addText($text);

$docx->addBreak(array('type' => 'line', 'number' => 2));

$docx->addText($text);

$docx->addBreak(array('type' => 'page'));

$docx->addText($text);

$docx->createDocx('output');

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$text_1 = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.';

$text_2 = 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut' .
'aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit ' .
'in voluptate velit esse cillum dolore eu fugiat nulla pariatur.';

$break = new WordFragment($docx);
$break->addBreak();

$runs = array();
$runs[] = array('text' => $text_1);
$runs[] = $break;
$runs[] = array('text' => $text_2);

$docx->addText($runs);

$docx->createDocx('output');

The resulting Word document looks like: