Location: PHPKode > projects > Moc10 PHP Library > docs/api-docs/Moc10_Form/Moc10_Form_Element_Checkbox.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>
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Moc10_Form_Element_Checkbox</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 Moc10_Form_Element_Checkbox</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">Moc10_Form_Element_Checkbox</p>
	<ul class="tags">
				<li><span class="field">author:</span> Nick Sagona, III &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">version:</span> 1.9.7</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009-2011 Moc 10 Media, LLC. (http://www.moc10media.com)</li>
				<li><span class="field">license:</span> <a href="http://www.moc10phplibrary.com/LICENSE.TXT">New BSD License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Form---Element---Checkbox.php.html">/Form/Element/Checkbox.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre><a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a>
   |
   --<a href="../Moc10_Form/Moc10_Form_Element.html">Moc10_Form_Element</a>
      |
      --Moc10_Form_Element_Checkbox</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</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="#$values" title="details" class="var-name">$values</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</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">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$marked</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">null</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setMarked" title="details" class="method-name">setMarked</a>
											(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$val</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$values" id="$values"><!-- --></a>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$values</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Current values</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
							<h4>Inherited Variables</h4>
				<a name='inherited_vars'><!-- --></a>
									<p>Inherited from <span class="classname"><a href="../Moc10_Form/Moc10_Form_Element.html">Moc10_Form_Element</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$errors">Moc10_Form_Element::$errors</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$label">Moc10_Form_Element::$label</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$marked">Moc10_Form_Element::$marked</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$required">Moc10_Form_Element::$required</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$validators">Moc10_Form_Element::$validators</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$value">Moc10_Form_Element::$value</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$_allowed_types">Moc10_Form_Element::$_allowed_types</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$_allowed_validators">Moc10_Form_Element::$_allowed_validators</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Form/Moc10_Form_Element.html#var$_lang">Moc10_Form_Element::$_lang</a></span><br />
							</span>
											</blockquote> 
									<p>Inherited from <span class="classname"><a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_attributes">Moc10_Dom_Child::$_attributes</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_childNodes">Moc10_Dom_Child::$_childNodes</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_childrenFirst">Moc10_Dom_Child::$_childrenFirst</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_indent">Moc10_Dom_Child::$_indent</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_nodeName">Moc10_Dom_Child::$_nodeName</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_nodeValue">Moc10_Dom_Child::$_nodeValue</a></span><br />
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#var$_output">Moc10_Dom_Child::$_output</a></span><br />
							</span>
											</blockquote> 
										
		</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">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description">Instantiate the checkbox form element object.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$marked</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$value</span>			</li>
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$marked</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$indent</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Moc10_Form/Moc10_Form_Element.html#method__construct">Moc10_Form_Element::__construct()</a></dt>
						<dd>Constructor</dd>
					</dl>
			
	</div>
<a name="methodsetMarked" id="setMarked"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setMarked</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the current marked value. The marked value is based on the key(s) of the associative array (not the value(s).)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setMarked
		</span>
					(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$val</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$val</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Moc10_Form/Moc10_Form_Element.html">Moc10_Form_Element</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#method__construct">Moc10_Form_Element::__construct()</a></span><br />
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#methodaddValidator">Moc10_Form_Element::addValidator()</a></span><br />
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#methodrender">Moc10_Form_Element::render()</a></span><br />
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#methodsetLabel">Moc10_Form_Element::setLabel()</a></span><br />
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#methodsetRequired">Moc10_Form_Element::setRequired()</a></span><br />
													<span class="method-name"><a href="../Moc10_Form/Moc10_Form_Element.html#methodvalidate">Moc10_Form_Element::validate()</a></span><br />
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Moc10_Dom/Moc10_Dom_Child.html">Moc10_Dom_Child</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#method__construct">Moc10_Dom_Child::__construct()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodaddChildren">Moc10_Dom_Child::addChildren()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodgetAttributes">Moc10_Dom_Child::getAttributes()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodgetChildren">Moc10_Dom_Child::getChildren()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodgetIndent">Moc10_Dom_Child::getIndent()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodgetName">Moc10_Dom_Child::getName()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodgetValue">Moc10_Dom_Child::getValue()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodremoveChildren">Moc10_Dom_Child::removeChildren()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodrender">Moc10_Dom_Child::render()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodsetAttributes">Moc10_Dom_Child::setAttributes()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodsetIndent">Moc10_Dom_Child::setIndent()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodsetName">Moc10_Dom_Child::setName()</a></span><br />
													<span class="method-name"><a href="../Moc10_Dom/Moc10_Dom_Child.html#methodsetValue">Moc10_Dom_Child::setValue()</a></span><br />
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 12 Jan 2011 01:17:42 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: Moc10 PHP Library