PHP Class Modern

Mostra file Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property Type Description
$_d str The directory to place the generated files.
$_docTitle str Specifies the title to be placed near the top of the overview summary file.
$_rootDoc rootDoc A reference to the root doc.
$_windowTitle str Specifies the title to be placed in the HTML tag.</td> <td class="actions"><a href="https://doc.hotexamples.com/it/class/-/Modern#prop-_windowTitle" title="Direct link to property Modern::_windowTitle documentation"> <i class='icon-borderless icon-link'></i> </a> </td> </tr> </table> <h2>Public Methods</h2> <table class="table table-striped"> <tr> <th>Method</th> <th>Description</th> <th></th> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-asCode">asCode</a></span> ( <span class="param-name">$text</span> ) : <span class="return-type">str</span> </td> <td> Format text as a piece of code </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/asCode/-" rel="nofollow" title="Source code of method Modern::asCode"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-asCode" title="Direct link to the method Modern::asCode documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-bottom">bottom</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/bottom/-" rel="nofollow" title="Source code of method Modern::bottom"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-bottom" title="Direct link to the method Modern::bottom documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-destinationPath">destinationPath</a></span> ( ) : <span class="return-type">str</span> </td> <td> Get the destination path to write the doclet output to. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/destinationPath/-" rel="nofollow" title="Source code of method Modern::destinationPath"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-destinationPath" title="Direct link to the method Modern::destinationPath documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-docTitle">docTitle</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the title to be placed near the top of the overview summary file. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/docTitle/-" rel="nofollow" title="Source code of method Modern::docTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-docTitle" title="Direct link to the method Modern::docTitle documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-formatLink">formatLink</a></span> ( <span class="param-name">$url</span>, <span class="param-name">$text</span> ) </td> <td> Format a URL link </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/formatLink/-" rel="nofollow" title="Source code of method Modern::formatLink"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-formatLink" title="Direct link to the method Modern::formatLink documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-getFooter">getFooter</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the footer text to be placed at the bottom of each output file. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/getFooter/-" rel="nofollow" title="Source code of method Modern::getFooter"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-getFooter" title="Direct link to the method Modern::getFooter documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-getHeader">getHeader</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the header text to be placed at the top of each output file. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/getHeader/-" rel="nofollow" title="Source code of method Modern::getHeader"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-getHeader" title="Direct link to the method Modern::getHeader documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-includeSource">includeSource</a></span> ( ) : <span class="return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></span> </td> <td> Should we be outputting the source code? </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/includeSource/-" rel="nofollow" title="Source code of method Modern::includeSource"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-includeSource" title="Direct link to the method Modern::includeSource documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-modern">modern</a></span> ( &<span class="param-name">$rootDoc</span>, <span class="param-name">$formatter</span> ) </td> <td> Doclet constructor. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/modern/-" rel="nofollow" title="Source code of method Modern::modern"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-modern" title="Direct link to the method Modern::modern documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-phpdoctor">phpdoctor</a></span> ( ) : <span class="return-type">PHPDoctor</span> </td> <td> Return a reference to the application object. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/phpdoctor/-" rel="nofollow" title="Source code of method Modern::phpdoctor"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-phpdoctor" title="Direct link to the method Modern::phpdoctor documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-rootDoc">rootDoc</a></span> ( ) : <span class="return-type">RootDoc</span> </td> <td> Return a reference to the root doc. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/rootDoc/-" rel="nofollow" title="Source code of method Modern::rootDoc"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-rootDoc" title="Direct link to the method Modern::rootDoc documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-tree">tree</a></span> ( ) : <span class="return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></span> </td> <td> Return whether to create a class tree or not. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/tree/-" rel="nofollow" title="Source code of method Modern::tree"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-tree" title="Direct link to the method Modern::tree documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-version">version</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the version of PHPDoctor. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/version/-" rel="nofollow" title="Source code of method Modern::version"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-version" title="Direct link to the method Modern::version documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> <tr class="method-descr"> <td> <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-windowTitle">windowTitle</a></span> ( ) : <span class="return-type">str</span> </td> <td> Return the title to be placed in the HTML <title> tag. </td> <td class="actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/windowTitle/-" rel="nofollow" title="Source code of method Modern::windowTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-windowTitle" title="Direct link to the method Modern::windowTitle documentation"><i class='icon-borderless icon-link'></i></a> </td> </tr> </table> <h2>Method Details</h2> <div class="method-descr-full" id="method-asCode"> <div class="row"> <div class="col-md-6"> <h3> asCode() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/asCode/-" rel="nofollow" title="Source code of method Modern::asCode"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-asCode" title="Direct link to the method Modern::asCode documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Format text as a piece of code </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-asCode">asCode</a></span> ( <span class="param-name">$text</span> ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-bottom"> <div class="row"> <div class="col-md-6"> <h3> bottom() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/bottom/-" rel="nofollow" title="Source code of method Modern::bottom"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-bottom" title="Direct link to the method Modern::bottom documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-bottom">bottom</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-destinationPath"> <div class="row"> <div class="col-md-6"> <h3> destinationPath() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/destinationPath/-" rel="nofollow" title="Source code of method Modern::destinationPath"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-destinationPath" title="Direct link to the method Modern::destinationPath documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Get the destination path to write the doclet output to. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-destinationPath">destinationPath</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-docTitle"> <div class="row"> <div class="col-md-6"> <h3> docTitle() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/docTitle/-" rel="nofollow" title="Source code of method Modern::docTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-docTitle" title="Direct link to the method Modern::docTitle documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return the title to be placed near the top of the overview summary file. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-docTitle">docTitle</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-formatLink"> <div class="row"> <div class="col-md-6"> <h3> formatLink() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/formatLink/-" rel="nofollow" title="Source code of method Modern::formatLink"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-formatLink" title="Direct link to the method Modern::formatLink documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Format a URL link </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-formatLink">formatLink</a></span> ( <span class="param-name">$url</span>, <span class="param-name">$text</span> ) </td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-getFooter"> <div class="row"> <div class="col-md-6"> <h3> getFooter() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/getFooter/-" rel="nofollow" title="Source code of method Modern::getFooter"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-getFooter" title="Direct link to the method Modern::getFooter documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> The footer will be placed to the right of the lower navigation bar. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-getFooter">getFooter</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-getHeader"> <div class="row"> <div class="col-md-6"> <h3> getHeader() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/getHeader/-" rel="nofollow" title="Source code of method Modern::getHeader"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-getHeader" title="Direct link to the method Modern::getHeader documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> The header will be placed to the right of the upper navigation bar. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-getHeader">getHeader</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-includeSource"> <div class="row"> <div class="col-md-6"> <h3> includeSource() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/includeSource/-" rel="nofollow" title="Source code of method Modern::includeSource"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-includeSource" title="Direct link to the method Modern::includeSource documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Should we be outputting the source code? </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-includeSource">includeSource</a></span> ( ) : <span class="return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-modern"> <div class="row"> <div class="col-md-6"> <h3> modern() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/modern/-" rel="nofollow" title="Source code of method Modern::modern"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-modern" title="Direct link to the method Modern::modern documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Doclet constructor. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-modern">modern</a></span> ( &<span class="param-name">$rootDoc</span>, <span class="param-name">$formatter</span> ) </td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-phpdoctor"> <div class="row"> <div class="col-md-6"> <h3> phpdoctor() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/phpdoctor/-" rel="nofollow" title="Source code of method Modern::phpdoctor"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-phpdoctor" title="Direct link to the method Modern::phpdoctor documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return a reference to the application object. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-phpdoctor">phpdoctor</a></span> ( ) : <span class="return-type">PHPDoctor</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">PHPDoctor</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-rootDoc"> <div class="row"> <div class="col-md-6"> <h3> rootDoc() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/rootDoc/-" rel="nofollow" title="Source code of method Modern::rootDoc"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-rootDoc" title="Direct link to the method Modern::rootDoc documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return a reference to the root doc. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-rootDoc">rootDoc</a></span> ( ) : <span class="return-type">RootDoc</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">RootDoc</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-tree"> <div class="row"> <div class="col-md-6"> <h3> tree() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/tree/-" rel="nofollow" title="Source code of method Modern::tree"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-tree" title="Direct link to the method Modern::tree documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return whether to create a class tree or not. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-tree">tree</a></span> ( ) : <span class="return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type"><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-version"> <div class="row"> <div class="col-md-6"> <h3> version() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/version/-" rel="nofollow" title="Source code of method Modern::version"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-version" title="Direct link to the method Modern::version documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return the version of PHPDoctor. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-version">version</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-descr-full" id="method-windowTitle"> <div class="row"> <div class="col-md-6"> <h3> windowTitle() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/it/method/-/Modern/windowTitle/-" rel="nofollow" title="Source code of method Modern::windowTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/it/class/-/Modern#method-windowTitle" title="Direct link to the method Modern::windowTitle documentation"><i class='icon-borderless icon-link'></i></a> </div> </div> <div class="row"> <div class="col-md-12"> Return the title to be placed in the HTML <title> tag. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="method-name"><a class="method-link" href="https://doc.hotexamples.com/it/class/-/Modern#method-windowTitle">windowTitle</a></span> ( ) : <span class="return-type">str</span> </td> </tr> <tr> <td class="field-return">return</td> <td class="field-return-type">str</td> <td></td> </tr> </table> </div> </div> </div> <h2>Property Details</h2> <div class="property-descr-full" id="prop-_d"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_d <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/it/class/-/Modern#prop-_d" title="Direct link to property Modern::_d documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> The directory to place the generated files. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <!-- <tr> <td colspan="3"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_d</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> <div class="property-descr-full" id="prop-_docTitle"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_docTitle <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/it/class/-/Modern#prop-_docTitle" title="Direct link to property Modern::_docTitle documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> Specifies the title to be placed near the top of the overview summary file. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <!-- <tr> <td colspan="3"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_docTitle</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> <div class="property-descr-full" id="prop-_rootDoc"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_rootDoc <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/it/class/-/Modern#prop-_rootDoc" title="Direct link to property Modern::_rootDoc documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> A reference to the root doc. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <!-- <tr> <td colspan="3"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">rootDoc</span> <span class="var-name">$_rootDoc</span> </td> </tr> <tr> <td>return</td> <td>rootDoc</td> <td></td> </tr> </table> </div> </div> </div> <div class="property-descr-full" id="prop-_windowTitle"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_windowTitle <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/it/class/-/Modern#prop-_windowTitle" title="Direct link to property Modern::_windowTitle documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> Specifies the title to be placed in the HTML <title> tag. </div> </div> <div class="row doc-tags"> <div class="col-md-12"> <div class="tag-block tag-summary"> </div> <div class="tag-block tag-remarks"> </div> <div class="tag-block tag-exception"> </div> <div class="tag-block tag-see"> </div> <div class="tag-block tag-link"> </div> <div class="tag-block tag-deprecated"> </div> <div class="tag-block tag-since"> </div> <div class="tag-block tag-author"> </div> </div> </div> <div class="row"> <div class="col-md-12" style="overflow: auto"> <table class="table table-striped"> <!-- <tr> <td colspan="3"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_windowTitle</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> </div> </div> </div></div> <footer class="footer"> <div class="container"> <div class="row"> <div class="col-md-12" style="text-align: center"> <a href="https://hotexamples.com/it/site/trends?type=php%7Cf">Funzioni principali</a> | <a href="https://hotexamples.com/it/site/trends?type=php%7Cc"> Classi principali </a> | <a href="https://doc.hotexamples.com/it/doc/map">Documentazione</a> | <a href="/site/privacy">Informativa sulla privacy</a> | <a href="https://cpp.hotexamples.com/direct-sales.html">Advertise with us</a> </div> </div> <div class="row"> <div class="col-md-12" style="text-align: center"> <a href="https://hotexamples.com/it/">PHP</a> | <a href="https://csharp.hotexamples.com/it/">C# (CSharp)</a> | <a href="https://java.hotexamples.com/it/">Java</a> | <a href="https://golang.hotexamples.com/it/">Golang</a> | <a href="https://cpp.hotexamples.com/it/">C++ (Cpp)</a> | <a href="https://python.hotexamples.com/it/">Python</a> | <a href="https://javascript.hotexamples.com/it/">JavaScript</a> | <a href="https://typescript.hotexamples.com/it/">TypeScript</a> </div> </div> <div class="row"> <div class="col-md-12" style="text-align: center"> <a href="https://doc.hotexamples.com/class/-/Modern">EN</a> | <a href="https://doc.hotexamples.com/ru/class/-/Modern">RU</a> | <a href="https://doc.hotexamples.com/de/class/-/Modern">DE</a> | <a href="https://doc.hotexamples.com/fr/class/-/Modern">FR</a> | <a href="https://doc.hotexamples.com/es/class/-/Modern">ES</a> | <a href="https://doc.hotexamples.com/pt/class/-/Modern">PT</a> | <a href="https://doc.hotexamples.com/it/class/-/Modern">IT</a> | <a href="https://doc.hotexamples.com/jp/class/-/Modern">JP</a> | <a href="https://doc.hotexamples.com/zh/class/-/Modern">ZH</a> | <a href="https://doc.hotexamples.com/ko/class/-/Modern">KO</a> </div> </div> <div class="row"> <div class="col-md-10 col-md-offset-1"> </div> <div class="col-md-1"> <!--LiveInternet counter--> <script type="text/javascript"><!-- document.write("<a href='//www.liveinternet.ru/click' " + "target=_blank><img src='//counter.yadro.ru/hit?t44.6;r" + escape(document.referrer) + ((typeof (screen) == "undefined") ? "" : ";s" + screen.width + "*" + screen.height + "*" + (screen.colorDepth ? screen.colorDepth : screen.pixelDepth)) + ";u" + escape(document.URL) + ";" + Math.random() + "' alt='' title='LiveInternet' " + "border='0' width='31' height='31'><\/a>"); //--></script><!--/LiveInternet--> </div> </div> </div> </footer> <script src="//ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script src="/assets/30dd86a6f06b64184847037c52c63e07aa3c9a26.js"></script> <script>jQuery(function ($) { jQuery('#search-form').yiiActiveForm([{"id":"searchform-lang","name":"lang","container":".field-searchform-lang","input":"#searchform-lang","enableAjaxValidation":true},{"id":"searchform-search","name":"search","container":".field-searchform-search","input":"#searchform-search","enableAjaxValidation":true,"validate":function (attribute, value, messages, deferred, $form) {yii.validation.required(value, messages, {"message":"Search non può essere vuoto."});}}], []); });</script></body> </html>