<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Webbtj\Clico\Table</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.xhtml">Namespaces</a>
</li>
<li>
<a href="../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../source/index.xhtml">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../classes.xhtml#Webbtj_Clico">Webbtj\Clico</a>
</li>
<li class="separator">Table</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#members">Members</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="../source/Table.php.xhtml#line13">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Webbtj\Clico\</small>Table</h1>
<h4>The Clico Table class allows for formatting tabular data for the CLI stdOut.</h4>
<p>It utilizes the Text class to allow for decorating text for the CLI stdOut.</p>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class Table
{<br/><ul class="none"><li>// members</li><li>private <a href="#members">$accessColumn</a>;
</li><li>private <a href="#members">$accessRow</a>;
</li><li>private string <a href="#members">$headerLineCharacter</a> =
'=';
</li><li>private string <a href="#members">$pipeCharacter</a> =
'|';
</li><li>private string <a href="#members">$rowLineCharacter</a> =
'-';
</li><li>private array <a href="#members">$rows</a> =
;
</li></ul><ul class="none"><li>// methods</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__call.xhtml">__call</a>()
</li><li>public void <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__construct.xhtml">__construct</a>()
</li><li>public string <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__toString.xhtml">__toString</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/addHeader.xhtml">addHeader</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/addRow.xhtml">addRow</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/cell.xhtml">cell</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/column.xhtml">column</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/distributeColumns.xhtml">distributeColumns</a>()
</li><li>public Text <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getHeaderLineCharacter.xhtml">getHeaderLineCharacter</a>()
</li><li>public void <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getHeight.xhtml">getHeight</a>()
</li><li>public Text <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getPipeCharacter.xhtml">getPipeCharacter</a>()
</li><li>public Text <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getRowLineCharacter.xhtml">getRowLineCharacter</a>()
</li><li>public integer <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getWidth.xhtml">getWidth</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/populate.xhtml">populate</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/row.xhtml">row</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setFirstRowAsHeader.xhtml">setFirstRowAsHeader</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setHeaderLineCharacter.xhtml">setHeaderLineCharacter</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setPipeCharacter.xhtml">setPipeCharacter</a>()
</li><li>public Table <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setRowLineCharacter.xhtml">setRowLineCharacter</a>()
</li><li>private void <a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/pushCharactersToRows.xhtml">pushCharactersToRows</a>()
</li></ul>
}<br/></div>
<h2 id="members">Members</h2>
<div class="styled members">
<h4>private</h4>
<ul class="members">
<li id="accessColumn">
<strong>$accessColumn</strong>
</li>
<li id="accessRow">
<strong>$accessRow</strong>
</li>
<li id="headerLineCharacter">
<strong>$headerLineCharacter</strong>
</li>
<li id="pipeCharacter">
<strong>$pipeCharacter</strong>
</li>
<li id="rowLineCharacter">
<strong>$rowLineCharacter</strong>
</li>
<li id="rows">
<strong>$rows</strong>
</li>
</ul>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>private</h4>
<ul>
<li id="pushCharactersToRows"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/pushCharactersToRows.xhtml">pushCharactersToRows()</a>
? Push the separation characters down to the rows</li>
</ul>
<h4>public</h4>
<ul>
<li id="__construct"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__construct.xhtml">__construct()</a>
? Constructor. Can optionally populate the data. Can optionally set the first row of data as the header row.</li>
<li id="__call"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__call.xhtml">__call()</a>
? A catch-all used to send Text decoration methods down to table column(s)</li>
<li id="__toString"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/__toString.xhtml">__toString()</a>
? Render the entire table using Text instances</li>
<li id="addHeader"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/addHeader.xhtml">addHeader()</a>
? Add a header row. Unsets the previous header row.</li>
<li id="addRow"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/addRow.xhtml">addRow()</a>
? Add a row</li>
<li id="cell"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/cell.xhtml">cell()</a>
? Target a specific cell for text decoration</li>
<li id="column"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/column.xhtml">column()</a>
? Target an entire column for text decoration</li>
<li id="distributeColumns"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/distributeColumns.xhtml">distributeColumns()</a>
? Fit all columns to the table (width and height)</li>
<li id="getHeaderLineCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getHeaderLineCharacter.xhtml">getHeaderLineCharacter()</a>
? Get the character (decorated) used to separate the header row from the body</li>
<li id="getHeight"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getHeight.xhtml">getHeight()</a>
? Get the number of rows high the table is</li>
<li id="getPipeCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getPipeCharacter.xhtml">getPipeCharacter()</a>
? Get the character (decorated) used to separate columns</li>
<li id="getRowLineCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getRowLineCharacter.xhtml">getRowLineCharacter()</a>
? Get the character (decorated) used to separate body rows</li>
<li id="getWidth"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/getWidth.xhtml">getWidth()</a>
? Get the number of columns wide the table is</li>
<li id="populate"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/populate.xhtml">populate()</a>
? Reformat Rows' and Columns' widths, heights, and separation characters as necessary.</li>
<li id="row"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/row.xhtml">row()</a>
? Target an entire row for text decoration</li>
<li id="setFirstRowAsHeader"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setFirstRowAsHeader.xhtml">setFirstRowAsHeader()</a>
? Make the first row the header row</li>
<li id="setHeaderLineCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setHeaderLineCharacter.xhtml">setHeaderLineCharacter()</a>
? Set the character used to separate the header row from the body</li>
<li id="setPipeCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setPipeCharacter.xhtml">setPipeCharacter()</a>
? Set the (decorated) character used to separate columns</li>
<li id="setRowLineCharacter"><a title="Webbtj\Clico\Table" href="../classes/Webbtj_Clico_Table/setRowLineCharacter.xhtml">setRowLineCharacter()</a>
? Set the charater used to separate body rows</li>
</ul>
</div>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2019 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>
|
Download
