mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2026-01-03 23:52:24 +01:00
nouvelle version de la documention des classes php
This commit is contained in:
opensides
@@ -0,0 +1,422 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!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>
|
||||
<title>Docs For Class CMailFile</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<script src="../media/lib/classTree.js"></script>
|
||||
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
|
||||
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
|
||||
<script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
|
||||
<script language="javascript" type="text/javascript">
|
||||
var imgPlus = new Image();
|
||||
var imgMinus = new Image();
|
||||
imgPlus.src = "../media/images/plus.gif";
|
||||
imgMinus.src = "../media/images/minus.gif";
|
||||
|
||||
function showNode(Node){
|
||||
switch(navigator.family){
|
||||
case 'nn4':
|
||||
// Nav 4.x code fork...
|
||||
var oTable = document.layers["span" + Node];
|
||||
var oImg = document.layers["img" + Node];
|
||||
break;
|
||||
case 'ie4':
|
||||
// IE 4/5 code fork...
|
||||
var oTable = document.all["span" + Node];
|
||||
var oImg = document.all["img" + Node];
|
||||
break;
|
||||
case 'gecko':
|
||||
// Standards Compliant code fork...
|
||||
var oTable = document.getElementById("span" + Node);
|
||||
var oImg = document.getElementById("img" + Node);
|
||||
break;
|
||||
}
|
||||
oImg.src = imgMinus.src;
|
||||
oTable.style.display = "block";
|
||||
}
|
||||
|
||||
function hideNode(Node){
|
||||
switch(navigator.family){
|
||||
case 'nn4':
|
||||
// Nav 4.x code fork...
|
||||
var oTable = document.layers["span" + Node];
|
||||
var oImg = document.layers["img" + Node];
|
||||
break;
|
||||
case 'ie4':
|
||||
// IE 4/5 code fork...
|
||||
var oTable = document.all["span" + Node];
|
||||
var oImg = document.all["img" + Node];
|
||||
break;
|
||||
case 'gecko':
|
||||
// Standards Compliant code fork...
|
||||
var oTable = document.getElementById("span" + Node);
|
||||
var oImg = document.getElementById("img" + Node);
|
||||
break;
|
||||
}
|
||||
oImg.src = imgPlus.src;
|
||||
oTable.style.display = "none";
|
||||
}
|
||||
|
||||
function nodeIsVisible(Node){
|
||||
switch(navigator.family){
|
||||
case 'nn4':
|
||||
// Nav 4.x code fork...
|
||||
var oTable = document.layers["span" + Node];
|
||||
break;
|
||||
case 'ie4':
|
||||
// IE 4/5 code fork...
|
||||
var oTable = document.all["span" + Node];
|
||||
break;
|
||||
case 'gecko':
|
||||
// Standards Compliant code fork...
|
||||
var oTable = document.getElementById("span" + Node);
|
||||
break;
|
||||
}
|
||||
return (oTable && oTable.style.display == "block");
|
||||
}
|
||||
|
||||
function toggleNodeVisibility(Node){
|
||||
if (nodeIsVisible(Node)){
|
||||
hideNode(Node);
|
||||
}else{
|
||||
showNode(Node);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
|
||||
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
|
||||
<h2>
|
||||
Class CMailFile
|
||||
</h2> (line <span class="linenumber">32</span>)
|
||||
<div class="tab-pane" id="tabPane1">
|
||||
<script type="text/javascript">
|
||||
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
|
||||
</script>
|
||||
|
||||
<div class="tab-page" id="Description">
|
||||
<h2 class="tab">Description</h2>
|
||||
<pre>
|
||||
</pre>
|
||||
<p>
|
||||
<b><i>Located in File: <a href="_CMailFile_class_php.html">/CMailFile.class.php</a></i></b><br>
|
||||
</p>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
<br /><hr />
|
||||
</div>
|
||||
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
|
||||
<div class="tab-page" id="tabPage1">
|
||||
<h2 class="tab">Class Variables</h2>
|
||||
<!-- ============ VARIABLE DETAIL =========== -->
|
||||
<strong>Summary:</strong><br />
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$addr_cc" title="details" class="property"><strong>$addr_cc</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$addr_to" title="details" class="property"><strong>$addr_to</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$mime_boundary" title="details" class="property"><strong>$mime_boundary</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$mime_headers" title="details" class="property"><strong>$mime_headers</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$smtp_headers" title="details" class="property"><strong>$smtp_headers</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$subject" title="details" class="property"><strong>$subject</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$text_body" title="details" class="property"><strong>$text_body</strong></a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#var$text_encoded" title="details" class="property"><strong>$text_encoded</strong></a>
|
||||
</div>
|
||||
<hr />
|
||||
<a name="var$addr_cc" id="var$addr_cc"><!-- --></A>
|
||||
<div style="background='#eeeeee'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$addr_cc</strong> (line <span class="linenumber">36</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$addr_to" id="var$addr_to"><!-- --></A>
|
||||
<div style="background='#ffffff'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$addr_to</strong> (line <span class="linenumber">35</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$mime_boundary" id="var$mime_boundary"><!-- --></A>
|
||||
<div style="background='#eeeeee'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$mime_boundary = "--==================_846811060==_"</strong> (line <span class="linenumber">40</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$mime_headers" id="var$mime_headers"><!-- --></A>
|
||||
<div style="background='#ffffff'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$mime_headers</strong> (line <span class="linenumber">39</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$smtp_headers" id="var$smtp_headers"><!-- --></A>
|
||||
<div style="background='#eeeeee'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$smtp_headers</strong> (line <span class="linenumber">41</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$subject" id="var$subject"><!-- --></A>
|
||||
<div style="background='#ffffff'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$subject</strong> (line <span class="linenumber">34</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$text_body" id="var$text_body"><!-- --></A>
|
||||
<div style="background='#eeeeee'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$text_body</strong> (line <span class="linenumber">37</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="var$text_encoded" id="var$text_encoded"><!-- --></A>
|
||||
<div style="background='#ffffff'">
|
||||
<h4>
|
||||
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$text_encoded</strong> (line <span class="linenumber">38</span>)
|
||||
</h4>
|
||||
<h4>Data type : mixed</h4>
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
|
||||
</div>
|
||||
<div class="tab-page" id="tabPage2">
|
||||
<h2 class="tab">Method Detail</h2>
|
||||
<!-- ============ METHOD DETAIL =========== -->
|
||||
<strong>Summary:</strong><br />
|
||||
<div class="method-summary">
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">CMailFile</span>
|
||||
<a href="#methodCMailFile" title="details" class="method-name">CMailFile</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$subject</span>, <span class="var-type">mixed</span> <span class="var-name">$to</span>, <span class="var-type">mixed</span> <span class="var-name">$from</span>, <span class="var-type">mixed</span> <span class="var-name">$msg</span>, <span class="var-type">mixed</span> <span class="var-name">$filename_list</span>, <span class="var-type">mixed</span> <span class="var-name">$mimetype_list</span>, <span class="var-type">mixed</span> <span class="var-name">$mimefilename_list</span>, [<span class="var-type">mixed</span> <span class="var-name">$addr_cc</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodattach_file" title="details" class="method-name">attach_file</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$filename_list</span>, <span class="var-type">mixed</span> <span class="var-name">$mimetype_list</span>, <span class="var-type">mixed</span> <span class="var-name">$mimefilename_list</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodencode_file" title="details" class="method-name">encode_file</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$sourcefile</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodsendfile" title="details" class="method-name">sendfile</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodwrite_body" title="details" class="method-name">write_body</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$msgtext</span>, <span class="var-type">mixed</span> <span class="var-name">$filename_list</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodwrite_mimeheaders" title="details" class="method-name">write_mimeheaders</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$filename_list</span>, <span class="var-type">mixed</span> <span class="var-name">$mimefilename_list</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#methodwrite_smtpheaders" title="details" class="method-name">write_smtpheaders</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$addr_from</span>, <span class="var-type">mixed</span> <span class="var-name">$addr_cc</span>)
|
||||
</div>
|
||||
</div>
|
||||
<hr />
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
|
||||
<a name="methodCMailFile" id="methodCMailFile"><!-- --></a>
|
||||
<div style="background='#eeeeee'"><h4>
|
||||
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor CMailFile</strong> (line <span class="linenumber">44</span>)
|
||||
</h4>
|
||||
<h4><i>CMailFile</i> <strong>CMailFile(
|
||||
mixed
|
||||
$subject, mixed
|
||||
$to, mixed
|
||||
$from, mixed
|
||||
$msg, mixed
|
||||
$filename_list, mixed
|
||||
$mimetype_list, mixed
|
||||
$mimefilename_list, [mixed
|
||||
$addr_cc = ""])</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodattach_file" id="methodattach_file"><!-- --></a>
|
||||
<div style="background='#ffffff'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method attach_file</strong> (line <span class="linenumber">56</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>attach_file(
|
||||
mixed
|
||||
$filename_list, mixed
|
||||
$mimetype_list, mixed
|
||||
$mimefilename_list)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodencode_file" id="methodencode_file"><!-- --></a>
|
||||
<div style="background='#eeeeee'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method encode_file</strong> (line <span class="linenumber">73</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>encode_file(
|
||||
mixed
|
||||
$sourcefile)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodsendfile" id="methodsendfile"><!-- --></a>
|
||||
<div style="background='#ffffff'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method sendfile</strong> (line <span class="linenumber">86</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>sendfile(
|
||||
)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodwrite_body" id="methodwrite_body"><!-- --></a>
|
||||
<div style="background='#eeeeee'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method write_body</strong> (line <span class="linenumber">93</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>write_body(
|
||||
mixed
|
||||
$msgtext, mixed
|
||||
$filename_list)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodwrite_mimeheaders" id="methodwrite_mimeheaders"><!-- --></a>
|
||||
<div style="background='#ffffff'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method write_mimeheaders</strong> (line <span class="linenumber">105</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>write_mimeheaders(
|
||||
mixed
|
||||
$filename_list, mixed
|
||||
$mimefilename_list)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<a name="methodwrite_smtpheaders" id="methodwrite_smtpheaders"><!-- --></a>
|
||||
<div style="background='#eeeeee'"><h4>
|
||||
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method write_smtpheaders</strong> (line <span class="linenumber">117</span>)
|
||||
</h4>
|
||||
<h4><i>void</i> <strong>write_smtpheaders(
|
||||
mixed
|
||||
$addr_from, mixed
|
||||
$addr_cc)</strong></h4>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<h4>Info</h4>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
|
||||
<div class="tab-page" id="iVars">
|
||||
<h2 class="tab">Inherited Variables</h2>
|
||||
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
|
||||
<!-- =========== VAR INHERITED SUMMARY =========== -->
|
||||
<A NAME='var_inherited_summary'><!-- --></A>
|
||||
<h3>Inherited Class Variable Summary</h3>
|
||||
|
||||
</div>
|
||||
<div class="tab-page" id="iMethods">
|
||||
<h2 class="tab">Inherited Methods</h2>
|
||||
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
|
||||
<!-- =========== INHERITED METHOD SUMMARY =========== -->
|
||||
<A NAME='functions_inherited'><!-- --></A>
|
||||
<h3>Inherited Method Summary</h3>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
//<![CDATA[
|
||||
|
||||
setupAllTabs();
|
||||
|
||||
//]]>
|
||||
</script>
|
||||
<div id="credit">
|
||||
<hr />
|
||||
Documentation generated on Mon, 21 Jun 2004 23:58:39 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user