PHP Classes

File: docs/structure.xml

Recommend this page to a friend!
  Classes of TJ Webb   Clico PHP CLI Color Text Output   docs/structure.xml   Download  
File: docs/structure.xml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: Clico PHP CLI Color Text Output
Format text to display on a CLI console
Author: By
Last change:
Date: 4 years ago
Size: 96,697 bytes
 

Contents

Class file image Download
<?xml version="1.0" encoding="utf-8"?> <project title="Clico" version="2.8.5"> <partials/> <file path="Row.php" generated-path="Row.html" hash="00030d2dd7b86db984328f2c800dd140" package="Default"> <docblock line="0"> <description></description> <long-description></long-description> <tag name="package" line="0" description="Default"/> </docblock> <namespace-alias name="Column">\Webbtj\Clico\Column</namespace-alias> <namespace-alias name="Text">\Webbtj\Clico\Text</namespace-alias> <class final="false" abstract="false" namespace="Webbtj\Clico" line="13" package="Default"> <extends/> <name>Row</name> <full_name>\Webbtj\Clico\Row</full_name> <docblock line="13"> <description>The Clico Row class is utilized by the Table class.</description> <long-description>It souldn't need to be accessed directly. It it used to fill Tables.</long-description> <tag name="package" line="13" description="Default"/> </docblock> <property static="false" visibility="private" namespace="Webbtj\Clico" line="15" package="Default"> <name>$columns</name> <full_name>\Webbtj\Clico\Row::columns</full_name> <default>array()</default> <docblock line="15"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="16" package="Default"> <name>$distributedWidth</name> <full_name>\Webbtj\Clico\Row::distributedWidth</full_name> <default>0</default> <docblock line="16"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="17" package="Default"> <name>$headerLineCharacter</name> <full_name>\Webbtj\Clico\Row::headerLineCharacter</full_name> <default></default> <docblock line="17"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="18" package="Default"> <name>$height</name> <full_name>\Webbtj\Clico\Row::height</full_name> <default></default> <docblock line="18"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="19" package="Default"> <name>$isHeader</name> <full_name>\Webbtj\Clico\Row::isHeader</full_name> <default>false</default> <docblock line="19"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="20" package="Default"> <name>$pipeCharacter</name> <full_name>\Webbtj\Clico\Row::pipeCharacter</full_name> <default></default> <docblock line="20"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="21" package="Default"> <name>$rowLineCharacter</name> <full_name>\Webbtj\Clico\Row::rowLineCharacter</full_name> <default></default> <docblock line="21"> <description></description> <long-description></long-description> </docblock> </property> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="28" package="Default"> <name>__construct</name> <full_name>\Webbtj\Clico\Row::__construct()</full_name> <docblock line="28"> <description>Constructor. Can optionally set the values of the columns</description> <long-description></long-description> <tag name="param" line="28" description="" type="Array" variable="$data"> <type>Array</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$data</name> <default>null</default> <type>Array</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="42" package="Default"> <name>__toString</name> <full_name>\Webbtj\Clico\Row::__toString()</full_name> <docblock line="42"> <description>Renders the columns, decorated.</description> <long-description></long-description> <tag name="return" line="42" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="68" package="Default"> <name>addColumn</name> <full_name>\Webbtj\Clico\Row::addColumn()</full_name> <docblock line="68"> <description>Adds a column to the Row</description> <long-description></long-description> <tag name="param" line="68" description="" type="\Webbtj\Clico\Column" variable="$column"> <type>\Webbtj\Clico\Column</type> </tag> <tag name="return" line="68" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$column</name> <default></default> <type>\Webbtj\Clico\Column</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="80" package="Default"> <name>distributeColumns</name> <full_name>\Webbtj\Clico\Row::distributeColumns()</full_name> <docblock line="80"> <description>Sets the widths of each column to fit within `$maxWidth`</description> <long-description></long-description> <tag name="param" line="80" description="" type="integer" variable="$maxWidth"> <type>integer</type> </tag> <tag name="param" line="80" description="" type="integer" variable="$numCols"> <type>integer</type> </tag> <tag name="return" line="80" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$maxWidth</name> <default></default> <type>integer</type> </argument> <argument line="0" by_reference="false"> <name>$numCols</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="100" package="Default"> <name>getColumns</name> <full_name>\Webbtj\Clico\Row::getColumns()</full_name> <docblock line="100"> <description>Get the columns</description> <long-description></long-description> <tag name="return" line="100" description="" type="Array"> <type>Array</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="110" package="Default"> <name>getHeaderLineCharacter</name> <full_name>\Webbtj\Clico\Row::getHeaderLineCharacter()</full_name> <docblock line="110"> <description>Get the character (decorated) used to separate the header row from the body</description> <long-description></long-description> <tag name="return" line="110" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="121" package="Default"> <name>getLineCharacter</name> <full_name>\Webbtj\Clico\Row::getLineCharacter()</full_name> <docblock line="121"> <description>Get the character (decorated) used to separate this row from other.</description> <long-description>This will return either the `headerLineCharacter` or the `rowLineCharacter`</long-description> <tag name="return" line="121" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="131" package="Default"> <name>getPipeCharacter</name> <full_name>\Webbtj\Clico\Row::getPipeCharacter()</full_name> <docblock line="131"> <description>Get the character (decorated) used to separate columns</description> <long-description></long-description> <tag name="return" line="131" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="141" package="Default"> <name>getRowLineCharacter</name> <full_name>\Webbtj\Clico\Row::getRowLineCharacter()</full_name> <docblock line="141"> <description>Get the character (decorated) used to separate body rows</description> <long-description></long-description> <tag name="return" line="141" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="151" package="Default"> <name>getWidth</name> <full_name>\Webbtj\Clico\Row::getWidth()</full_name> <docblock line="151"> <description>Get the number of columns wide</description> <long-description></long-description> <tag name="return" line="151" description="" type="integer"> <type>integer</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="161" package="Default"> <name>isHeader</name> <full_name>\Webbtj\Clico\Row::isHeader()</full_name> <docblock line="161"> <description>Check if this Row is the header row</description> <long-description></long-description> <tag name="return" line="161" description="" type="boolean"> <type>boolean</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="172" package="Default"> <name>populate</name> <full_name>\Webbtj\Clico\Row::populate()</full_name> <docblock line="172"> <description>Put data into Columns</description> <long-description></long-description> <tag name="param" line="172" description="" type="Array" variable="$data"> <type>Array</type> </tag> <tag name="return" line="172" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$data</name> <default></default> <type>Array</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="184" package="Default"> <name>setHeader</name> <full_name>\Webbtj\Clico\Row::setHeader()</full_name> <docblock line="184"> <description>Set this Row as the Table header</description> <long-description></long-description> <tag name="return" line="184" description="" type="void"> <type>void</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="195" package="Default"> <name>setHeaderLineCharacter</name> <full_name>\Webbtj\Clico\Row::setHeaderLineCharacter()</full_name> <docblock line="195"> <description>Set the (decorated) character used to separate the header row from the body</description> <long-description></long-description> <tag name="param" line="195" description="" type="\Webbtj\Clico\Text" variable="$line"> <type>\Webbtj\Clico\Text</type> </tag> <tag name="return" line="195" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$line</name> <default></default> <type>\Webbtj\Clico\Text</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="206" package="Default"> <name>setPipeCharacter</name> <full_name>\Webbtj\Clico\Row::setPipeCharacter()</full_name> <docblock line="206"> <description>Set the (decorated) character used to separate columns</description> <long-description></long-description> <tag name="param" line="206" description="" type="\Webbtj\Clico\Text" variable="$pipe"> <type>\Webbtj\Clico\Text</type> </tag> <tag name="return" line="206" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$pipe</name> <default></default> <type>\Webbtj\Clico\Text</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="217" package="Default"> <name>setRowLineCharacter</name> <full_name>\Webbtj\Clico\Row::setRowLineCharacter()</full_name> <docblock line="217"> <description>Set the (decorated) charater used to separate body rows</description> <long-description></long-description> <tag name="param" line="217" description="" type="\Webbtj\Clico\Text" variable="$line"> <type>\Webbtj\Clico\Text</type> </tag> <tag name="return" line="217" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$line</name> <default></default> <type>\Webbtj\Clico\Text</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="227" package="Default"> <name>unsetHeader</name> <full_name>\Webbtj\Clico\Row::unsetHeader()</full_name> <docblock line="227"> <description>Make the row not the header</description> <long-description></long-description> <tag name="return" line="227" description="" type="void"> <type>void</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="237" package="Default"> <name>verticalConform</name> <full_name>\Webbtj\Clico\Row::verticalConform()</full_name> <docblock line="237"> <description>Make all columns in the row the same height (stretch shorter columns)</description> <long-description></long-description> <tag name="return" line="237" description="" type="void"> <type>void</type> </tag> </docblock> </method> </class> <parse_markers> <error line="0" code="PPC:ERR-50000">No summary was found for this file</error> <error line="15" code="PPC:ERR-50007">No summary for property $columns</error> <error line="16" code="PPC:ERR-50007">No summary for property $distributedWidth</error> <error line="17" code="PPC:ERR-50007">No summary for property $headerLineCharacter</error> <error line="18" code="PPC:ERR-50007">No summary for property $height</error> <error line="19" code="PPC:ERR-50007">No summary for property $isHeader</error> <error line="20" code="PPC:ERR-50007">No summary for property $pipeCharacter</error> <error line="21" code="PPC:ERR-50007">No summary for property $rowLineCharacter</error> </parse_markers> <source>eJytWN1v2zYQf/dfcQiMRY4Te31dmnSFH5YBG1AkAfrQFA0t0REXmRREKq435H/fkaIkihJt50NAEIs83t3vvqmPn/I0H404WVOZk5jCV7pcqn/uFhmLxfloVMru0t1CZOWan/c3bulPhQfmJycjOIHblIJZh2uxgTgjUgKTUCqWsX9pAsstKCS5JcuMVtszfUz//alAijJL+LECTpFWCVhSIHFMpcTXhBU0Vtl2pimZglJWNCuWZRVDw2s+qqSi/NF/I8AnL9gTURTGscEg4QK+fT/vbiVMqoItS0WTryxRKdL86pGklCS0+ItxukhJQWJFix4Fe0iVt8jklTmIHFckk9Tbzlke5FeIjSfO7BtT6+cEFoKj3mWsRDGDBeEgcsUEJ1m2BUmVsfUTyUoqQazMm7WBZVDz+T1HEWv4XBRki8YgitideaVRuUSfwqrksWYPP37EteDIOYMQeZllE3Omsr1+2Coy25N2ST9jlTJ5dpmLvMwQrqU5b2ieRyOPtOSIqbJmZAmfeya5phz3pQv2FBIaiwKFJDMfeEFVWXDQ3ucPe0ArcWPIIh/hWJQqLxXiPzpqASAgmWoH4vrxcbu+EkU0ZibCMDzgYw3Phg+uTaeerfAIJXEaWco6kImsg9qjd5WaXdREZ5cPVGmFUPwEZo0HuiHYY6T9h+qivgNSukC1rIqpldTwjSZnlwXNKVGRq41JtmgCZ/DB0Qg3vrhKRU5YtOERfnOgH93xIzemXFC12n5gOoZrkQU52Qiyp0Jh+TlJ0F82InXZ0vGpa1S17yViVW1rv/nB+iRYsjNUSZJUHKIuo17cdsLp23doQiUE44aqKrU22nGmqujAdHCtsDRvGDLmcD9ek5/Gw/fDMBlX9AFLY0MX2uflGpHIFxuiLeuVIWSELFtxp2BeLfeAdcKtwRCRpwdttpolzBt+nYwPpe8jXFzCL8NZPN5YeatM6JqBorxEmM83KcNOSjIUkGwdvEnlIcizUjsMe3D1jj+wUeol7BbR4xTT7gSQcYetYRpBFLLA1Ko2weIVRWPLxegHQ5XIEE+nXd29lA2JurDHu4ebGiLrGmI18jO0H8J/2L4Y6IQ2tExb2xlbWKTqoPIjpy4JHXeHUqrRp652EDXtatJMOZLqlMCpQJNWowjgfACrQqzN2lIk2wAWPaLtg3LVn272wArOQ+8AEaO0ASfwZFH3bRwwTSjjyGe1oUzvG/b3Ayrdg7Cb/jTVq0kvsNZL7NQMgJ+c9jZobvjNobj21A1PPC+07u64PwS915t3oh+Yb9+MQIe6jo+3YOibdyeM/ii+Gwm2gCXCwPZYF3ssTzSgr21z+1S2s9KwnrEoufIaTDBiFimNH3EEqjJN39SY9ApLQNWlEBklfKeqdcAfmBchJb/gCGZuFWgeYSeig+8th48Izf3DYeIr3vRvo09w6rbA2umL041VvB56Jwc0qBsTQ9YxRDoX5so9AdfsRepcnoYnHeeqinc7umMGNDq5Odpm7psaVuVOnb8wzjDfXo+xm9wtxwD0gc6hpzp94p3MsPPiXemna+VrEHfrccsrgLVTkjVKvfBilIMgg5X5PRzbK9l7vepX7X0u/Zs8VvGqA5UL5cTua5Ou881ib9o5X4gC2hGcfOqWglesWln9X5K11lZ/RIAIx2iq8GImU1Fo5HVLeC2OJ1ooFpNsIThWw3UfixV8AR8OuvcMF9CGCV6nIvt22vl8cWXWon4d3S0vdMOqOdfwvpCkljsoofOpRoeT+80PXfb8P71fEzM=</source> </file> <file path="Table.php" generated-path="Table.html" hash="92bdf0765c36c465080153d57c995376" package="Default"> <docblock line="0"> <description></description> <long-description></long-description> <tag name="package" line="0" description="Default"/> </docblock> <namespace-alias name="Row">\Webbtj\Clico\Row</namespace-alias> <namespace-alias name="Text">\Webbtj\Clico\Text</namespace-alias> <class final="false" abstract="false" namespace="Webbtj\Clico" line="13" package="Default"> <extends/> <name>Table</name> <full_name>\Webbtj\Clico\Table</full_name> <docblock line="13"> <description>The Clico Table class allows for formatting tabular data for the CLI stdOut.</description> <long-description>It utilizes the Text class to allow for decorating text for the CLI stdOut.</long-description> <tag name="package" line="13" description="Default"/> </docblock> <property static="false" visibility="private" namespace="Webbtj\Clico" line="15" package="Default"> <name>$accessColumn</name> <full_name>\Webbtj\Clico\Table::accessColumn</full_name> <default></default> <docblock line="15"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="16" package="Default"> <name>$accessRow</name> <full_name>\Webbtj\Clico\Table::accessRow</full_name> <default></default> <docblock line="16"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="17" package="Default"> <name>$headerLineCharacter</name> <full_name>\Webbtj\Clico\Table::headerLineCharacter</full_name> <default>'='</default> <docblock line="17"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="18" package="Default"> <name>$pipeCharacter</name> <full_name>\Webbtj\Clico\Table::pipeCharacter</full_name> <default>'|'</default> <docblock line="18"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="19" package="Default"> <name>$rowLineCharacter</name> <full_name>\Webbtj\Clico\Table::rowLineCharacter</full_name> <default>'-'</default> <docblock line="19"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="20" package="Default"> <name>$rows</name> <full_name>\Webbtj\Clico\Table::rows</full_name> <default>array()</default> <docblock line="20"> <description></description> <long-description></long-description> </docblock> </property> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="31" package="Default"> <name>__call</name> <full_name>\Webbtj\Clico\Table::__call()</full_name> <docblock line="31"> <description>Call Text decorator methods</description> <long-description>A catch-all used to send Text decoration methods down to table column(s)</long-description> <tag name="param" line="31" description="" type="string" variable="$method"> <type>string</type> </tag> <tag name="param" line="31" description="" type="Array" variable="$args"> <type>Array</type> </tag> <tag name="return" line="31" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$method</name> <default></default> <type>string</type> </argument> <argument line="0" by_reference="false"> <name>$args</name> <default></default> <type>Array</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="58" package="Default"> <name>__construct</name> <full_name>\Webbtj\Clico\Table::__construct()</full_name> <docblock line="58"> <description>Constructor</description> <long-description>Can optionally populate the data. Can optionally set the first row of data as the header row.</long-description> <tag name="param" line="58" description="" type="Array" variable="$data"> <type>Array</type> </tag> <tag name="param" line="58" description="" type="boolean" variable="$firstRowAsHeader"> <type>boolean</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$data</name> <default>null</default> <type>Array</type> </argument> <argument line="0" by_reference="false"> <name>$firstRowAsHeader</name> <default>true</default> <type>boolean</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="77" package="Default"> <name>__toString</name> <full_name>\Webbtj\Clico\Table::__toString()</full_name> <docblock line="77"> <description>Render the entire table using Text instances</description> <long-description></long-description> <tag name="return" line="77" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="94" package="Default"> <name>addHeader</name> <full_name>\Webbtj\Clico\Table::addHeader()</full_name> <docblock line="94"> <description>Add a header row</description> <long-description>Add a header row. Unsets the previous header row.</long-description> <tag name="param" line="94" description="" type="Array" variable="$row"> <type>Array</type> </tag> <tag name="return" line="94" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$row</name> <default></default> <type>Array</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="116" package="Default"> <name>addRow</name> <full_name>\Webbtj\Clico\Table::addRow()</full_name> <docblock line="116"> <description>Add a row</description> <long-description></long-description> <tag name="param" line="116" description="" type="\Webbtj\Clico\Row" variable="$row"> <type>\Webbtj\Clico\Row</type> </tag> <tag name="return" line="116" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$row</name> <default></default> <type>\Webbtj\Clico\Row</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="130" package="Default"> <name>cell</name> <full_name>\Webbtj\Clico\Table::cell()</full_name> <docblock line="130"> <description>Target a specific cell for text decoration</description> <long-description></long-description> <tag name="param" line="130" description="" type="integer" variable="$column"> <type>integer</type> </tag> <tag name="param" line="130" description="" type="integer" variable="$row"> <type>integer</type> </tag> <tag name="return" line="130" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$column</name> <default></default> <type>integer</type> </argument> <argument line="0" by_reference="false"> <name>$row</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="141" package="Default"> <name>column</name> <full_name>\Webbtj\Clico\Table::column()</full_name> <docblock line="141"> <description>Target an entire column for text decoration</description> <long-description></long-description> <tag name="param" line="141" description="" type="integer" variable="$index"> <type>integer</type> </tag> <tag name="return" line="141" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$index</name> <default>null</default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="153" package="Default"> <name>distributeColumns</name> <full_name>\Webbtj\Clico\Table::distributeColumns()</full_name> <docblock line="153"> <description>Fit all columns to the table (width and height)</description> <long-description></long-description> <tag name="param" line="153" description="" type="integer" variable="$maxWidth"> <type>integer</type> </tag> <tag name="return" line="153" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$maxWidth</name> <default>160</default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="169" package="Default"> <name>getHeaderLineCharacter</name> <full_name>\Webbtj\Clico\Table::getHeaderLineCharacter()</full_name> <docblock line="169"> <description>Get the header separator character</description> <long-description>Get the character (decorated) used to separate the header row from the body</long-description> <tag name="return" line="169" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="179" package="Default"> <name>getHeight</name> <full_name>\Webbtj\Clico\Table::getHeight()</full_name> <docblock line="179"> <description>Get the number of rows high</description> <long-description></long-description> <tag name="return" line="179" description="" type="void"> <type>void</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="191" package="Default"> <name>getPipeCharacter</name> <full_name>\Webbtj\Clico\Table::getPipeCharacter()</full_name> <docblock line="191"> <description>Get the column separator character</description> <long-description>Get the character (decorated) used to separate columns</long-description> <tag name="return" line="191" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="203" package="Default"> <name>getRowLineCharacter</name> <full_name>\Webbtj\Clico\Table::getRowLineCharacter()</full_name> <docblock line="203"> <description>Get the row separator character</description> <long-description>Get the character (decorated) used to separate body rows</long-description> <tag name="return" line="203" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="213" package="Default"> <name>getWidth</name> <full_name>\Webbtj\Clico\Table::getWidth()</full_name> <docblock line="213"> <description>Get the number of columns wide</description> <long-description></long-description> <tag name="return" line="213" description="" type="integer"> <type>integer</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="231" package="Default"> <name>populate</name> <full_name>\Webbtj\Clico\Table::populate()</full_name> <docblock line="231"> <description>Format table, bulk add rows</description> <long-description>Reformat Rows' and Columns' widths, heights, and separation characters as necessary. Optionally add rows of data to the table</long-description> <tag name="param" line="231" description="" type="Array" variable="$data"> <type>Array</type> </tag> <tag name="return" line="231" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$data</name> <default>null</default> <type>Array</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="250" package="Default"> <name>row</name> <full_name>\Webbtj\Clico\Table::row()</full_name> <docblock line="250"> <description>Target an entire row for text decoration</description> <long-description></long-description> <tag name="param" line="250" description="" type="integer" variable="$index"> <type>integer</type> </tag> <tag name="return" line="250" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$index</name> <default>null</default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="261" package="Default"> <name>setFirstRowAsHeader</name> <full_name>\Webbtj\Clico\Table::setFirstRowAsHeader()</full_name> <docblock line="261"> <description>Make the first row the header row</description> <long-description></long-description> <tag name="return" line="261" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="285" package="Default"> <name>setHeaderLineCharacter</name> <full_name>\Webbtj\Clico\Table::setHeaderLineCharacter()</full_name> <docblock line="285"> <description>Set the header separator character</description> <long-description>Set the character used to separate the header row from the body</long-description> <tag name="param" line="285" description="" type="String" variable="$char"> <type>String</type> </tag> <tag name="param" line="285" description="" type="boolean" variable="$pushToRows"> <type>boolean</type> </tag> <tag name="return" line="285" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$char</name> <default></default> <type>String</type> </argument> <argument line="0" by_reference="false"> <name>$pushToRows</name> <default>true</default> <type>boolean</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="304" package="Default"> <name>setPipeCharacter</name> <full_name>\Webbtj\Clico\Table::setPipeCharacter()</full_name> <docblock line="304"> <description>Set the column separator character</description> <long-description>Set the character used to separate columns</long-description> <tag name="param" line="304" description="" type="String" variable="$char"> <type>String</type> </tag> <tag name="param" line="304" description="" type="boolean" variable="$pushToRows"> <type>boolean</type> </tag> <tag name="return" line="304" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$char</name> <default></default> <type>String</type> </argument> <argument line="0" by_reference="false"> <name>$pushToRows</name> <default>true</default> <type>boolean</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="323" package="Default"> <name>setRowLineCharacter</name> <full_name>\Webbtj\Clico\Table::setRowLineCharacter()</full_name> <docblock line="323"> <description>Set the row separator character</description> <long-description>Set the charater used to separate body rows</long-description> <tag name="param" line="323" description="" type="String" variable="$char"> <type>String</type> </tag> <tag name="param" line="323" description="" type="boolean" variable="$pushToRows"> <type>boolean</type> </tag> <tag name="return" line="323" description="" type="\Webbtj\Clico\Table"> <type>\Webbtj\Clico\Table</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$char</name> <default></default> <type>String</type> </argument> <argument line="0" by_reference="false"> <name>$pushToRows</name> <default>true</default> <type>boolean</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="private" namespace="Webbtj\Clico" line="338" package="Default"> <name>pushCharactersToRows</name> <full_name>\Webbtj\Clico\Table::pushCharactersToRows()</full_name> <docblock line="338"> <description>Push the separation characters down to the rows</description> <long-description></long-description> <tag name="return" line="338" description="" type="void"> <type>void</type> </tag> </docblock> </method> </class> <parse_markers> <error line="0" code="PPC:ERR-50000">No summary was found for this file</error> <error line="15" code="PPC:ERR-50007">No summary for property $accessColumn</error> <error line="16" code="PPC:ERR-50007">No summary for property $accessRow</error> <error line="17" code="PPC:ERR-50007">No summary for property $headerLineCharacter</error> <error line="18" code="PPC:ERR-50007">No summary for property $pipeCharacter</error> <error line="19" code="PPC:ERR-50007">No summary for property $rowLineCharacter</error> <error line="20" code="PPC:ERR-50007">No summary for property $rows</error> </parse_markers> <source>eJzNWVtv2zYUfvev4AojkQPn0pe9eMkaBOhaoEOLJEMfUsOgJdriYkuCSMXJtvz3ncOLLhQlO05R1EBaWzw85Ll95yP12+9ZnA0GCV0zkdGQka9sPpd/f7ta8TCdDAaFaD76dp1uJu2nt+xRgvTp0dGAHJHbmBH1nNzS+YqRcEWFIHS1SjeCLNIc/9ZUSp4siaTzYkVzElFJ1ZjEyZ8+EiGjz4U8QX3491GSQvIV/4cJJYIrGsUy1brV9IiFaU61ahTxqzwd6Klqf4N/BwQ+Wc4fqGRkSMOQCXGVrop1MvENKR80nseMRiz/xBN2FdOchpLl5Jwcnh86chnPmhL/uRJ5ummpOfYICRi4m07w8UANKt/j54hcgTu0g4w3wAdrJuM0ElbE/n9JQirD+BhnQFQjdKZgSdSYztPEzidRuklQSOrIKicFYmT0WbXvMtj+GhyeYyCGerIzeJnn9Alcmi/LXb3LmSzyxIRFPzzVphdzSCiyKJJQbWc2C2HLgdE81mr0LnQ08WP9NJQxF8cX+GtSDvJF8AsXs6RANVqgjO6IHBwQLgSTgdJx5wpMR6NqmfpSdx3y02rh5/Ib5CajYazXIFSQA/zmatY+VnbA6PHFkkmdmyIYTRqinSZp+bpVRumdR6xlm7OLu97J0+aWnhu/SoOtNrDZfPesiRGeQVLmMwz7jGK+BHZ15QdM0q85hzIJRmObZlObDV07qb6ZdFN2aOnndjGlCaRxEUIRucVzRROSZpiPsNMnkqUZQBnUJ+IN4tmJKwGux0E7f8FzIQkElaQLDYBUg5uGExw58ReWqR2c44zM03TFYNWhUg6pdyk+KG3bysmaGdR0Q7QxmcZtbTAC0qxVcTojwM5rB8eCqggbz8dkQVeC1YJV6fjQRlWrxgO4fZq+1HHX6miAcTW7jhDKC25Bmtkm2kamVYktl/mqqtzge0fYLW03e9t5eg2ozXSvY4nkOTMQXQiEYAXnHEJMEyhWN6lMHWi43pIoMr1RYsGoFfasEHHpUHGbgj0NjBqmhcwKCbnz5k31tASFCqUVLnig0Mw/0VDog1Rb0Vqyq6Yvo4jQWpW1uqIzfkL+SiBIujiznD3wtBA7V2ltgd0bHI0ikwmVFrfaOj3n+A2zMT++4GVu+VIRBIqkLLpt+WfUQrfRsKy25+mJiCBsQyATtMikJVGrdHfRul3nRC00W7N8yQLVZhHoKwn/3LJKR33Z0of/OheqGDoxBsv2jzC6xSrogFJFJ6bEzfge83Yx6hYaJPQiSkTGQr6AbYUMGKAiy03i57eaJ5ItIfdNM+4a3csvuJMAVFjlY6J+eFxUt1R5SufY8YWhpZZabPNCYhFTy+/hBg7Y+7iHqXqfyj6lwjTcjlyoEy3MCDXlZYF/zyUeloglYMjkY9sqgg2PZAz+iADb+DKWHbS+NHtNH7/ilJdbHnFsNvNCMstlS2Vg2dtfz3bEOi9jVqjSs0KJGxB99QAQ0QdMDyyXHFgoUEA8se6PIX9o3mc7hmDoRzyVhbZbuh3IzigFSGCSkUWj2klNKWIOaSSLPF2rZ/M0eupo9sgIekO09BOw/iL08LJtTkmK9Rz2DRRYBTWGxOvY8kPKo+1bxsTt2mWYFokM2l2je3cGEr5/yEwFviI6TVLbH5cG191mM6bQ9zcYc1GF+BUmt04VW1vCnqlo8REQkXXs16Dgti0bgHERfWOg7mwvImxnA6IF+se4uh1oQ1obrdScziahrud0UxiTebG6R7JSj12ZA9dM3+UhDxKHqnUYuD0kag0xNr0EvuCoSQfV/cqjApqZMGxuNH+yZJp8rg7OdvnyoFzvW73ku3FE3rk9lbyqfRh2I9lxSiyDac/1njCqUJrWrslggyvvQMF3PXhpsXZLrB93X8IbS8aUm2vXH0KXkOG9jCtdqxPIPkTpT3qv22p1SdNssl0ottUK72l/N7YzvCfnF/ud79TZrq7vbng/7cmwen6bO8Pa3LP2BWhjtONQ9/yybLt5MW26abWkV1ElnbY35hYblTpD5W0bVqCuu70Swke06suO1Ur1Zfov4PzvIxBdsMsGopgDEgRG9dmYvK2DDaZTtVDH7dcWxNkz0ruzrR0i3cGwflhQm/zsNeF0Xxv9/IHckUI2ougNYidr/GFhbHHO10TS83rv5w3mF1CnwuMnbeWrQB3vLl7fPrWZ15gV2/Jue7eW2H0B0PMSwnuS6L+b7NLjPSJ3qfK+hmif5FrMXf87eP4f0WMLUg==</source> </file> <file path="Text.php" generated-path="Text.html" hash="018dc23e0bd25a68658bd3c880e910dc" package="Default"> <docblock line="0"> <description></description> <long-description></long-description> <tag name="package" line="0" description="Default"/> </docblock> <class final="false" abstract="false" namespace="Webbtj\Clico" line="11" package="Default"> <extends/> <name>Text</name> <full_name>\Webbtj\Clico\Text</full_name> <docblock line="11"> <description>The Clico Text class allows for text decorating for the CLI stdOut.</description> <long-description>Text and backgrounds can be coloured; text weight can be set as well as Other effects such as blinking, highlighting, and underlining.</long-description> <tag name="package" line="11" description="Default"/> </docblock> <property static="true" visibility="public" namespace="Webbtj\Clico" line="13" package="Default"> <name>$BACKGROUND_OPENED</name> <full_name>\Webbtj\Clico\Text::BACKGROUND_OPENED</full_name> <default>'background'</default> <docblock line="13"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="14" package="Default"> <name>$BG_DARK</name> <full_name>\Webbtj\Clico\Text::BG_DARK</full_name> <default>40</default> <docblock line="14"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="15" package="Default"> <name>$BG_DEFAULT</name> <full_name>\Webbtj\Clico\Text::BG_DEFAULT</full_name> <default>49</default> <docblock line="15"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="16" package="Default"> <name>$BG_LIGHT</name> <full_name>\Webbtj\Clico\Text::BG_LIGHT</full_name> <default>100</default> <docblock line="16"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="17" package="Default"> <name>$BLINK</name> <full_name>\Webbtj\Clico\Text::BLINK</full_name> <default>5</default> <docblock line="17"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="18" package="Default"> <name>$DARK_SHADE</name> <full_name>\Webbtj\Clico\Text::DARK_SHADE</full_name> <default>'dark'</default> <docblock line="18"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="19" package="Default"> <name>$FG_DARK</name> <full_name>\Webbtj\Clico\Text::FG_DARK</full_name> <default>30</default> <docblock line="19"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="20" package="Default"> <name>$FG_DEFAULT</name> <full_name>\Webbtj\Clico\Text::FG_DEFAULT</full_name> <default>39</default> <docblock line="20"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="21" package="Default"> <name>$FG_LIGHT</name> <full_name>\Webbtj\Clico\Text::FG_LIGHT</full_name> <default>90</default> <docblock line="21"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="22" package="Default"> <name>$FOREGROUND_OPENED</name> <full_name>\Webbtj\Clico\Text::FOREGROUND_OPENED</full_name> <default>'foreground'</default> <docblock line="22"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="23" package="Default"> <name>$HIDDEN</name> <full_name>\Webbtj\Clico\Text::HIDDEN</full_name> <default>8</default> <docblock line="23"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="24" package="Default"> <name>$HIGHLIGHT</name> <full_name>\Webbtj\Clico\Text::HIGHLIGHT</full_name> <default>7</default> <docblock line="24"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="25" package="Default"> <name>$LIGHT_SHADE</name> <full_name>\Webbtj\Clico\Text::LIGHT_SHADE</full_name> <default>'light'</default> <docblock line="25"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="26" package="Default"> <name>$UNDERLINE</name> <full_name>\Webbtj\Clico\Text::UNDERLINE</full_name> <default>4</default> <docblock line="26"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="27" package="Default"> <name>$WEIGHT_HEAVY</name> <full_name>\Webbtj\Clico\Text::WEIGHT_HEAVY</full_name> <default>1</default> <docblock line="27"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="28" package="Default"> <name>$WEIGHT_LIGHT</name> <full_name>\Webbtj\Clico\Text::WEIGHT_LIGHT</full_name> <default>2</default> <docblock line="28"> <description></description> <long-description></long-description> </docblock> </property> <property static="true" visibility="public" namespace="Webbtj\Clico" line="29" package="Default"> <name>$WEIGHT_NORMAL</name> <full_name>\Webbtj\Clico\Text::WEIGHT_NORMAL</full_name> <default>0</default> <docblock line="29"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="31" package="Default"> <name>$background</name> <full_name>\Webbtj\Clico\Text::background</full_name> <default></default> <docblock line="31"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="32" package="Default"> <name>$blink</name> <full_name>\Webbtj\Clico\Text::blink</full_name> <default></default> <docblock line="32"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="33" package="Default"> <name>$foreground</name> <full_name>\Webbtj\Clico\Text::foreground</full_name> <default></default> <docblock line="33"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="34" package="Default"> <name>$hidden</name> <full_name>\Webbtj\Clico\Text::hidden</full_name> <default></default> <docblock line="34"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="35" package="Default"> <name>$highlight</name> <full_name>\Webbtj\Clico\Text::highlight</full_name> <default></default> <docblock line="35"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="36" package="Default"> <name>$opened</name> <full_name>\Webbtj\Clico\Text::opened</full_name> <default></default> <docblock line="36"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="37" package="Default"> <name>$repeat</name> <full_name>\Webbtj\Clico\Text::repeat</full_name> <default>1</default> <docblock line="37"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="38" package="Default"> <name>$shade</name> <full_name>\Webbtj\Clico\Text::shade</full_name> <default></default> <docblock line="38"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="39" package="Default"> <name>$string</name> <full_name>\Webbtj\Clico\Text::string</full_name> <default></default> <docblock line="39"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="40" package="Default"> <name>$underline</name> <full_name>\Webbtj\Clico\Text::underline</full_name> <default></default> <docblock line="40"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="41" package="Default"> <name>$weight</name> <full_name>\Webbtj\Clico\Text::weight</full_name> <default></default> <docblock line="41"> <description></description> <long-description></long-description> </docblock> </property> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="50" package="Default"> <name>__construct</name> <full_name>\Webbtj\Clico\Text::__construct()</full_name> <docblock line="50"> <description>Constructor</description> <long-description>Can optionally set the text on instantiation.</long-description> <tag name="param" line="50" description="" type="String" variable="$string"> <type>String</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$string</name> <default>null</default> <type>String</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="65" package="Default"> <name>__toString</name> <full_name>\Webbtj\Clico\Text::__toString()</full_name> <docblock line="65"> <description>Renders decorated text</description> <long-description></long-description> <tag name="return" line="65" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="103" package="Default"> <name>b</name> <full_name>\Webbtj\Clico\Text::b()</full_name> <docblock line="103"> <description>Alias of heavyWeight()</description> <long-description></long-description> <tag name="return" line="103" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="115" package="Default"> <name>background</name> <full_name>\Webbtj\Clico\Text::background()</full_name> <docblock line="115"> <description>Affect the background</description> <long-description>Direct future colour methods to affect the background colour.</long-description> <tag name="return" line="115" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="128" package="Default"> <name>black</name> <full_name>\Webbtj\Clico\Text::black()</full_name> <docblock line="128"> <description>Set the colour to black</description> <long-description>Set the colour (background or foreground) to black</long-description> <tag name="return" line="128" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="138" package="Default"> <name>blink</name> <full_name>\Webbtj\Clico\Text::blink()</full_name> <docblock line="138"> <description>Make the text blink/flash</description> <long-description></long-description> <tag name="return" line="138" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="150" package="Default"> <name>blue</name> <full_name>\Webbtj\Clico\Text::blue()</full_name> <docblock line="150"> <description>Set the colour to blue</description> <long-description>Set the colour (background or foreground) to blue</long-description> <tag name="return" line="150" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="160" package="Default"> <name>bold</name> <full_name>\Webbtj\Clico\Text::bold()</full_name> <docblock line="160"> <description>Alias of heavyWeight()</description> <long-description></long-description> <tag name="return" line="160" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="172" package="Default"> <name>cyan</name> <full_name>\Webbtj\Clico\Text::cyan()</full_name> <docblock line="172"> <description>Set the colour to cyan</description> <long-description>Set the colour (background or foreground) to cyan</long-description> <tag name="return" line="172" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="184" package="Default"> <name>dark</name> <full_name>\Webbtj\Clico\Text::dark()</full_name> <docblock line="184"> <description>Use dark colour variants</description> <long-description>Make future colour assignments their dark variant</long-description> <tag name="return" line="184" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="197" package="Default"> <name>darken</name> <full_name>\Webbtj\Clico\Text::darken()</full_name> <docblock line="197"> <description>Make the last assigned colour dark</description> <long-description>Make the most recent colour assignment (background/foreground) its dark variant.</long-description> <tag name="return" line="197" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="218" package="Default"> <name>dim</name> <full_name>\Webbtj\Clico\Text::dim()</full_name> <docblock line="218"> <description>Alias of lightWeight()</description> <long-description></long-description> <tag name="return" line="218" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="228" package="Default"> <name>flash</name> <full_name>\Webbtj\Clico\Text::flash()</full_name> <docblock line="228"> <description>Alias of blink()</description> <long-description></long-description> <tag name="return" line="228" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="240" package="Default"> <name>foreground</name> <full_name>\Webbtj\Clico\Text::foreground()</full_name> <docblock line="240"> <description>Affect the foreground.</description> <long-description>Direct future colour methods to affect the foreground colour.</long-description> <tag name="return" line="240" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="251" package="Default"> <name>getText</name> <full_name>\Webbtj\Clico\Text::getText()</full_name> <docblock line="251"> <description>Get the undecorated text value</description> <long-description></long-description> <tag name="return" line="251" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="263" package="Default"> <name>green</name> <full_name>\Webbtj\Clico\Text::green()</full_name> <docblock line="263"> <description>Set the colour to green</description> <long-description>Set the colour (background or foreground) to green</long-description> <tag name="return" line="263" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="273" package="Default"> <name>heavyWeight</name> <full_name>\Webbtj\Clico\Text::heavyWeight()</full_name> <docblock line="273"> <description>Make the text bold</description> <long-description></long-description> <tag name="return" line="273" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="284" package="Default"> <name>hidden</name> <full_name>\Webbtj\Clico\Text::hidden()</full_name> <docblock line="284"> <description>Make the text invisible</description> <long-description></long-description> <tag name="return" line="284" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="295" package="Default"> <name>hide</name> <full_name>\Webbtj\Clico\Text::hide()</full_name> <docblock line="295"> <description>Alias of hidden()</description> <long-description></long-description> <tag name="return" line="295" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="307" package="Default"> <name>highlight</name> <full_name>\Webbtj\Clico\Text::highlight()</full_name> <docblock line="307"> <description>Make the text highlighted</description> <long-description>Make the text highlighted (invert background and foregroune colours)</long-description> <tag name="return" line="307" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="318" package="Default"> <name>length</name> <full_name>\Webbtj\Clico\Text::length()</full_name> <docblock line="318"> <description>Get the length of the undecorated string</description> <long-description></long-description> <tag name="return" line="318" description="" type="integer"> <type>integer</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="330" package="Default"> <name>light</name> <full_name>\Webbtj\Clico\Text::light()</full_name> <docblock line="330"> <description>Use light colour variants</description> <long-description>Make future colour assignments their light variant</long-description> <tag name="return" line="330" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="344" package="Default"> <name>lighten</name> <full_name>\Webbtj\Clico\Text::lighten()</full_name> <docblock line="344"> <description>Make the last assigned colour light</description> <long-description>Make the most recent colour assignment (background/foreground) its light variant.</long-description> <tag name="return" line="344" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="365" package="Default"> <name>lightWeight</name> <full_name>\Webbtj\Clico\Text::lightWeight()</full_name> <docblock line="365"> <description>Make the text light weight/thin/dim</description> <long-description></long-description> <tag name="return" line="365" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="378" package="Default"> <name>magenta</name> <full_name>\Webbtj\Clico\Text::magenta()</full_name> <docblock line="378"> <description>Set the colour to magenta</description> <long-description>Set the colour (background or foreground) to magenta</long-description> <tag name="return" line="378" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="388" package="Default"> <name>normal</name> <full_name>\Webbtj\Clico\Text::normal()</full_name> <docblock line="388"> <description>Alias of normalWeight()</description> <long-description></long-description> <tag name="return" line="388" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="398" package="Default"> <name>normalWeight</name> <full_name>\Webbtj\Clico\Text::normalWeight()</full_name> <docblock line="398"> <description>Make the text normal/default weight</description> <long-description></long-description> <tag name="return" line="398" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="409" package="Default"> <name>rainbow</name> <full_name>\Webbtj\Clico\Text::rainbow()</full_name> <docblock line="409"> <description>Experimental: Make the text multi-coloured</description> <long-description></long-description> <tag name="return" line="409" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="432" package="Default"> <name>red</name> <full_name>\Webbtj\Clico\Text::red()</full_name> <docblock line="432"> <description>Set the colour to red</description> <long-description>Set the colour (background or foreground) to red</long-description> <tag name="return" line="432" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="443" package="Default"> <name>repeat</name> <full_name>\Webbtj\Clico\Text::repeat()</full_name> <docblock line="443"> <description>Repeat the text property when rendering</description> <long-description></long-description> <tag name="param" line="443" description="" type="integer" variable="$repeat"> <type>integer</type> </tag> <tag name="return" line="443" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$repeat</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="458" package="Default"> <name>setDefault</name> <full_name>\Webbtj\Clico\Text::setDefault()</full_name> <docblock line="458"> <description>Set the active colour property to its default.</description> <long-description>Pass $setAll = true to set both the background and foreground colours to their default.</long-description> <tag name="param" line="458" description="" type="boolean" variable="$setAll"> <type>boolean</type> </tag> <tag name="return" line="458" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$setAll</name> <default>false</default> <type>boolean</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="473" package="Default"> <name>strong</name> <full_name>\Webbtj\Clico\Text::strong()</full_name> <docblock line="473"> <description>Alias of heavyWeight()</description> <long-description></long-description> <tag name="return" line="473" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="484" package="Default"> <name>testPattern</name> <full_name>\Webbtj\Clico\Text::testPattern()</full_name> <docblock line="484"> <description>Experimental: Output a test pattern</description> <long-description></long-description> <tag name="param" line="484" description="" type="integer" variable="$width"> <type>integer</type> </tag> <tag name="return" line="484" description="" type="string"> <type>string</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$width</name> <default>10</default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="503" package="Default"> <name>text</name> <full_name>\Webbtj\Clico\Text::text()</full_name> <docblock line="503"> <description>Set the (undecorated) string property</description> <long-description></long-description> <tag name="param" line="503" description="" type="String" variable="$string"> <type>String</type> </tag> <tag name="return" line="503" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$string</name> <default></default> <type>String</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="514" package="Default"> <name>thin</name> <full_name>\Webbtj\Clico\Text::thin()</full_name> <docblock line="514"> <description>Alias of lightWeight()</description> <long-description></long-description> <tag name="return" line="514" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="524" package="Default"> <name>u</name> <full_name>\Webbtj\Clico\Text::u()</full_name> <docblock line="524"> <description>Alias of underline()</description> <long-description></long-description> <tag name="return" line="524" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="534" package="Default"> <name>underline</name> <full_name>\Webbtj\Clico\Text::underline()</full_name> <docblock line="534"> <description>Make the text underlined</description> <long-description></long-description> <tag name="return" line="534" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="547" package="Default"> <name>white</name> <full_name>\Webbtj\Clico\Text::white()</full_name> <docblock line="547"> <description>Set the colour to white/grey</description> <long-description>Set the colour (background or foreground) to white/grey</long-description> <tag name="return" line="547" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="559" package="Default"> <name>yellow</name> <full_name>\Webbtj\Clico\Text::yellow()</full_name> <docblock line="559"> <description>Set the colour to yellow</description> <long-description>Set the colour (background or foreground) to yellow</long-description> <tag name="return" line="559" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="private" namespace="Webbtj\Clico" line="570" package="Default"> <name>assignColour</name> <full_name>\Webbtj\Clico\Text::assignColour()</full_name> <docblock line="570"> <description>Set the colour property</description> <long-description></long-description> <tag name="param" line="570" description="" type="integer" variable="$colour"> <type>integer</type> </tag> <tag name="return" line="570" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$colour</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="private" namespace="Webbtj\Clico" line="595" package="Default"> <name>colourMap</name> <full_name>\Webbtj\Clico\Text::colourMap()</full_name> <docblock line="595"> <description>The index of available colours and their numeric values</description> <long-description></long-description> <tag name="return" line="595" description="" type="Array"> <type>Array</type> </tag> </docblock> </method> </class> <parse_markers> <error line="0" code="PPC:ERR-50000">No summary was found for this file</error> <error line="13" code="PPC:ERR-50007">No summary for property $BACKGROUND_OPENED</error> <error line="14" code="PPC:ERR-50007">No summary for property $BG_DARK</error> <error line="15" code="PPC:ERR-50007">No summary for property $BG_DEFAULT</error> <error line="16" code="PPC:ERR-50007">No summary for property $BG_LIGHT</error> <error line="17" code="PPC:ERR-50007">No summary for property $BLINK</error> <error line="18" code="PPC:ERR-50007">No summary for property $DARK_SHADE</error> <error line="19" code="PPC:ERR-50007">No summary for property $FG_DARK</error> <error line="20" code="PPC:ERR-50007">No summary for property $FG_DEFAULT</error> <error line="21" code="PPC:ERR-50007">No summary for property $FG_LIGHT</error> <error line="22" code="PPC:ERR-50007">No summary for property $FOREGROUND_OPENED</error> <error line="23" code="PPC:ERR-50007">No summary for property $HIDDEN</error> <error line="24" code="PPC:ERR-50007">No summary for property $HIGHLIGHT</error> <error line="25" code="PPC:ERR-50007">No summary for property $LIGHT_SHADE</error> <error line="26" code="PPC:ERR-50007">No summary for property $UNDERLINE</error> <error line="27" code="PPC:ERR-50007">No summary for property $WEIGHT_HEAVY</error> <error line="28" code="PPC:ERR-50007">No summary for property $WEIGHT_LIGHT</error> <error line="29" code="PPC:ERR-50007">No summary for property $WEIGHT_NORMAL</error> <error line="31" code="PPC:ERR-50007">No summary for property $background</error> <error line="32" code="PPC:ERR-50007">No summary for property $blink</error> <error line="33" code="PPC:ERR-50007">No summary for property $foreground</error> <error line="34" code="PPC:ERR-50007">No summary for property $hidden</error> <error line="35" code="PPC:ERR-50007">No summary for property $highlight</error> <error line="36" code="PPC:ERR-50007">No summary for property $opened</error> <error line="37" code="PPC:ERR-50007">No summary for property $repeat</error> <error line="38" code="PPC:ERR-50007">No summary for property $shade</error> <error line="39" code="PPC:ERR-50007">No summary for property $string</error> <error line="40" code="PPC:ERR-50007">No summary for property $underline</error> <error line="41" code="PPC:ERR-50007">No summary for property $weight</error> </parse_markers> <source>eJzFW+tT20gS/+6/YirFHjKBwG6yj8SBXQheSC2BFEkudUUo11ge2zpkyaUHhMryv1/3PKTRjCTLErfhQ0g0079+9/Q88vr35XzZ6wV0weIldRn5zMbj5L9f3vieGw56vd2trR7ZIh/njPBP5CP7mhDXp3FMqO+HdzGZhhFJ8OuEuWFEEy+YiW9Ic/aWxMnkIk2eIQyHwqk0mJAxdW9mUZgGk5i4NCBjRtzQD9OITQYC8I55s3miBmMGdDF89H34jVAXwCIibDplbhKTOHXnOGHse8ENCLFN5kDuIwT/F/IEZiyCcfiAAu32hCYoU+9bj8BPnIAGLtk4Onzz18nlxafz49HF++H58Jjsk81c5M1BcfbJ6Pjw8i+Y82LPHhn+efjp7CMOvrQGz96enOLQj3sm4dnbcwT8ufgZ2Yw+nB4eD1GgCY1uDFH+zER5vmePZKI8f2kNKlFemnQXl0PLFOBhVmqK07fHx8NzmPKb+f3kVHH4tTjEP+dKcZcZqMB8eAkWwQkvikOfh5z8dHj47/+gIUtHFeefSkfPLy7fHZ7BMGjOx5eRd0sTRjZyjw+MAYwy41tuE2Ng7k0mLLA+yug0vodLFjATIWJLRpNcvWwgntMJM78lEQS48VGFvjlZJJnUm6c7/myRN2EAOKmbhJH6lA1BQobLxAsDKAH3PDEx2XnOhgHxgJAGiUdxxjNJpGj/WNKILsgHLqISVQ7uCslSsK1LpmngIgAZjVwlilMkA3MEqe/3OZlIX/zZSOZevHMg7AhzhLNfvbIDeWDScGvqJHm6SQvhjzd1pAT9nKuGgobIZuQ8HnriT9PSlwxdE6v6CTIjgGm3iCVpFJBGBktCYSjHMo0bTlgMCl5dD3R1vBic6EjxRUT0Td046dU1EBfmmfqVIeaJsRrVTKJ65Dw/VyObuWwhy3lZplQjZvGR1aV6SF4tGsDxol8PlZWNBnBZzV0FieWpER7Wdh0s+6sKT6grQTJ1ClBPvrCrH+LFDzH83ls82S4MeoulD5yczcHmtmTaL86AkB+J+qcEFkmwrRwrBvsZkZZzFSl36HvQKYRTMmf09v4zD2SZLHbKfcyzsTzhxlaeSUplX53JoEok3sbwQpoHqll5j70IJ01TgFftElmwZB5CE5WEhJaByHlWJW6sXoZk15OqUmu1T4NS21QZ44NcUqSGoNnYBylMcxjTHE1naEC1qmMirG8DJF7hZugkvVnwhsuiIlVI9o4unf7VJgfZvK4MgXf0huUrKa8Zu1NoUOftpQYIp2/5i38Hd8Giyro7JmUd/ZIBtFAwZd29krIapzxyqQh9O4taVAvbD+49DTr5QQNYWy2k7eoHxKjxw6eYEdzuKGVuaeRBlxmbOvMkKhZIwXrBYDaaw4sEkERoqzNiVBXE2j5ynXzLSgKUgUQqwlRF5yKU6o8UixAoYLkAtW1D6LGwqweCBzbSrdN61UAQZgdF3nWoRaOuQTd6kpw4F5kc6AByF2vQcc9MvOmUlMwlO4Vv6KmBTW2x3dkXkMW5eXv1wPyY1WprrZGV2mp5q2t7tIa2RyXaHq3QVmO7Utu1ojqrqbyR7VpTJ95iRe0psFkplFw124rDV+wVAkkWDXrBPOJUJrZpBrW47dgM5kjNm8GafXdZtOCfpkVO5EqGezN9lwxlqrp9aLBXnrEEVV7hLv1ApclaPIsY67YY6whr+4gTd12OOUjzZhX6mrbi2o2VFVPyJFiLKf3Ur+WSygX3glsv9sZ+6xZUbJ6rBBejrVrtvPHUObSTcFWTrFjUpWDRbtkxBLM2qZUTiQPWZlGi703xVD6LfZUccQddJbdqh8gJrXyiypDPglkyR+eYRalQc0zxvSBhMxbVaiCgq/wF8DCheA5S2zILXR+jZxZIHZvmWt9YXbN2MfCYbTMXojJq2/fNBdyu/bPImX+igX79Xfrnp9+nf379Xdrnlcp2WMFEXooVchfIgl1oiDtFXcu12DhpbnectKAzSDPaqXkqYqxtA0netYGSME2OloIwWlC/6z5IoKwQu8iqWYQJmt0Jm9LUV6HWTcqWISYuateLseHXJYs8LN7Uf2VotgB9vB317KBCpQbbiIh6wTi8s/XxWZLg3d4+v8WIl76XlC7efHIexiKskIxGEb0f3bD7uCTIdOI8I0ziiEHTFTOnHkrDQjmoO3cy6SFK/yX/Yd4Sia94E8vuuPMVVb9Y61zq+6M0ZtEIjTbisjhXcu42cdMoAg85tg3619vk6tpAk3R6jXVaMrTsVsow4JrZwsGCtE+mFJYq8jtEI7+ZLJn1il9Ul0Ha7MsgS2aZkNYSkl2s4b2a9OQa58mR3divVYSr82lliQDSrsUXIGoK76V4TZGVgWUE7UWU3JO7OUP2eAFc0sWLpwuyiVdvMlpox68yAUZBVFTB7M2HnNZuaaXA9TbzWaYpeIgf9Yqabp0tvcdnURsQe4e+L3dKSIJPPcYh7HyMG8bCLk712XgIpfDksXuRm2HYcRj6jAaK7dqGBbJjwcDJJeeJ1K2HJn//rWQqf++haV7sj+Vzq/rb9yad7UoRNF8Uu9YKEf7f91ywuIUl709a3HQVl++LNFmmsKODvIVd2pJiVbPOyYw8vfMmydzUoMGijizeCw6OAOHv9KxsDYVMxUc1EBPOhseflBH4/XqfKIwt8ryP354+NVyplt36dRoX4w3xoWzjIoThzzYctST35ZOkTbLZV2VFStMvLqE7B+JWa+fgm+TxYK6rj8JFHgPUsHnoVTF88iV40nTZE2QrVz1HO8Hpy9DISmV5dJU+YGueH9xSRYyqQxH11K3wrE9T+B+8acHd5aNetWRPrdrLlK4QSGPRbLeTEbTuX0ytLJ9mEx7pDcbd3EvY7ixiKljbtWwWzNqac4SuvRsHqenebP3vGT5F76R7AWJtvQV1V8UFSnPN6ytUtv6J2at1ki+CM6UK8vJ2VS47ZlDL19T7ZHMzj+RO55QK8hlgQh+lwXY/FtSxj4rYvRLp5aF0+al0DTSfVS24DZs/EalBxUnlEkvcbwXDPOjd4DcJ9ECeKldqj5qbVB78byAe1K6vWLvpLfV8OvazSxu+CxCNfpAuoGlzxe1sXJFVh9jn1Ieglh7lqXVVsJR8YUf2D8he8Q0p3xDi9x+N7+KaE0d+MkZkNuLQ822TTcr4wAtjQJ354djPxhh/34QDvxgDot7hyK/5yHXmg4f/ARKTPT4=</source> </file> <file path="Column.php" generated-path="Column.html" hash="fdb0c65c6060b5f9630cfd6ee046d847" package="Default"> <docblock line="0"> <description></description> <long-description></long-description> <tag name="package" line="0" description="Default"/> </docblock> <namespace-alias name="Text">\Webbtj\Clico\Text</namespace-alias> <class final="false" abstract="false" namespace="Webbtj\Clico" line="12" package="Default"> <extends/> <name>Column</name> <full_name>\Webbtj\Clico\Column</full_name> <docblock line="12"> <description>The Clico Column class is utilized by the Table and Row classes.</description> <long-description>It souldn't need to be accessed directly. It it used to fill Rows.</long-description> <tag name="package" line="12" description="Default"/> </docblock> <property static="false" visibility="private" namespace="Webbtj\Clico" line="14" package="Default"> <name>$height</name> <full_name>\Webbtj\Clico\Column::height</full_name> <default>1</default> <docblock line="14"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="15" package="Default"> <name>$lines</name> <full_name>\Webbtj\Clico\Column::lines</full_name> <default>array()</default> <docblock line="15"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="16" package="Default"> <name>$text</name> <full_name>\Webbtj\Clico\Column::text</full_name> <default>null</default> <docblock line="16"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="17" package="Default"> <name>$textWriter</name> <full_name>\Webbtj\Clico\Column::textWriter</full_name> <default></default> <docblock line="17"> <description></description> <long-description></long-description> </docblock> </property> <property static="false" visibility="private" namespace="Webbtj\Clico" line="18" package="Default"> <name>$width</name> <full_name>\Webbtj\Clico\Column::width</full_name> <default>0</default> <docblock line="18"> <description></description> <long-description></long-description> </docblock> </property> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="25" package="Default"> <name>__construct</name> <full_name>\Webbtj\Clico\Column::__construct()</full_name> <docblock line="25"> <description>Constructor. Sets the `$text` property on instantiation.</description> <long-description></long-description> <tag name="param" line="25" description="" type="String" variable="$text"> <type>String</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$text</name> <default></default> <type>String</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="36" package="Default"> <name>getHeight</name> <full_name>\Webbtj\Clico\Column::getHeight()</full_name> <docblock line="36"> <description>Gets the height of the column (number of lines)</description> <long-description></long-description> <tag name="return" line="36" description="" type="integer"> <type>integer</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="47" package="Default"> <name>getLine</name> <full_name>\Webbtj\Clico\Column::getLine()</full_name> <docblock line="47"> <description>Gets a single line</description> <long-description></long-description> <tag name="param" line="47" description="" type="integer" variable="$i"> <type>integer</type> </tag> <tag name="return" line="47" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$i</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="60" package="Default"> <name>getLines</name> <full_name>\Webbtj\Clico\Column::getLines()</full_name> <docblock line="60"> <description>Returns all of the lines of text, undecorated</description> <long-description></long-description> <tag name="return" line="60" description="" type="Array"> <type>Array</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="70" package="Default"> <name>getText</name> <full_name>\Webbtj\Clico\Column::getText()</full_name> <docblock line="70"> <description>Gets the undecorated text</description> <long-description></long-description> <tag name="return" line="70" description="" type="string"> <type>string</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="80" package="Default"> <name>getTextWriter</name> <full_name>\Webbtj\Clico\Column::getTextWriter()</full_name> <docblock line="80"> <description>Gets the Text class instance</description> <long-description></long-description> <tag name="return" line="80" description="" type="\Webbtj\Clico\Text"> <type>\Webbtj\Clico\Text</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="90" package="Default"> <name>getWidth</name> <full_name>\Webbtj\Clico\Column::getWidth()</full_name> <docblock line="90"> <description>Gets the width of the column in characters</description> <long-description></long-description> <tag name="return" line="90" description="" type="integer"> <type>integer</type> </tag> </docblock> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="101" package="Default"> <name>setText</name> <full_name>\Webbtj\Clico\Column::setText()</full_name> <docblock line="101"> <description>Sets the `$text` property</description> <long-description></long-description> <tag name="param" line="101" description="" type="String" variable="$text"> <type>String</type> </tag> <tag name="return" line="101" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$text</name> <default></default> <type>String</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="113" package="Default"> <name>setWidth</name> <full_name>\Webbtj\Clico\Column::setWidth()</full_name> <docblock line="113"> <description>Set the column width in characters</description> <long-description></long-description> <tag name="param" line="113" description="" type="integer" variable="$width"> <type>integer</type> </tag> <tag name="return" line="113" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$width</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="public" namespace="Webbtj\Clico" line="125" package="Default"> <name>verticalPad</name> <full_name>\Webbtj\Clico\Column::verticalPad()</full_name> <docblock line="125"> <description>Add additional blank lines to the end of the column</description> <long-description></long-description> <tag name="param" line="125" description="" type="integer" variable="$height"> <type>integer</type> </tag> <tag name="return" line="125" description="" type="void"> <type>void</type> </tag> </docblock> <argument line="0" by_reference="false"> <name>$height</name> <default></default> <type>integer</type> </argument> </method> <method final="false" abstract="false" static="false" visibility="private" namespace="Webbtj\Clico" line="138" package="Default"> <name>populateLines</name> <full_name>\Webbtj\Clico\Column::populateLines()</full_name> <docblock line="138"> <description>Split the `$text` property into substrings to fit within the set width</description> <long-description></long-description> <tag name="return" line="138" description="" type="void"> <type>void</type> </tag> </docblock> </method> </class> <parse_markers> <error line="0" code="PPC:ERR-50000">No summary was found for this file</error> <error line="14" code="PPC:ERR-50007">No summary for property $height</error> <error line="15" code="PPC:ERR-50007">No summary for property $lines</error> <error line="16" code="PPC:ERR-50007">No summary for property $text</error> <error line="17" code="PPC:ERR-50007">No summary for property $textWriter</error> <error line="18" code="PPC:ERR-50007">No summary for property $width</error> </parse_markers> <source>eJylVk1v2zgQvetXDAoDkVLHbvaapN2ih22BHorGQA5NkFISbXGXpgSSSpoW/u8dkpJN0/qwuwICxOR8vHlvOOT1u6qookiQNVUVySjc0TTV/95/4Cwrr6KoVvtL9wv6Q+P6/Pw8gnNYFBTsOnwoeb0WkHGiFDAFtWac/aQ5pC+g0WpBUk6BiBy+ls/OjKqZiWH+PmlQZc1zcaZBUPTSJaRonmUU7XLImaSZ5i8zY8k01MrZLBnnJqCNNI9cdgcl+hUBfpVkT0RTmBSUrQoNN3B5tb/BmaAK1789BBsaS8V1UXPesXMnmaYy2HhmuS7Q5w1SZDYsTeY7R1RCaVlnupQzuKVaWVq+21jfMUJZUalfoBTA0JAIzYhmpZg1/m2YvysiyRputWRi5ZA0W3MHpU5RD1jWIjPu8PiYtYlj3ymx1o4j8010wdTF211lpnL6DEbvOLkK7RTVdsfFctubg5r/actsyC+X9lfmeiUW9TrFRLhqNUjCUiXVtTR8aLqicrDMFdUfbY44LKwJ0uB2QAbxElDIEjarAdXNfoMIJizEuhjTA4F+xrgxhkD3ECxbxgwb3vBq4Vpevk3YQ5LsjKwMZgclOpDN/R+j4o8VyQ/iTFsP26kXl4knrc+WcdjtbHr4+mqtkTI8hY227jSZHwhjCrXIaVZKPBx5j7rvpSQvx1CmRqS1mUc70QME3uEJUSl7VMZgucMxiErbeTkCysRpR6c9/NlB453QX4ttMxyBzR9jAwjdYNs/vwzHfYHnIcMA6v+d3TsTfgSthdAHtHegHj0+t5CfSpYP4m1n35Hj1J7SbRd4m1VZ1RwbsWnugdJ81p0Sg9wHQ8p6/EmVThU7qWyMniLbS2/iKXR6me/zHEieM5OccEg5Ef810wQvekMAxcfDXgeO1O1m/cmFP2HbsIzwLzg+be0uTlj8c8E4jbOyFvvTOoHrrUsws/1Z/ICEnZ2FI9Yz275XJsN31m3Fme5+SyD6ElSdumGm3INJYwdhBmFdUGTw22OcrOals2UrULe7Q8InlvnwqvP7p+t+My6VpKtHZWqMX83jdzf3d6+T+aupf8CCK2yS1VJSYe+MgGTzLUtJSVbETQaiXK4gf4MQmeNUONsE3u53/AX81eHV1uah6LHq7Anf76rfbbjG9tt0rs7nlk+oKzDZgZc4xfwLL0y2lGS1xmxGD/OwcHJYUqaHlHRD2dK+C2aob3+dRFHrdGzRG8oV7VWq1dgXDF7DvvTXN8dqbyH78sxuwufUkdi6i/+T/hjKf8hW1P9rvLFPALwL3T/81uRHfDmFjjG7vUg2vwEXJACs</source> </file> <package name="Default" full_name="Default"/> <package name="global" full_name="global"/> <namespace name="Webbtj" full_name="Webbtj"> <namespace name="Clico" full_name="Webbtj\Clico"/> </namespace> <deprecated count="0"/> </project>