<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>API Documentation</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">API Documentation</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/Teknoo.html">\Teknoo</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i> Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">10</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2051512057"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2051512057" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-222252038"></a>
<a href="../namespaces/Teknoo.html" style="margin-left: 30px; padding-left: 0">Teknoo</a>
</div>
<div id="namespace-222252038" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-273137763"></a>
<a href="../namespaces/Teknoo.Curl.html" style="margin-left: 30px; padding-left: 0">Curl</a>
</div>
<div id="namespace-273137763" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="interface"><a href="../classes/Teknoo.Curl.OptionsInterface.html">OptionsInterface</a></li>
<li class="interface"><a href="../classes/Teknoo.Curl.RequestInterface.html">RequestInterface</a></li>
<li class="class"><a href="../classes/Teknoo.Curl.ErrorException.html">ErrorException</a></li>
<li class="class"><a href="../classes/Teknoo.Curl.Options.html">Options</a></li>
<li class="class"><a href="../classes/Teknoo.Curl.Request.html">Request</a></li>
<li class="class"><a href="../classes/Teknoo.Curl.RequestGenerator.html">RequestGenerator</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/Teknoo.Curl.html">\Teknoo\Curl</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\Teknoo\Curl</small>Options</h1>
<p><em>Class Options
Class to manage cUrl Options and the valid type(s) for each and define them in a request context.</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/Teknoo.Curl.Options.html#method___construct" class="">__construct()</a><br />
<a href="../classes/Teknoo.Curl.Options.html#method_isValidOption" class="">isValidOption()</a><br />
<a href="../classes/Teknoo.Curl.Options.html#method_checkOptionValue" class="">checkOptionValue()</a><br />
<a href="../classes/Teknoo.Curl.Options.html#method_setOptionValue" class="">setOptionValue()</a><br />
<a href="../classes/Teknoo.Curl.Options.html#method_setOptionsValuesArray" class="">setOptionsValuesArray()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/Teknoo.Curl.Options.html#method_checkType" class="">checkType()</a><br />
</section>
<section class="span4">
<a href="../classes/Teknoo.Curl.Options.html#property_optionValueTypesList" class="">$optionValueTypesList</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/Options.html"><div class="path-wrapper">Options.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\Teknoo\Curl\Options</div>
</dd>
<dt>Implements</dt>
<dd><a href="../classes/Teknoo.Curl.OptionsInterface.html"><div class="namespace-wrapper">\Teknoo\Curl\OptionsInterface</div></a></dd>
<dt>See also</dt>
<dd><a href="http://teknoo.software/curl"><span class="namespace-wrapper">Project website</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
copyright
</th>
<td>
<p>Copyright (c) 2009-2016 Richard Déloge (richarddeloge@gmail.com)</p>
<p>Copyright (c) Darrell Hamilton <a href="mailto:darrell.noice@gmail.com">darrell.noice@gmail.com</a> (initial developer)</p>
</td>
</tr>
<tr>
<th>
license
</th>
<td>
<p><a href="http://teknoo.software/curl/license/mit">http://teknoo.software/curl/license/mit</a> MIT License</p>
<p><a href="http://teknoo.software/curl/license/gpl-3.0">http://teknoo.software/curl/license/gpl-3.0</a> GPL v3 License</p>
</td>
</tr>
<tr>
<th>
author
</th>
<td>
<p>Darrell Hamilton <a href="mailto:darrell.noice@gmail.com">darrell.noice@gmail.com</a> (initial developer)</p>
</td>
</tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_optionValueTypesList" name="property_optionValueTypesList" class="anchor"></a>
<article class="property">
<h3 class="protected ">$optionValueTypesList</h3>
<pre class="signature">$optionValueTypesList : array</pre>
<p><em>List of available CURL Option in this execution.</em></p>
<h4>Type</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct() </pre>
<p><em>Initialize curl options
Checks which cURL constants is defined and loads them as valid options.</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_isValidOption" name="method_isValidOption" class="anchor"></a>
<article class="method">
<h3 class="public ">isValidOption()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">isValidOption(integer <span class="argument">$option</span>) : boolean</pre>
<p><em>Determine whether or not the value passed is a valid cURL option.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$option </td>
<td><p>An Integer Flag</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
— <p>Whether or not the flag is a valid cURL option</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_checkOptionValue" name="method_checkOptionValue" class="anchor"></a>
<article class="method">
<h3 class="public ">checkOptionValue()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">checkOptionValue(integer <span class="argument">$option</span>, mixed <span class="argument">$value</span>, <span class="argument">$throw = true</span>) : boolean</pre>
<p><em>Check whether or not the value is a valid type for the given option.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$option </td>
<td><p>An integer flag</p></td>
</tr>
<tr>
<td>mixed</td>
<td>$value </td>
<td><p>the value to be set to the integer flag</p></td>
</tr>
<tr>
<td></td>
<td>$throw </td>
<td></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\InvalidArgumentException</dt>
<dd><p>if the $option _is<em>not</em> a valid cURL option</p></dd>
</dl>
<h4>Returns</h4>
boolean
— <p>$throw Whether or not the value is of the correct type</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setOptionValue" name="method_setOptionValue" class="anchor"></a>
<article class="method">
<h3 class="public ">setOptionValue()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setOptionValue(resource <span class="argument">$resource</span>, integer <span class="argument">$option</span>, mixed <span class="argument">$value</span>) : boolean</pre>
<p><em>Alias of the curl_setopt function.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>resource</td>
<td>$resource </td>
<td><p>cUrl resource</p></td>
</tr>
<tr>
<td>integer</td>
<td>$option </td>
<td><p>Option defined in <a href="http://php.net/manual/function.curl-setopt.php">http://php.net/manual/function.curl-setopt.php</a></p></td>
</tr>
<tr>
<td>mixed</td>
<td>$value </td>
<td></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\InvalidArgumentException</dt>
<dd><p>if the option does not exist or if it is invalid</p></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://php.net/manual/function.curl-setopt.php"><span class="namespace-wrapper">http://php.net/manual/function.curl-setopt.php</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setOptionsValuesArray" name="method_setOptionsValuesArray" class="anchor"></a>
<article class="method">
<h3 class="public ">setOptionsValuesArray()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setOptionsValuesArray(resource <span class="argument">$resource</span>, array <span class="argument">$options</span>) : boolean</pre>
<p><em>Alias of the curl_setopt_array function.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>resource</td>
<td>$resource </td>
<td><p>curl resource</p></td>
</tr>
<tr>
<td>array</td>
<td>$options </td>
<td><p>defined in <a href="http://php.net/manual/function.curl-setopt-array.php">http://php.net/manual/function.curl-setopt-array.php</a></p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://php.net/manual/function.curl-setopt-array.php"><span class="namespace-wrapper">http://php.net/manual/function.curl-setopt-array.php</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_checkType" name="method_checkType" class="anchor"></a>
<article class="method">
<h3 class="protected ">checkType()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">checkType(mixed <span class="argument">$value</span>, string <span class="argument">$type</span>) : boolean</pre>
<p><em>Check if the type of $value is the attempted type by the option.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$value </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">Options.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/Options.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/Teknoo.html">\Teknoo</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on July 26th, 2016 at 19:46.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>