PHP Class Github

Inheritance: extends GitRepo
显示文件 Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property Type Description
$_bottom str Specifies 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.
$_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.
$_footer str The footer will be placed to the right of the lower navigation bar.
$_header str The header will be placed to the right of the upper navigation bar.
$_includeSource boolean Whether or not to parse the code with GeSHi and include the formatted files in the documentation.
$_rootDoc rootDoc A reference to the root doc.
$_tree str Create a class tree?
$_windowTitle str Specifies the title to be placed in the HTML tag.</td> <td class="actions"><a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_windowTitle" title="Direct link to property Github::_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/zh/class/-/Github#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/zh/method/-/Github/asCode/-" rel="nofollow" title="Source code of method Github::asCode"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-asCode" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/bottom/-" rel="nofollow" title="Source code of method Github::bottom"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-bottom" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/destinationPath/-" rel="nofollow" title="Source code of method Github::destinationPath"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-destinationPath" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/docTitle/-" rel="nofollow" title="Source code of method Github::docTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-docTitle" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/formatLink/-" rel="nofollow" title="Source code of method Github::formatLink"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-formatLink" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/getFooter/-" rel="nofollow" title="Source code of method Github::getFooter"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-getFooter" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/getHeader/-" rel="nofollow" title="Source code of method Github::getHeader"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-getHeader" title="Direct link to the method Github::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/zh/class/-/Github#method-github">github</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/zh/method/-/Github/github/-" rel="nofollow" title="Source code of method Github::github"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-github" title="Direct link to the method Github::github 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/zh/class/-/Github#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/zh/method/-/Github/includeSource/-" rel="nofollow" title="Source code of method Github::includeSource"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-includeSource" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/phpdoctor/-" rel="nofollow" title="Source code of method Github::phpdoctor"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-phpdoctor" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/rootDoc/-" rel="nofollow" title="Source code of method Github::rootDoc"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-rootDoc" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/tree/-" rel="nofollow" title="Source code of method Github::tree"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-tree" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/version/-" rel="nofollow" title="Source code of method Github::version"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-version" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/windowTitle/-" rel="nofollow" title="Source code of method Github::windowTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-windowTitle" title="Direct link to the method Github::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/zh/method/-/Github/asCode/-" rel="nofollow" title="Source code of method Github::asCode"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-asCode" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/bottom/-" rel="nofollow" title="Source code of method Github::bottom"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-bottom" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/destinationPath/-" rel="nofollow" title="Source code of method Github::destinationPath"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-destinationPath" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/docTitle/-" rel="nofollow" title="Source code of method Github::docTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-docTitle" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/formatLink/-" rel="nofollow" title="Source code of method Github::formatLink"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-formatLink" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/getFooter/-" rel="nofollow" title="Source code of method Github::getFooter"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-getFooter" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/getHeader/-" rel="nofollow" title="Source code of method Github::getHeader"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-getHeader" title="Direct link to the method Github::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/zh/class/-/Github#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-github"> <div class="row"> <div class="col-md-6"> <h3> github() <span class="modifier">public</span > <span>method</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://src.hotexamples.com/zh/method/-/Github/github/-" rel="nofollow" title="Source code of method Github::github"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-github" title="Direct link to the method Github::github 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/zh/class/-/Github#method-github">github</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-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/zh/method/-/Github/includeSource/-" rel="nofollow" title="Source code of method Github::includeSource"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-includeSource" title="Direct link to the method Github::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/zh/class/-/Github#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-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/zh/method/-/Github/phpdoctor/-" rel="nofollow" title="Source code of method Github::phpdoctor"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-phpdoctor" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/rootDoc/-" rel="nofollow" title="Source code of method Github::rootDoc"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-rootDoc" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/tree/-" rel="nofollow" title="Source code of method Github::tree"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-tree" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/version/-" rel="nofollow" title="Source code of method Github::version"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-version" title="Direct link to the method Github::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/zh/class/-/Github#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/zh/method/-/Github/windowTitle/-" rel="nofollow" title="Source code of method Github::windowTitle"><i class='icon-borderless icon-eye'></i></a> <a rel="nofollow" href="https://doc.hotexamples.com/zh/class/-/Github#method-windowTitle" title="Direct link to the method Github::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/zh/class/-/Github#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-_bottom"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_bottom <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_bottom" title="Direct link to property Github::_bottom documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> Specifies 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"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_bottom</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> <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/zh/class/-/Github#prop-_d" title="Direct link to property Github::_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/zh/class/-/Github#prop-_docTitle" title="Direct link to property Github::_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-_footer"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_footer <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_footer" title="Direct link to property Github::_footer 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"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_footer</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> <div class="property-descr-full" id="prop-_header"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_header <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_header" title="Direct link to property Github::_header 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"></td> </tr> --> <tr> <td colspan="3" class="rendered"> <span class="modifier">public</span > <span class="return-type">str</span> <span class="var-name">$_header</span> </td> </tr> <tr> <td>return</td> <td>str</td> <td></td> </tr> </table> </div> </div> </div> <div class="property-descr-full" id="prop-_includeSource"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_includeSource <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_includeSource" title="Direct link to property Github::_includeSource documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> Whether or not to parse the code with GeSHi and include the formatted files in the documentation. </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">bool</span> <span class="var-name">$_includeSource</span> </td> </tr> <tr> <td>return</td> <td><a href="http://php.net/manual/en/language.types.boolean.php">boolean</a></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/zh/class/-/Github#prop-_rootDoc" title="Direct link to property Github::_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-_tree"> <div class="row"> <div class="col-md-6"> <h3 class="name">$_tree <span>public_oe property</span> </h3> </div> <div class="col-md-6 actions"> <a href="https://doc.hotexamples.com/zh/class/-/Github#prop-_tree" title="Direct link to property Github::_tree documentation"> <i class='icon-borderless icon-link'></i> </a> </div> </div> <div class="row"> <div class="col-md-12"> Create a class tree? </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">$_tree</span> </td> </tr> <tr> <td>return</td> <td>str</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/zh/class/-/Github#prop-_windowTitle" title="Direct link to property Github::_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/zh/site/trends?type=php%7Cf">热门功能</a> | <a href="https://hotexamples.com/zh/site/trends?type=php%7Cc"> 热门类 </a> | <a href="https://doc.hotexamples.com/zh/doc/map">文档</a> | <a href="/site/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/zh/">PHP</a> | <a href="https://csharp.hotexamples.com/zh/">C# (CSharp)</a> | <a href="https://java.hotexamples.com/zh/">Java</a> | <a href="https://golang.hotexamples.com/zh/">Golang</a> | <a href="https://cpp.hotexamples.com/zh/">C++ (Cpp)</a> | <a href="https://python.hotexamples.com/zh/">Python</a> | <a href="https://javascript.hotexamples.com/zh/">JavaScript</a> | <a href="https://typescript.hotexamples.com/zh/">TypeScript</a> </div> </div> <div class="row"> <div class="col-md-12" style="text-align: center"> <a href="https://doc.hotexamples.com/class/-/Github">EN</a> | <a href="https://doc.hotexamples.com/ru/class/-/Github">RU</a> | <a href="https://doc.hotexamples.com/de/class/-/Github">DE</a> | <a href="https://doc.hotexamples.com/fr/class/-/Github">FR</a> | <a href="https://doc.hotexamples.com/es/class/-/Github">ES</a> | <a href="https://doc.hotexamples.com/pt/class/-/Github">PT</a> | <a href="https://doc.hotexamples.com/it/class/-/Github">IT</a> | <a href="https://doc.hotexamples.com/jp/class/-/Github">JP</a> | <a href="https://doc.hotexamples.com/zh/class/-/Github">ZH</a> | <a href="https://doc.hotexamples.com/ko/class/-/Github">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 cannot be blank."});}}], []); });</script></body> </html>