Skip to content

Add support for style objects to the element constructor #2362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

Add support for style objects to the element constructor #2362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bdcb83f
Add support for style objects to the element constructor
hazington Dec 30, 2022
0a27c11
Remove empty line between if clauses
hazington Dec 30, 2022
3c15be1
Pull latest master commits
Jan 8, 2023
e6d6de8
Added unit tests to cover the style object support in the element con…
Jan 8, 2023
503b13a
Added type hints and replaced the class attribute parentContainer by …
Jan 8, 2023
0e0e0ad
Updated documentation to explain that array or style objects can be u…
Jan 8, 2023
b55e99e
Removed default value settings and preferred the new assertMatchesReg…
Jan 8, 2023
c1ec1ec
Replaced false assertEquals usage by assertSame. Added unit tests to …
Jan 8, 2023
5070f70
Added information that objects also support class names
hazington Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/elements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ italics, etc) or other elements, e.g. images or links. The syntaxes are as follo
$textrun = $section->addTextRun([$paragraphStyle]);

- ``$text``. Text to be displayed in the document.
- ``$fontStyle``. See :ref:`font-style`.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$fontStyle``. Array or Font style object. See :ref:`font-style`.
- ``$paragraphStyle``. Array or Paragraph style object. See :ref:`paragraph-style`.

For available styling options see :ref:`font-style` and :ref:`paragraph-style`.

Expand All @@ -97,8 +97,8 @@ If `depth` is 0, a Title will be inserted, otherwise a Heading1, Heading2, ...
$section->addTitle($text, [$depth]);

- ``depth``.
- ``$fontStyle``. See :ref:`font-style`.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$fontStyle``. Array or Font style object. See :ref:`font-style`.
- ``$paragraphStyle``. Array or Paragraph style object. See :ref:`paragraph-style`.
- ``$text``. Text to be displayed in the document. This can be `string` or a `\PhpOffice\PhpWord\Element\TextRun`

It's necessary to add a title style to your document because otherwise the title won't be detected as a real title.
Expand All @@ -114,8 +114,8 @@ You can add Hyperlinks to the document by using the function addLink:

- ``$linkSrc``. The URL of the link.
- ``$linkName``. Placeholder of the URL that appears in the document.
- ``$fontStyle``. See :ref:`font-style`.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$fontStyle``. Classname, Array or Font style object. See :ref:`font-style`.
- ``$paragraphStyle``. Classname, Array or Paragraph style object. See :ref:`paragraph-style`.

Preserve texts
~~~~~~~~~~~~~~
Expand All @@ -139,8 +139,8 @@ Text breaks are empty new lines. To add text breaks, use the following syntax. A
$section->addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]);

- ``$breakCount``. How many lines.
- ``$fontStyle``. See :ref:`font-style`.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$fontStyle``. Classname, Array or Font style object. See :ref:`font-style`.
- ``$paragraphStyle``. Classname, Array or Paragraph style object. See :ref:`paragraph-style`.

Page breaks
~~~~~~~~~~~
Expand Down Expand Up @@ -172,10 +172,10 @@ Parameters:

- ``$text``. Text that appears in the document.
- ``$depth``. Depth of list item.
- ``$fontStyle``. See :ref:`font-style`.
- ``$fontStyle``. Classname, Array or Font style object. See :ref:`font-style`.
- ``$listStyle``. List style of the current element TYPE\_NUMBER,
TYPE\_ALPHANUM, TYPE\_BULLET\_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$paragraphStyle``. Classname, Array or style Paragraph object. See :ref:`paragraph-style`.

See ``Sample_09_Tables.php`` for more code sample.

Expand Down Expand Up @@ -250,7 +250,7 @@ To add an image, use the ``addImage`` method to sections, headers, footers, text
$section->addImage($src, [$style]);

- ``$src``. String path to a local image, URL of a remote image or the image data, as a string. Warning: Do not pass user-generated strings here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing file paths or URLs instead of image data.
- ``$style``. See :ref:`image-style`.
- ``$style``. Classname, Array or Image style object. See :ref:`image-style`.

Examples:

Expand Down Expand Up @@ -382,8 +382,8 @@ Checkbox elements can be added to sections or table cells by using ``addCheckBox

- ``$name``. Name of the check box.
- ``$text``. Text to be displayed in the document.
- ``$fontStyle``. See :ref:`font-style`.
- ``$paragraphStyle``. See :ref:`paragraph-style`.
- ``$fontStyle``. Classname, Array or Font style object. See :ref:`font-style`.
- ``$paragraphStyle``. Classname, Array or Paragraph style object. See :ref:`paragraph-style`.

Textboxes
---------
Expand All @@ -405,7 +405,7 @@ Currently the following fields are supported:

$section->addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle])

- ``$fontStyle``. See :ref:`font-style`.
- ``$fontStyle``. Classname, Array or Font style object See :ref:`font-style`.

See ``\PhpOffice\PhpWord\Element\Field`` for list of properties and options available for each field type.
Options which are not specifically defined can be added. Those must start with a ``\``.
Expand Down
Loading