`, `| `, ` | ` (colspan/rowspan basic support)
- **Line breaks and rules**: `
`, `
`
Special utility tags handled by the parser:
- **``**: splits the document into sections. Orientation can be `landscape`, `portrait`, `L`, or `P`.
- **``**: renders dynamic page numbers. Supported variables: `{PAGE}`, `{NUMPAGES}`, `{SECTIONPAGES}`.
- **`...`**: content rendered in the section header.
- **`...`**: content rendered in the section footer.
## Advanced Usage
### Getting Document Content
```php
// Get raw content as string (useful for storage or email attachments)
$content = WordForLaravel::load('word.report', $data)
->getContent();
// Store in database or send via email
Mail::send('emails.report', [], function ($message) use ($content) {
$message->attachData($content, 'report.docx', [
'mime' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
]);
});
```
### Accessing PHPWord Instance
For advanced customization, access the underlying PHPWord object:
```php
WordForLaravel::load('word.custom', $data);
$phpWord = WordForLaravel::getPhpWord();
// Add custom section
$section = $phpWord->addSection();
$section->addText('Custom content added directly via PHPWord');
// Download the customized document
return WordForLaravel::download('custom.docx');
```
### Resetting the Converter
When generating multiple documents in the same request:
```php
// First document
WordForLaravel::load('document1', $data1)
->save('doc1.docx');
// Reset for new document
WordForLaravel::reset();
// Second document
WordForLaravel::load('document2', $data2)
->save('doc2.docx');
```
## Configuration
The configuration file (`config/word-for-laravel.php`) allows you to customize:
```php
return [
// Default disk for saving documents
'default_disk' => env('BLADE_TO_WORD_DISK', 'local'),
// Temporary directory for document generation
'temp_dir' => env('BLADE_TO_WORD_TEMP_DIR', sys_get_temp_dir()),
// Default orientation for sections that don't specify one
'default_orientation' => env('WORD_DEFAULT_ORIENTATION', 'portrait'),
// Default section styling (margins in twips: 1000 ≈ 1.76cm)
'section_style' => [
'marginTop' => 1000,
'marginBottom' => 1000,
'marginLeft' => 1000,
'marginRight' => 1000,
'headerHeight' => 720,
'footerHeight' => 720,
],
// Default document properties
'default_properties' => [
'creator' => env('APP_NAME', 'Laravel'),
'company' => env('APP_NAME', 'Laravel'),
],
];
```
### Orientation
Set default page orientation for sections that do not specify one via ``:
```php
WordForLaravel::orientation('landscape')
->load('word.report', $data)
->download('report.docx');
```
You can also control orientation per section using `` in your Blade HTML.
## Testing
Run the tests with:
```bash
composer test
```
Run tests with coverage:
```bash
composer test-coverage
```
## Examples
### Invoice Example
```php
// Controller
public function generateInvoice(Invoice $invoice)
{
return WordForLaravel::load('word.invoice', [
'invoice' => $invoice,
'company' => [
'name' => 'ACME Corp',
'address' => '123 Business St',
'city' => 'Paris',
],
'items' => $invoice->items->map(fn($item) => [
'description' => $item->description,
'quantity' => $item->quantity,
'price' => $item->price,
'total' => $item->quantity * $item->price,
]),
'total' => $invoice->total,
])
->setProperties([
'title' => "Invoice {$invoice->number}",
'subject' => 'Sales Invoice',
])
->download("invoice-{$invoice->number}.docx");
}
```
### Report with Tables
```blade
Sales Report - {{ $period }}
Summary
Total Sales: {{ number_format($totalSales, 2) }} €
Total Orders: {{ $totalOrders }}
Top Products
| Product |
Units Sold |
Revenue |
@foreach($topProducts as $product)
| {{ $product['name'] }} |
{{ $product['units'] }} |
{{ number_format($product['revenue'], 2) }} € |
@endforeach
```
### CSS Support
The converter supports a useful subset of CSS on tags, classes, and inline styles. Examples:
- **Font**: `font-size`, `color`, `font-family`, `font-weight`, `font-style`, `text-decoration`, `background-color`, `text-transform`
- **Paragraph**: `text-align`, `line-height`, `margin-left` (indent), `margin-top`/`margin-bottom` (spacing), `text-indent`
- **Tables/Cells**: `border-color`, `border-width`, `vertical-align`, `width`, `background-color`
- **Images**: `width`, `height`, `text-align`, `float`, margins
Units supported include `px`, `pt`, `cm`, `mm`, `in`. Colors support hex (`#RRGGBB`), `rgb(...)`, and named colors.
### Images
Images can be referenced by:
- **Local path** (absolute or relative)
- **Remote URL** (downloaded at runtime)
- **Data URI** (`data:image/png;base64,...`)
Alignment and sizing can be controlled via CSS or HTML attributes (`width`, `height`).
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security-related issues, please email inanakomlan@gmail.com instead of using the issue tracker.
## Credits
- [Anani Komlan Mawulom H](https://github.com/ananikomlanMH)
- [PHPWord](https://github.com/PHPOffice/PHPWord)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
