mirror of
https://github.com/pierre42100/comunic
synced 2024-09-29 03:22:49 +00:00
544 lines
29 KiB
HTML
Executable File
544 lines
29 KiB
HTML
Executable File
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<title>Luminous: LuminousOptions Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Luminous
|
|
 <span id="projectnumber">git-master</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.1.2 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classLuminousOptions-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LuminousOptions Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Options class.
|
|
<a href="classLuminousOptions.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ab93ed5304452028701c1a7d216e0935b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab93ed5304452028701c1a7d216e0935b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>__get</b> ($name)</td></tr>
|
|
<tr class="memitem:acdf6ab45200157d952c12b144fd1e3d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdf6ab45200157d952c12b144fd1e3d8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>__set</b> ($name, $value)</td></tr>
|
|
<tr class="memitem:a60b1031aeda5fd4fe1a50ac4c04dcfa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60b1031aeda5fd4fe1a50ac4c04dcfa1"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>LuminousOptions</b> ($opts=null)</td></tr>
|
|
<tr class="memitem:a6cdd73174a150c31b76e95e44f928371"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cdd73174a150c31b76e95e44f928371"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set</b> ($nameOrArray, $value=null)</td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2><a name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a94bd8eb6b7e34c1545c1566756237843"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94bd8eb6b7e34c1545c1566756237843"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_bool</b> ($key, $value)</td></tr>
|
|
<tr class="memitem:abb6497b127a0ecb880047bd403a39467"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb6497b127a0ecb880047bd403a39467"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_format</b> ($value)</td></tr>
|
|
<tr class="memitem:adc102dcaacbf1b07a72371ce0ea1e6f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc102dcaacbf1b07a72371ce0ea1e6f4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_height</b> ($value)</td></tr>
|
|
<tr class="memitem:a6f3f96fcaf08e4bb8528d080864ea904"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f3f96fcaf08e4bb8528d080864ea904"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_start_line</b> ($value)</td></tr>
|
|
<tr class="memitem:a53eca04faeaf5aa02ff70417364a9e68"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53eca04faeaf5aa02ff70417364a9e68"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_string</b> ($key, $value, $nullable=false)</td></tr>
|
|
<tr class="memitem:acbfacef6b12cf7d4abedc1138d64b9fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbfacef6b12cf7d4abedc1138d64b9fb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>set_theme</b> ($value)</td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2><a name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a90f18707e15a1043a96d04f8ecf2c77b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90f18707e15a1043a96d04f8ecf2c77b"></a>
|
|
static </td><td class="memItemRight" valign="bottom"><b>check_type</b> ($value, $type, $nullable=false)</td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a1408903d6d4fb2251935576f07ad984c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a1408903d6d4fb2251935576f07ad984c">$auto_link</a> = true</td></tr>
|
|
<tr class="memdesc:a1408903d6d4fb2251935576f07ad984c"><td class="mdescLeft"> </td><td class="mdescRight">Hyperlinking. <a href="#a1408903d6d4fb2251935576f07ad984c"></a><br/></td></tr>
|
|
<tr class="memitem:acbbe98bf278f669a047aa3fafc63f00e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbbe98bf278f669a047aa3fafc63f00e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#acbbe98bf278f669a047aa3fafc63f00e">$cache</a> = true</td></tr>
|
|
<tr class="memdesc:acbbe98bf278f669a047aa3fafc63f00e"><td class="mdescLeft"> </td><td class="mdescRight">Whether to use the built-in cache. <br/></td></tr>
|
|
<tr class="memitem:a40a7a05710c6e07ffc2670dff2dc4f99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a40a7a05710c6e07ffc2670dff2dc4f99">$cache_age</a> = 7776000</td></tr>
|
|
<tr class="memdesc:a40a7a05710c6e07ffc2670dff2dc4f99"><td class="mdescLeft"> </td><td class="mdescRight">Maximum age of cache files in seconds. <a href="#a40a7a05710c6e07ffc2670dff2dc4f99"></a><br/></td></tr>
|
|
<tr class="memitem:a4dd6a94185818e0ce25382ac380dede8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a4dd6a94185818e0ce25382ac380dede8">$failure_tag</a> = 'pre'</td></tr>
|
|
<tr class="memdesc:a4dd6a94185818e0ce25382ac380dede8"><td class="mdescLeft"> </td><td class="mdescRight">Failure recovery. <a href="#a4dd6a94185818e0ce25382ac380dede8"></a><br/></td></tr>
|
|
<tr class="memitem:a9ca11e80317fb5a8d2d4cc45a775f0f1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a9ca11e80317fb5a8d2d4cc45a775f0f1">$format</a> = 'html'</td></tr>
|
|
<tr class="memdesc:a9ca11e80317fb5a8d2d4cc45a775f0f1"><td class="mdescLeft"> </td><td class="mdescRight">Output format. <a href="#a9ca11e80317fb5a8d2d4cc45a775f0f1"></a><br/></td></tr>
|
|
<tr class="memitem:a90ef29c5d273d023c501a1cd1f50f4de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a90ef29c5d273d023c501a1cd1f50f4de">$highlight_lines</a> = array()</td></tr>
|
|
<tr class="memdesc:a90ef29c5d273d023c501a1cd1f50f4de"><td class="mdescLeft"> </td><td class="mdescRight">Highlighting of lines. <a href="#a90ef29c5d273d023c501a1cd1f50f4de"></a><br/></td></tr>
|
|
<tr class="memitem:abf723d25b5f09ae6354998967477f6ac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#abf723d25b5f09ae6354998967477f6ac">$html_strict</a> = false</td></tr>
|
|
<tr class="memdesc:abf723d25b5f09ae6354998967477f6ac"><td class="mdescLeft"> </td><td class="mdescRight">HTML strict standards mode. <a href="#abf723d25b5f09ae6354998967477f6ac"></a><br/></td></tr>
|
|
<tr class="memitem:a45fe559dc1ab53dd722c466652848b0c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a45fe559dc1ab53dd722c466652848b0c">$include_javascript</a> = false</td></tr>
|
|
<tr class="memdesc:a45fe559dc1ab53dd722c466652848b0c"><td class="mdescLeft"> </td><td class="mdescRight">JavaScript extras. <a href="#a45fe559dc1ab53dd722c466652848b0c"></a><br/></td></tr>
|
|
<tr class="memitem:ad2127af1b05b4c02a02a03509cd42ba9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#ad2127af1b05b4c02a02a03509cd42ba9">$include_jquery</a> = false</td></tr>
|
|
<tr class="memdesc:ad2127af1b05b4c02a02a03509cd42ba9"><td class="mdescLeft"> </td><td class="mdescRight">jQuery <a href="#ad2127af1b05b4c02a02a03509cd42ba9"></a><br/></td></tr>
|
|
<tr class="memitem:a053180f6c41b62a4e0742a000655aea9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a053180f6c41b62a4e0742a000655aea9">$line_numbers</a> = true</td></tr>
|
|
<tr class="memdesc:a053180f6c41b62a4e0742a000655aea9"><td class="mdescLeft"> </td><td class="mdescRight">Line numbering. <a href="#a053180f6c41b62a4e0742a000655aea9"></a><br/></td></tr>
|
|
<tr class="memitem:a30027aaad70cc92226e871c4c6c4824a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a30027aaad70cc92226e871c4c6c4824a">$max_height</a> = -1</td></tr>
|
|
<tr class="memdesc:a30027aaad70cc92226e871c4c6c4824a"><td class="mdescLeft"> </td><td class="mdescRight">Widget height constraint. <a href="#a30027aaad70cc92226e871c4c6c4824a"></a><br/></td></tr>
|
|
<tr class="memitem:a7cb3de376e2f841d98ba0e20c177a3aa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a7cb3de376e2f841d98ba0e20c177a3aa">$relative_root</a> = null</td></tr>
|
|
<tr class="memdesc:a7cb3de376e2f841d98ba0e20c177a3aa"><td class="mdescLeft"> </td><td class="mdescRight">Location of Luminous relative to your document root. <a href="#a7cb3de376e2f841d98ba0e20c177a3aa"></a><br/></td></tr>
|
|
<tr class="memitem:acf2a3ca0e41e847db7fc4e30e7c4608f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#acf2a3ca0e41e847db7fc4e30e7c4608f">$sql_function</a> = null</td></tr>
|
|
<tr class="memdesc:acf2a3ca0e41e847db7fc4e30e7c4608f"><td class="mdescLeft"> </td><td class="mdescRight">Defines an SQL function which can execute queries on a database. <a href="#acf2a3ca0e41e847db7fc4e30e7c4608f"></a><br/></td></tr>
|
|
<tr class="memitem:a49151dba0f00d1357fba1b1c68096eb5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a49151dba0f00d1357fba1b1c68096eb5">$start_line</a> = 1</td></tr>
|
|
<tr class="memdesc:a49151dba0f00d1357fba1b1c68096eb5"><td class="mdescLeft"> </td><td class="mdescRight">Line number of first line. <a href="#a49151dba0f00d1357fba1b1c68096eb5"></a><br/></td></tr>
|
|
<tr class="memitem:a4fc507972ad86defd3bcd0c4f721e44b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a4fc507972ad86defd3bcd0c4f721e44b">$theme</a> = 'luminous_light.css'</td></tr>
|
|
<tr class="memdesc:a4fc507972ad86defd3bcd0c4f721e44b"><td class="mdescLeft"> </td><td class="mdescRight">Theme. <a href="#a4fc507972ad86defd3bcd0c4f721e44b"></a><br/></td></tr>
|
|
<tr class="memitem:a7547828a8a6fbf02ffe6015d1f0cfb6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7547828a8a6fbf02ffe6015d1f0cfb6d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$verbose</b> = true</td></tr>
|
|
<tr class="memitem:a2d5811ef7a32a459d55de9e211c324c9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousOptions.html#a2d5811ef7a32a459d55de9e211c324c9">$wrap_width</a> = -1</td></tr>
|
|
<tr class="memdesc:a2d5811ef7a32a459d55de9e211c324c9"><td class="mdescLeft"> </td><td class="mdescRight">Word wrapping. <a href="#a2d5811ef7a32a459d55de9e211c324c9"></a><br/></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>Options class. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This object's structure isn't guaranteed to be stable so don't read or write these directly. As a user, you should be using <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">luminous::set()</a> and <a class="el" href="classluminous.html#af5888c20eb26757b5bd9af198e44ec96" title="Gets a setting's value.">luminous::setting()</a></dd></dl>
|
|
<p>We use a fair bit of PHP trickery in the implementation here. The keener among you will notice that the options are all private: don't worry about that. We override the __set() method to apply option specific validation. Options can be written to as normal.</p>
|
|
<p>The option variable names correspond with option strings that can be passed through <a class="el" href="classluminous.html#ace722a2ba2c2251eabccf6f0d18bcbe9" title="Sets the given option to the given value.">luminous::set()</a>, however, for historical reasons, underscores can be replaced with dashed in the call. </p>
|
|
</div><h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="a1408903d6d4fb2251935576f07ad984c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$auto_link = true</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hyperlinking. </p>
|
|
<p>If the formatter supports hyper-linking, this setting controls whether or not URLs will be automatically linked </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a40a7a05710c6e07ffc2670dff2dc4f99"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$cache_age = 7776000</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Maximum age of cache files in seconds. </p>
|
|
<p>Cache files which have not been read for this length of time will be removed from the file system. The file's 'mtime' is used to calculate when it was last used, and a cache hit triggers a 'touch'</p>
|
|
<p>Set to -1 or 0 to disable cache purges </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4dd6a94185818e0ce25382ac380dede8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$failure_tag = 'pre'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Failure recovery. </p>
|
|
<p>If Luminous hits some kind of unrecoverable internal error, it should return the input source code back to you. If you want, it can be wrapped in an HTML tag. Hopefully you will never see this. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9ca11e80317fb5a8d2d4cc45a775f0f1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$format = 'html'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Output format. </p>
|
|
<p>Chooses which output format to use. Current valid settings are: </p>
|
|
<ul>
|
|
<li>'html' - standard HTML element, contained in a <div> with class 'luminous', CSS is not included and must be included on the page separately (probably with <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>) </li>
|
|
<li>'html-full' - A complete HTML document. CSS is included. </li>
|
|
<li>'html-inline' - Very similar to 'html' but geared towards inline display. Probably not very useful. </li>
|
|
<li>'latex' - A full LaTeX document </li>
|
|
<li>'none' or <code>NULL</code> - No formatter. Internal XML format is returned. You probably don't want this. </li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a90ef29c5d273d023c501a1cd1f50f4de"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$highlight_lines = array()</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Highlighting of lines. </p>
|
|
<p>If the formatter supports highlighting lines, this setting allows the caller to specify the set of line numbers to highlight </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abf723d25b5f09ae6354998967477f6ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$html_strict = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HTML strict standards mode. </p>
|
|
<p>The HTML4-strict doctype disallows a few things which are technically useful. Set this to true if you don't want Luminous to break validation on your HTML4-strict document. Luminous should be valid HTML4 loose/transitional and HTML5 without needing to enable this. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a45fe559dc1ab53dd722c466652848b0c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$include_javascript = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>JavaScript extras. </p>
|
|
<p>controls whether <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a> outputs the javascript 'extras'. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad2127af1b05b4c02a02a03509cd42ba9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$include_jquery = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>jQuery </p>
|
|
<p>Controls whether <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a> outputs jQuery, which is required for the JavaScript extras. This has no effect if $include_javascript is false. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a053180f6c41b62a4e0742a000655aea9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$line_numbers = true</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Line numbering. </p>
|
|
<p>If the formatter supports line numbering, this setting controls whether or not lines should be numbered </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30027aaad70cc92226e871c4c6c4824a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$max_height = -1</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Widget height constraint. </p>
|
|
<p>If the formatter supports heigh constraint, this setting controls whether or not to constrain the widget's height, and to what. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7cb3de376e2f841d98ba0e20c177a3aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$relative_root = null</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Location of Luminous relative to your document root. </p>
|
|
<p>If you use <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>, it has to try to figure out the path to the style/ directory so that it can return a correct URL to the necessary stylesheets. Luminous may get this wrong in some situations, specifically it is currently impossible to get this right if Luminous exists on the filesystem outside of the document root, and you have used a symbolic link to put it inside. For this reason, this setting allows you to override the path.</p>
|
|
<p>e.g. If you set this to '/extern/highlighter', the stylesheets will be linked with <link rel='stylesheet' href='/extern/highlighter/style/luminous.css'> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acf2a3ca0e41e847db7fc4e30e7c4608f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$sql_function = null</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Defines an SQL function which can execute queries on a database. </p>
|
|
<p>An SQL database can be used as a replacement for the file-system cache database. This function should act similarly to the mysql_query function: it should take a single argument (the query string) and return: </p>
|
|
<ul>
|
|
<li>boolean <code>false</code> if the query fails </li>
|
|
<li>boolean <code>true</code> if the query succeeds but has no return value </li>
|
|
<li>An array of associative arrays if the query returns rows (each element is a row, and each row is an map keyed by field name) </li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49151dba0f00d1357fba1b1c68096eb5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$start_line = 1</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Line number of first line. </p>
|
|
<p>If the formatter supports line numbering, this setting controls number of the first line </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4fc507972ad86defd3bcd0c4f721e44b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$theme = 'luminous_light.css'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Theme. </p>
|
|
<p>The default theme to use. This is observed by the HTML-full and LaTeX formatters, it is also read by <a class="el" href="classluminous.html#aec66d6c5d22ff1254f8c5ff73fb0f71d" title="Gets the markup you need to include in your web page.">luminous::head_html()</a>.</p>
|
|
<p>This should be a valid theme which exists in style/ </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2d5811ef7a32a459d55de9e211c324c9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LuminousOptions::$wrap_width = -1</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Word wrapping. </p>
|
|
<p>If the formatter supports line wrapping, lines will be wrapped at this number of characters (0 or -1 to disable) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/options.class.php</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Jan 12 2013 16:03:50 for Luminous by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.1.2
|
|
</small></address>
|
|
</body>
|
|
</html>
|