Source

VersionControl_Hg / src / Documentation / API / Html / Hg / VersionControl_Hg_CommandProxy.html

The default branch has multiple heads

Full commit
<?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 VersionControl_Hg_CommandProxy</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class VersionControl_Hg_CommandProxy</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<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">Instantiates the Mercurial command and passes an instance of  VersionControl_Hg into the constructor of each command.</p>
<p class="description"><p>PHP version 5</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Michael Gatto &lt;<a href="mailto:mgatto@lisantra.com">mgatto@lisantra.com</a>&gt;</li>
				<li><span class="field">copyright:</span> 2011 Lisantra Technologies, LLC</li>
				<li><span class="field">link:</span> <a href="http://pear.php.net/package/VersionControl_Hg">http://pear.php.net/package/VersionControl_Hg</a></li>
				<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">MIT License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Hg---CommandProxy.php.html">/Hg/CommandProxy.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$allowed_commands" title="details" class="var-name">$allowed_commands</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Hg/Command/VersionControl_Hg_Command_Abstract.html">VersionControl_Hg_Command_Abstract</a></span>
					<a href="#$command" title="details" class="var-name">$command</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>
					<a href="#$hg" title="details" class="var-name">$hg</a>
				</div>
											</div>
		</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> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">VersionControl_Hg_CommandProxy</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>
										<a href="#getCommand" title="details" class="method-name">getCommand</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">null</span>
										<a href="#setCommand" title="details" class="method-name">setCommand</a>
											(<span class="var-type"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>&nbsp;<span class="var-name">$command</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>
										<a href="#__call" title="details" class="method-name">__call</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$arguments</span> = <span class="var-default">null</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$allowed_commands" id="$allowed_commands"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$allowed_commands</span>
			 = <span class="var-default">array(<br />        'version', 'archive', 'status', 'log', 'init', 'clone', 'pull', 'cat'<br />    )</span>			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Implemented commands</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$command" id="$command"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Hg/Command/VersionControl_Hg_Command_Abstract.html">VersionControl_Hg_Command_Abstract</a></span>
			<span class="var-name">$command</span>
						(line <span class="line-number">49</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The command class to be instantiated</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$hg" id="$hg"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>
			<span class="var-name">$hg</span>
						(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The parent, core object</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">VersionControl_Hg_CommandProxy</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>&nbsp;<span class="var-name">$hg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Hg/VersionControl_Hg.html">VersionControl_Hg</a></span>
				<span class="var-name">$hg</span><span class="var-description">: is the root object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetCommand" id="getCommand"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCommand</span> (line <span class="line-number">86</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the command property</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>
		<span class="method-name">
			getCommand
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetCommand" id="setCommand"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setCommand</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the command property</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">null</span>
		<span class="method-name">
			setCommand
		</span>
					(<span class="var-type"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>&nbsp;<span class="var-name">$command</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>
				<span class="var-name">$command</span><span class="var-description">: is the command  instance to execute</span>			</li>
				</ul>
		
			
	</div>
<a name="method__call" id="__call"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__call</span> (line <span class="line-number">100</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Proxies to the actual implementations of the commands</p>
	<ul class="tags">
				<li><span class="field">throws:</span> VersionControl_Hg_Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Hg/Command/VersionControl_Hg_Command_Interface.html">VersionControl_Hg_Command_Interface</a></span>
		<span class="method-name">
			__call
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$arguments</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span><span class="var-description">: The command to instantiate</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$arguments</span><span class="var-description">: Parameters for the command</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 19 Jul 2011 14:21:13 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>