Location: PHPKode > scripts > QuickAPI > QAPI.html
<?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>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class QAPI</title>
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
            <style type="text/css">
                a { color: #336699; text-decoration: none; }
                a:hover { color: #6699CC; text-decoration: underline; }
                a:active { color: #6699CC; text-decoration: underline; }

                body { background : #FFFFFF; }
                body, table { font-family: Georgia, Times New Roman, Times, serif; font-size: 10pt }
                p, li { line-height: 140% }
                a img { border: 0px; }
                dd { margin-left: 0px; padding-left: 1em; }

                /* Page layout/boxes */

                .info-box {}
                .info-box-title { margin: 1em 0em 0em 0em; padding: .25em; font-weight: normal; font-size: 14pt; border: 2px solid #999999; background-color: #CCCCFF }
                .info-box-body { border: 1px solid #999999; padding: .5em; }
                .nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }

                .oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
                .evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}

                .page-body { max-width: 800px; margin: auto; }
                .tree dl { margin: 0px }

                /* Index formatting classes */

                .index-item-body { margin-top: .5em; margin-bottom: .5em}
                .index-item-description { margin-top: .25em }
                .index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
                .index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
                .index-letter-title { font-size: 12pt; font-weight: bold }
                .index-letter-menu { text-align: center; margin: 1em }
                .index-letter { font-size: 12pt }

                /* Docbook classes */

                .description {}
                .short-description { font-weight: bold; color: #666666; }
                .tags {	padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
                .parameters {	padding-left: 0em; margin-left: 3em; font-style: italic; list-style-type: square; }
                .redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
                .package {  }
                .package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
                .package-details { font-size: 85%; }
                .sub-package { font-weight: bold; font-size: 120% }
                .tutorial { border-width: thin; border-color: #0066ff }
                .tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
                .nav-button-disabled { color: #999999; }
                .nav-button:active, 
                .nav-button:focus, 
                .nav-button:hover { background-color: #DDDDDD; outline: 1px solid #999999; text-decoration: none }
                .folder-title { font-style: italic }

                /* Generic formatting */

                .field { font-weight: bold; }
                .detail { font-size: 8pt; }
                .notes { font-style: italic; font-size: 8pt; }
                .separator { background-color: #999999; height: 2px; }
                .warning {  color: #FF6600; }
                .disabled { font-style: italic; color: #999999; }

                /* Code elements */

                .line-number {  }

                .class-table { width: 100%; }
                .class-table-header { border-bottom: 1px dotted #666666; text-align: left}
                .class-name { color: #000000; font-weight: bold; }

                .method-summary { padding-left: 1em; font-size: 8pt }
                .method-header { }
                .method-definition { margin-bottom: .3em }
                .method-title { font-weight: bold; }
                .method-name { font-weight: bold; }
                .method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
                .method-result { font-style: italic; }

                .var-summary { padding-left: 1em; font-size: 8pt; }
                .var-header { }
                .var-title { margin-bottom: .3em }
                .var-type { font-style: italic; }
                .var-name { font-weight: bold; }
                .var-default {}
                .var-description { font-weight: normal; color: #000000; }

                .include-title {  }
                .include-type { font-style: italic; }
                .include-name { font-weight: bold; }

                .const-title {  }
                .const-name { font-weight: bold; }

                /* Syntax highlighting */

                .src-code {  border: 1px solid #336699; padding: 1em; background-color: #EEEEEE; }
                .src-line {  font-family: 'Courier New', Courier, monospace; font-weight: normal; }

                .src-comm { color: green; }
                .src-id {  }
                .src-inc { color: #0000FF; }
                .src-key { color: #0000FF; }
                .src-num { color: #CC0000; }
                .src-str { color: #66cccc; }
                .src-sym { font-weight: bold; }
                .src-var { }

                .src-php { font-weight: bold; }

                .src-doc { color: #009999 }
                .src-doc-close-template { color: #0000FF }
                .src-doc-coretag { color: #0099FF; font-weight: bold }
                .src-doc-inlinetag { color: #0099FF }
                .src-doc-internal { color: #6699cc }
                .src-doc-tag { color: #0080CC }
                .src-doc-template { color: #0000FF }
                .src-doc-type { font-style: italic }
                .src-doc-var { font-style: italic }

                .tute-tag { color: #009999 }
                .tute-attribute-name { color: #0000FF }
                .tute-attribute-value { color: #0099FF }
                .tute-entity { font-weight: bold; }
                .tute-comment { font-style: italic }
                .tute-inline-tag { color: #636311; font-weight: bold }

                /* tutorial */

                .authors {  }
                .author { font-style: italic; font-weight: bold }
                .author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
                .example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; }
                *[class="example"] { line-height : 0.5em }
                .listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; }
                *[class="listing"] { line-height : 0.5em }
                .release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
                .ref-title-box {  }
                .ref-title {  }
                .ref-purpose { font-style: italic; color: #666666 }
                .ref-synopsis {  }
                .title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #CCCCFF  }
                .cmd-synopsis { margin: 1em 0em }
                .cmd-title { font-weight: bold }
                .toc { margin-left: 2em; padding-left: 0em }
            </style>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class QAPI</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Main class for API methods manipulation</p>
		<p class="notes">
			Located in <a class="field" href="_QAPI.class.php.html">/QAPI.class.php</a> (line <span class="field">12</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												
												<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#call" title="details" class="method-name">call</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#register" title="details" class="method-name">register</a>
											([<span class="var-type">object|string|array</span>&nbsp;<span class="var-name">$handler</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerClass" title="details" class="method-name">registerClass</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$className</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerClasses" title="details" class="method-name">registerClasses</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerFunction" title="details" class="method-name">registerFunction</a>
											(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$funcName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerMethod" title="details" class="method-name">registerMethod</a>
											(<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerObject" title="details" class="method-name">registerObject</a>
											(<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerObjects" title="details" class="method-name">registerObjects</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#registerStatic" title="details" class="method-name">registerStatic</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$className</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodcall" id="call"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">call</span> (line <span class="line-number">177</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Call registered method</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			call
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: API method name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregister" id="register"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">register</span> (line <span class="line-number">155</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Auto-recognize and register API handler(s)</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			register
		</span>
					([<span class="var-type">object|string|array</span>&nbsp;<span class="var-name">$handler</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object|string|array</span>
				<span class="var-name">$handler</span><span class="var-description">: Object, class or callable to be registered</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$prefix</span><span class="var-description">: Prefix for object and class methods (use '$' to insert class name)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterClass" id="registerClass"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">registerClass</span> (line <span class="line-number">98</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register class</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerClass
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$className</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$className</span><span class="var-description">: Class with static methods to be registered as API handlers</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$prefix</span><span class="var-description">: Prefix for object and class methods (use '$' to insert class name)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterClasses" id="registerClasses"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">registerClasses</span> (line <span class="line-number">116</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register classes that implement QAPI_Interface</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerClasses
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$prefix</span><span class="var-description">: Prefix for object and class methods (use '$' to insert class name)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterFunction" id="registerFunction"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">registerFunction</span> (line <span class="line-number">23</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register callable as API handler</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerFunction
		</span>
					(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$funcName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$funcName</span><span class="var-description">: Callable API handler</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: Name for API method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterMethod" id="registerMethod"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">registerMethod</span> (line <span class="line-number">47</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register object method</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerMethod
		</span>
					(<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">$object</span><span class="var-description">: Object with method to be registered as API handler</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$methodName</span><span class="var-description">: Name of method to be registered</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: Name for API method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterObject" id="registerObject"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">registerObject</span> (line <span class="line-number">78</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register object</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerObject
		</span>
					(<span class="var-type">object</span>&nbsp;<span class="var-name">$object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object</span>
				<span class="var-name">$object</span><span class="var-description">: Object with methods to be registered as API handlers</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$prefix</span><span class="var-description">: Prefix for object and class methods (use '$' to insert class name)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterObjects" id="registerObjects"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">registerObjects</span> (line <span class="line-number">135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register global objects that implement QAPI_Interface</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerObjects
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$prefix</span><span class="var-description">: Prefix for object and class methods (use '$' to insert class name)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterStatic" id="registerStatic"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">registerStatic</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register class static method</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerStatic
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$className</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$className</span><span class="var-description">: Class with static method to be registered as API handler</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$methodName</span><span class="var-description">: Name of method to be registered</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: Name for API method</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 04 Jan 2010 16:04:25 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: QuickAPI