Skip to content

Commit

Permalink
Update writeRow: default skipping columns that not defined in header …
Browse files Browse the repository at this point in the history 
…columns

Add phpdoc.bat: Quickly generate phpdoc
  • Loading branch information
@tansautn
tansautn committed Oct 19, 2024
1 parent 1b49730 commit 5a56d0b
Show file tree
Hide file tree
Showing 12 changed files with 134 additions and 104 deletions.
78 changes: 45 additions & 33 deletions docs/api/classes/Zuko-Flex2Cell-ExcelExporter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ <h4 id="toc-properties">
</dt>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipHeader">$skipHeader</a>
<a class="" href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipNotInHeader">$skipNotInHeader</a>
<span>
&nbsp;: bool </span>
</dt>
Expand Down Expand Up @@ -334,7 +334,7 @@ <h4 id="toc-methods">
<dd>Set the meta settings of the export.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipHeader">setSkipHeader()</a>
<a class="" href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipNotInHeader">setSkipNotInHeader()</a>
<span>
&nbsp;: static </span>
</dt>
Expand Down Expand Up @@ -738,9 +738,9 @@ <h4 class="phpdocumentor-element__name" id="property_metaSettings">
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_skipHeader">
$skipHeader
<a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipHeader" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_skipNotInHeader">
$skipNotInHeader
<a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipNotInHeader" class="headerlink"><i class="fas fa-link"></i></a>

<span class="phpdocumentor-element__modifiers">
</span>
Expand All @@ -757,8 +757,8 @@ <h4 class="phpdocumentor-element__name" id="property_skipHeader">
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$skipHeader</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<span class="phpdocumentor-signature__name">$skipNotInHeader</span>
= <span class="phpdocumentor-signature__default-value">true</span></code>



Expand Down Expand Up @@ -1275,40 +1275,37 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setSkipHeader">
setSkipHeader()
<a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipHeader" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method_setSkipNotInHeader">
setSkipNotInHeader()
<a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipNotInHeader" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">199</span>
<span class="phpdocumentor-element-found-in__line">197</span>

</aside>

<p class="phpdocumentor-summary">Set whether the export should write the header row or not.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setSkipHeader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$skipHeader</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
<span class="phpdocumentor-signature__name">setSkipNotInHeader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$skipNotInHeader</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>

<div class="phpdocumentor-label-line">
</div>

<section class="phpdocumentor-description"><p>The header row is the first row of the spreadsheet and is used to
label the columns. If this is set to true, the export will skip
writing the header row.</p>
</section>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$skipHeader</span>
<span class="phpdocumentor-signature__argument__name">$skipNotInHeader</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>If true, the export will skip writing the header row.</p>
<section class="phpdocumentor-description"><p>If true, the export will not write the header row.
If false, the export will write the header row.</p>
</section>

</dd>
Expand Down Expand Up @@ -1387,7 +1384,7 @@ <h4 class="phpdocumentor-element__name" id="method_applyMetaSettings">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">402</span>
<span class="phpdocumentor-element-found-in__line">417</span>

</aside>

Expand Down Expand Up @@ -1444,7 +1441,7 @@ <h4 class="phpdocumentor-element__name" id="method_formatValue">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">383</span>
<span class="phpdocumentor-element-found-in__line">398</span>

</aside>

Expand Down Expand Up @@ -1522,7 +1519,7 @@ <h4 class="phpdocumentor-element__name" id="method_getColumnLetter">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">420</span>
<span class="phpdocumentor-element-found-in__line">435</span>

</aside>

Expand Down Expand Up @@ -1571,7 +1568,7 @@ <h4 class="phpdocumentor-element__name" id="method_getHeader">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</span>
<span class="phpdocumentor-element-found-in__line">297</span>

</aside>

Expand Down Expand Up @@ -1628,7 +1625,7 @@ <h4 class="phpdocumentor-element__name" id="method_getHeaderFromMappingKey">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">449</span>
<span class="phpdocumentor-element-found-in__line">464</span>

</aside>

Expand Down Expand Up @@ -1683,7 +1680,7 @@ <h4 class="phpdocumentor-element__name" id="method_getMappingKeyFromHeader">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">437</span>
<span class="phpdocumentor-element-found-in__line">452</span>

</aside>

Expand Down Expand Up @@ -1738,7 +1735,7 @@ <h4 class="phpdocumentor-element__name" id="method_getSubHeader">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">300</span>
<span class="phpdocumentor-element-found-in__line">311</span>

</aside>

Expand Down Expand Up @@ -1795,7 +1792,7 @@ <h4 class="phpdocumentor-element__name" id="method_getValue">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">336</span>
<span class="phpdocumentor-element-found-in__line">351</span>

</aside>

Expand Down Expand Up @@ -1849,7 +1846,7 @@ <h4 class="phpdocumentor-element__name" id="method_writeHeaders">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">260</span>
<span class="phpdocumentor-element-found-in__line">261</span>

</aside>

Expand Down Expand Up @@ -1877,6 +1874,21 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_writeHeaders#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\PhpOffice\PhpSpreadsheet\Exception">Exception</abbr></span>


</dd>
</dl>



Expand All @@ -1896,7 +1908,7 @@ <h4 class="phpdocumentor-element__name" id="method_writeRow">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">314</span>
<span class="phpdocumentor-element-found-in__line">325</span>

</aside>

Expand Down Expand Up @@ -1961,7 +1973,7 @@ <h4 class="phpdocumentor-element__name" id="method_dataGet">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">350</span>
<span class="phpdocumentor-element-found-in__line">365</span>

</aside>

Expand Down Expand Up @@ -2020,7 +2032,7 @@ <h4 class="phpdocumentor-element__name" id="method_first">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Traits/ExcelExportable.php"><a href="files/src-traits-excelexportable.html"><abbr title="src/Traits/ExcelExportable.php">ExcelExportable.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">454</span>
<span class="phpdocumentor-element-found-in__line">469</span>

</aside>

Expand Down Expand Up @@ -2185,7 +2197,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_hiddens">$hiddens</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_mapping">$mapping</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_metaSettings">$metaSettings</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipHeader">$skipHeader</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_skipNotInHeader">$skipNotInHeader</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#property_subHeaders">$subHeaders</a></li>
</ul>
</li>
Expand All @@ -2202,7 +2214,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setHiddens">setHiddens()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setMapping">setMapping()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setMetaSettings">setMetaSettings()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipHeader">setSkipHeader()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSkipNotInHeader">setSkipNotInHeader()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_setSubHeaders">setSubHeaders()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_applyMetaSettings">applyMetaSettings()</a></li>
<li class=""><a href="classes/Zuko-Flex2Cell-Traits-ExcelExportable.html#method_formatValue">formatValue()</a></li>
Expand Down
Loading

0 comments on commit 5a56d0b

Please sign in to comment.