File: _lib---status.inc.html

package info (click to toggle)
ldap-account-manager 3.7-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 34,660 kB
  • sloc: php: 49,813; perl: 305; makefile: 169; sh: 156; pascal: 132; xml: 111
file content (178 lines) | stat: -rw-r--r-- 8,353 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<html>
<head>
<title>Docs for page status.inc</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">lib</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                      		  [ <a href="../classtrees_lib.html" class="menu">class tree: lib</a> ]
		  [ <a href="../elementindex_lib.html" class="menu">index: lib</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
	<div id="ric">
					<p><a href="../ric_README.html">README</a></p>
			</div>
	<div id="todolist">
			<p><a href="../todolist.html">Todo List</a></p>
	</div>
      <b>Packages:</b><br />
              <a href="../li_main.html">main</a><br />
              <a href="../li_configuration.html">configuration</a><br />
              <a href="../li_Crypt_AES.html">Crypt_AES</a><br />
              <a href="../li_Crypt_DES.html">Crypt_DES</a><br />
              <a href="../li_Crypt_Hash.html">Crypt_Hash</a><br />
              <a href="../li_Crypt_Random.html">Crypt_Random</a><br />
              <a href="../li_Crypt_RC4.html">Crypt_RC4</a><br />
              <a href="../li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
              <a href="../li_Crypt_RSA.html">Crypt_RSA</a><br />
              <a href="../li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
              <a href="../li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
              <a href="../li_default.html">default</a><br />
              <a href="../li_Help.html">Help</a><br />
              <a href="../li_horde-cipher.html">horde-cipher</a><br />
              <a href="../li_lam.html">lam</a><br />
              <a href="../li_LDAP.html">LDAP</a><br />
              <a href="../li_lib.html">lib</a><br />
              <a href="../li_lists.html">lists</a><br />
              <a href="../li_Math_BigInteger.html">Math_BigInteger</a><br />
              <a href="../li_metaHTML.html">metaHTML</a><br />
              <a href="../li_modules.html">modules</a><br />
              <a href="../li_Net_SFTP.html">Net_SFTP</a><br />
              <a href="../li_Net_SSH1.html">Net_SSH1</a><br />
              <a href="../li_Net_SSH2.html">Net_SSH2</a><br />
              <a href="../li_PDF.html">PDF</a><br />
              <a href="../li_phpLDAPadmin.html">phpLDAPadmin</a><br />
              <a href="../li_PHP_Compat.html">PHP_Compat</a><br />
              <a href="../li_profiles.html">profiles</a><br />
              <a href="../li_selfService.html">selfService</a><br />
              <a href="../li_tools.html">tools</a><br />
              <a href="../li_types.html">types</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../lib/_lib---account.inc.html">		account.inc
		</a><br>
			<a href="../lib/_lib---schema.inc.html">		schema.inc
		</a><br>
			<a href="../lib/_lib---security.inc.html">		security.inc
		</a><br>
			<a href="../lib/_lib---status.inc.html">		status.inc
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../lib/AttributeType.html">AttributeType</a><br />
	    		<a href="../lib/MatchingRule.html">MatchingRule</a><br />
	    		<a href="../lib/MatchingRuleUse.html">MatchingRuleUse</a><br />
	    		<a href="../lib/ObjectClass.html">ObjectClass</a><br />
	    		<a href="../lib/ObjectClassAttribute.html">ObjectClassAttribute</a><br />
	    		<a href="../lib/SchemaItem.html">SchemaItem</a><br />
	    		<a href="../lib/Syntax.html">Syntax</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Procedural File: status.inc</h1>
Source Location: /lib/status.inc<br /><br />

<br>
<br>


<h2>Page Details:</h2>
LDAP Account Manager status messages.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Michael Duergner</td>
  </tr>
</table>
</div>
<br /><br />
<br /><br />
<br /><br />
<br />
  <hr />
	<a name="functionStatusMessage"></a>
	<h3>StatusMessage <span class="smalllinenumber">[line 53]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>String StatusMessage(
string $MessageTyp, string $MessageHeadline, [string $MessageText = &#039;&#039;], [array $MessageVariables = array()], [boolean $returnOutput = false])</code>
    </td></tr></table>
    </td></tr></table><br />

		This function prints a short status message. It can be used to print INFO,  WARN and ERROR messages at the moment.<br /><br /><p>The headline and text may be formated with special tags:  <br />  <br /><strong>{bold}, {endbold}:</strong> All text between these tags is printed bold.  <br /><strong>{color=#123456}, {endcolor}:</strong> All text between these tags is printed in the given color.  <br /><strong>{link=http://nodomain.org}, {endlink}:</strong> A link with the given target is created. The link text is the text between the tags.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>HTML code if $returnOutput is set to true, otherwise null</td>
  </tr>
</table>
</div>
    <br /><br />
	
    		<h4>Parameters</h4>
    <table border="0" cellspacing="0" cellpadding="0">
		      <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$MessageTyp</b>&nbsp;&nbsp;</td>
        <td>The type of the message to be printed. It must be one of  the following types: 'INFO', 'WARN' or 'ERROR'.  <br /> Every other type will lead to an error message indicating an invalid message type.</td>
      </tr>
		      <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$MessageHeadline</b>&nbsp;&nbsp;</td>
        <td>The headline of the status message.  <br /> It may be formatted with special color/link/bold tags.</td>
      </tr>
		      <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$MessageText</b>&nbsp;&nbsp;</td>
        <td>The text of the status message.  <br /> It may be formatted with special color/link/bold tags. This parameter is optional.</td>
      </tr>
		      <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$MessageVariables</b>&nbsp;&nbsp;</td>
        <td>The variables that are used to replace the spacers (%s) in the  submitted text. This parameter is optional.</td>
      </tr>
		      <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$returnOutput</b>&nbsp;&nbsp;</td>
        <td>if set to true this function will return the generated HTML code instead of printing it directly (default: false)</td>
      </tr>
				</table>
    	<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
	</div>

        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 25 Mar 2012 19:36:00 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>