mirror of
https://0xacab.org/radar/radar-wp.git
synced 2025-06-09 13:16:26 +02:00
Make sure radar depenency is in repo, and upgrade for Price Categories.
This commit is contained in:
ekes
parent
c83d681db3
commit
70825293ae
124 changed files with 29219 additions and 19 deletions
583
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Cache.html
vendored
Normal file
583
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Cache.html
vendored
Normal file
|
|
@ -0,0 +1,583 @@
|
|||
<!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/Radar.html">\Radar</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">146</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</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-76043126"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-76043126" 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-321932657"></a>
|
||||
<a href="../namespaces/Radar.html" style="margin-left: 30px; padding-left: 0">Radar</a>
|
||||
</div>
|
||||
<div id="namespace-321932657" 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-54217409"></a>
|
||||
<a href="../namespaces/Radar.Connect.html" style="margin-left: 30px; padding-left: 0">Connect</a>
|
||||
</div>
|
||||
<div id="namespace-54217409" 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-1064190934"></a>
|
||||
<a href="../namespaces/Radar.Connect.Entity.html" style="margin-left: 30px; padding-left: 0">Entity</a>
|
||||
</div>
|
||||
<div id="namespace-1064190934" class="accordion-body collapse ">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Entity.html">Entity</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Event.html">Event</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Group.html">Group</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.ListingsGroup.html">ListingsGroup</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Location.html">Location</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Node.html">Node</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.TaxonomyTerm.html">TaxonomyTerm</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Cache.html">Cache</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Connect.html">Connect</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Filter.html">Filter</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/Radar.Connect.html">\Radar\Connect</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>\Radar\Connect</small>Cache</h1>
|
||||
<p><em></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/Radar.Connect.Cache.html#method___construct" class="">__construct()</a><br />
|
||||
<a href="../classes/Radar.Connect.Cache.html#method_contains" class="">contains()</a><br />
|
||||
<a href="../classes/Radar.Connect.Cache.html#method_fetch" class="">fetch()</a><br />
|
||||
<a href="../classes/Radar.Connect.Cache.html#method_save" class="">save()</a><br />
|
||||
<a href="../classes/Radar.Connect.Cache.html#method_delete" class="">delete()</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">
|
||||
<em>No protected methods found</em>
|
||||
</section>
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Cache.html#property_cache" class="">$cache</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/Cache.html"><div class="path-wrapper">Cache.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">\Radar\Connect\Cache</div>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></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_cache" name="property_cache" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="protected ">$cache</h3>
|
||||
<pre class="signature">$cache : \Radar\Connect\CacheInteface</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
\Radar\Connect\CacheInteface
|
||||
— Doctrine cache. </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(\Doctrine\Common\Cache\Cache <span class="argument">$cache</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>\Doctrine\Common\Cache\Cache</td>
|
||||
<td>$cache </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_contains" name="method_contains" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">contains()</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;">contains(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_fetch" name="method_fetch" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">fetch()</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;">fetch(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_save" name="method_save" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">save()</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;">save(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_delete" name="method_delete" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">delete()</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;">delete(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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">Cache.php</h3>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<pre data-src="../files/Cache.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/Radar.html">\Radar</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 February 22nd, 2015 at 11:34.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
919
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Connect.html
vendored
Normal file
919
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Connect.html
vendored
Normal file
|
|
@ -0,0 +1,919 @@
|
|||
<!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/Radar.html">\Radar</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">146</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</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-602675730"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-602675730" 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-743844184"></a>
|
||||
<a href="../namespaces/Radar.html" style="margin-left: 30px; padding-left: 0">Radar</a>
|
||||
</div>
|
||||
<div id="namespace-743844184" 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-1596801339"></a>
|
||||
<a href="../namespaces/Radar.Connect.html" style="margin-left: 30px; padding-left: 0">Connect</a>
|
||||
</div>
|
||||
<div id="namespace-1596801339" 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-733584923"></a>
|
||||
<a href="../namespaces/Radar.Connect.Entity.html" style="margin-left: 30px; padding-left: 0">Entity</a>
|
||||
</div>
|
||||
<div id="namespace-733584923" class="accordion-body collapse ">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Entity.html">Entity</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Event.html">Event</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Group.html">Group</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.ListingsGroup.html">ListingsGroup</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Location.html">Location</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Node.html">Node</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.TaxonomyTerm.html">TaxonomyTerm</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Cache.html">Cache</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Connect.html">Connect</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Filter.html">Filter</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/Radar.Connect.html">\Radar\Connect</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>\Radar\Connect</small>Connect</h1>
|
||||
<p><em></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/Radar.Connect.Connect.html#method___construct" class="">__construct()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method___call" class="">__call()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_setCache" class="">setCache()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_retrieveEntity" class="">retrieveEntity()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_retrieveEntityMultiple" class="">retrieveEntityMultiple()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_putEntity" class="">putEntity()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_prepareEventsRequest" class="">prepareEventsRequest()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_prepareGroupsRequest" class="">prepareGroupsRequest()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_retrieve" class="">retrieve()</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_retrieveMultiple" class="">retrieveMultiple()</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Connect.html#property_apiUrl" class="">$apiUrl</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#property_debug" class="">$debug</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<em>No constants found</em>
|
||||
</section>
|
||||
</section>
|
||||
<section class="row-fluid protected">
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Connect.html#method_parseResponse" class="">parseResponse()</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Connect.html#property_client" class="">$client</a><br />
|
||||
<a href="../classes/Radar.Connect.Connect.html#property_cache" class="">$cache</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/Connect.html"><div class="path-wrapper">Connect.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">\Radar\Connect\Connect</div>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></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_apiUrl" name="property_apiUrl" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$apiUrl</h3>
|
||||
<pre class="signature">$apiUrl : string</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
string
|
||||
— URL of API endpoint. </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="property_debug" name="property_debug" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$debug</h3>
|
||||
<pre class="signature">$debug : boolean</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
boolean
|
||||
— Debug switch true for verbose. </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="property_client" name="property_client" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="protected ">$client</h3>
|
||||
<pre class="signature">$client : \Guzzle\Http\ClientInterface</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
\Guzzle\Http\ClientInterface
|
||||
— Guzzle HTTP Client </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="property_cache" name="property_cache" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="protected ">$cache</h3>
|
||||
<pre class="signature">$cache : \Radar\Connect\Cache</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
<a href="../classes/Radar.Connect.Cache.html">\Radar\Connect\Cache</a>
|
||||
— Doctrine cache for entities. </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(\Guzzle\Http\ClientInterface <span class="argument">$client</span>, array <span class="argument">$configuration = array()</span>) </pre>
|
||||
<p><em>Constructor.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>\Guzzle\Http\ClientInterface</td>
|
||||
<td>$client </td>
|
||||
<td><p>Guzzle HTTP Client.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>$configuration </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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___call" name="method___call" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">__call()</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;">__call( <span class="argument">$name</span>, <span class="argument">$arguments</span>) </pre>
|
||||
<p><em>For now also just allow direct access to guzzle itself.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$name </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$arguments </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_setCache" name="method_setCache" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">setCache()</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;">setCache(\Radar\Connect\Cache <span class="argument">$cache</span>) </pre>
|
||||
<p><em>Set a cache to store entities.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Cache.html">\Radar\Connect\Cache</a></td>
|
||||
<td>$cache </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_retrieveEntity" name="method_retrieveEntity" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">retrieveEntity()</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;">retrieveEntity(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) : \Radar\Connect\Entity\Entity</pre>
|
||||
<p><em>Retrieve all fields for single entity.</em></p>
|
||||
<p>Entities can be partly loaded. Especially when just a reference on
|
||||
an event or group. Use this to retrieve the full entity.
|
||||
If there is a cache set, and the entity is still validly cached
|
||||
this will be returned rather than making a new query.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td><p>The partly loaded entity.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a>
|
||||
— <p>The loaded entity.</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_retrieveEntityMultiple" name="method_retrieveEntityMultiple" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">retrieveEntityMultiple()</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;">retrieveEntityMultiple(array<mixed,\Radar\Connect\Entity\Entity> <span class="argument">$entities</span>) : array<mixed,\Radar\Connect\Entity\Entity></pre>
|
||||
<p><em>Retrieve all fields for multiple entities.</em></p>
|
||||
<p>As retrieveEntity(), but making multiple concurrent requests.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>array<mixed,<a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a>></td>
|
||||
<td>$entities </td>
|
||||
<td><p>Array of partly loaded entities.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
array<mixed,<a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a>>
|
||||
— <p>Array of loaded entities.</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_putEntity" name="method_putEntity" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">putEntity()</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;">putEntity(\Radar\Connect\Entity\Entity <span class="argument">$entity</span>) </pre>
|
||||
<p><em>TODO Insert or update an existing Entity.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a></td>
|
||||
<td>$entity </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_prepareEventsRequest" name="method_prepareEventsRequest" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">prepareEventsRequest()</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;">prepareEventsRequest(\Radar\Connect\Filter <span class="argument">$filter</span>, array <span class="argument">$fields = array()</span>, integer <span class="argument">$limit = 500</span>) : \Guzzle\Http\Message\Request</pre>
|
||||
<p><em>Prepare a request to retrieve events.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Filter.html">\Radar\Connect\Filter</a></td>
|
||||
<td>$filter </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>$fields </td>
|
||||
<td><p>A list of fields to load. Optional, default is most available fields.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$limit </td>
|
||||
<td><p>How many events to return.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
\Guzzle\Http\Message\Request
|
||||
— <p>Request object to retrieve.</p>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Radar.Connect.Connect.html#method_retrieve"><span class="namespace-wrapper"></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_prepareGroupsRequest" name="method_prepareGroupsRequest" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">prepareGroupsRequest()</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;">prepareGroupsRequest(\Radar\Connect\Filter <span class="argument">$filter</span>, array <span class="argument">$fields = array()</span>, integer <span class="argument">$limit = 500</span>) : \Guzzle\Http\Message\Request</pre>
|
||||
<p><em>Prepare a request to retrieve groups.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td><a href="../classes/Radar.Connect.Filter.html">\Radar\Connect\Filter</a></td>
|
||||
<td>$filter </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>$fields </td>
|
||||
<td><p>A list of fields to load. Optional, default is most available fields.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$limit </td>
|
||||
<td><p>How many groups to return.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
\Guzzle\Http\Message\Request
|
||||
— <p>Request object to retrieve.</p>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Radar.Connect.Connect.html#method_retrieve"><span class="namespace-wrapper"></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_retrieve" name="method_retrieve" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">retrieve()</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;">retrieve(\Guzzle\Http\Message\RequestInterface <span class="argument">$request</span>) : array<mixed,\Radar\Connect\Entity\Entity></pre>
|
||||
<p><em>Retrieve entities from a prepared request.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>\Guzzle\Http\Message\RequestInterface</td>
|
||||
<td>$request </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
array<mixed,<a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a>>
|
||||
|
||||
</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_retrieveMultiple" name="method_retrieveMultiple" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">retrieveMultiple()</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;">retrieveMultiple(array<mixed,\Guzzle\Http\Message\RequestInterface> <span class="argument">$requests</span>) : array<mixed,\Radar\Connect\Entity\Entity></pre>
|
||||
<p><em>Retrieve entities from multiple prepared requests.</em></p>
|
||||
<p>Results are merged into one entity array.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>array<mixed,\Guzzle\Http\Message\RequestInterface></td>
|
||||
<td>$requests </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
array<mixed,<a href="../classes/Radar.Connect.Entity.Entity.html">\Radar\Connect\Entity\Entity</a>>
|
||||
|
||||
</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_parseResponse" name="method_parseResponse" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="protected ">parseResponse()</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;">parseResponse(\Guzzle\Http\Message\Response <span class="argument">$response</span>) </pre>
|
||||
<p><em>Parse a response from the client.</em></p>
|
||||
<p>TODO this doesn't need to be in here.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>\Guzzle\Http\Message\Response</td>
|
||||
<td>$response </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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">Connect.php</h3>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<pre data-src="../files/Connect.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/Radar.html">\Radar</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 February 22nd, 2015 at 11:34.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
811
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Entity.html
vendored
Normal file
811
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Entity.html
vendored
Normal file
|
|
@ -0,0 +1,811 @@
|
|||
<!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/Radar.html">\Radar</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">146</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</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-550195720"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-550195720" 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-1950595330"></a>
|
||||
<a href="../namespaces/Radar.html" style="margin-left: 30px; padding-left: 0">Radar</a>
|
||||
</div>
|
||||
<div id="namespace-1950595330" 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-756229370"></a>
|
||||
<a href="../namespaces/Radar.Connect.html" style="margin-left: 30px; padding-left: 0">Connect</a>
|
||||
</div>
|
||||
<div id="namespace-756229370" 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-1122654019"></a>
|
||||
<a href="../namespaces/Radar.Connect.Entity.html" style="margin-left: 30px; padding-left: 0">Entity</a>
|
||||
</div>
|
||||
<div id="namespace-1122654019" class="accordion-body collapse ">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Entity.html">Entity</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Event.html">Event</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Group.html">Group</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.ListingsGroup.html">ListingsGroup</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Location.html">Location</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Node.html">Node</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.TaxonomyTerm.html">TaxonomyTerm</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Cache.html">Cache</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Connect.html">Connect</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Filter.html">Filter</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/Radar.Connect.Entity.html">\Radar\Connect\Entity</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>\Radar\Connect\Entity</small>Entity</h1>
|
||||
<p><em></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/Radar.Connect.Entity.Entity.html#method_className" class="">className()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method___construct" class="">__construct()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_set" class="">set()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_apiUri" class="">apiUri()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_getUuid" class="">getUuid()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_getVuuid" class="">getVuuid()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_getInternalId" class="">getInternalId()</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#method_getInternalVid" class="">getInternalVid()</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_drupalId" class="">$drupalId</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_drupalVersionId" class="">$drupalVersionId</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_uuid" class="">$uuid</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_vuuid" class="">$vuuid</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_type" class="">$type</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<em>No constants found</em>
|
||||
</section>
|
||||
</section>
|
||||
<section class="row-fluid protected">
|
||||
<section class="span4">
|
||||
<em>No protected methods found</em>
|
||||
</section>
|
||||
<section class="span4">
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_apiUri" class="">$apiUri</a><br />
|
||||
<a href="../classes/Radar.Connect.Entity.Entity.html#property_apiBase" class="">$apiBase</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">
|
||||
<span class="label label-info">abstract</span>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>File</dt>
|
||||
<dd><a href="../files/Entity.Entity.html"><div class="path-wrapper">Entity/Entity.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">\Radar\Connect\Entity\Entity</div>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></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_drupalId" name="property_drupalId" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$drupalId</h3>
|
||||
<pre class="signature">$drupalId : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_drupalVersionId" name="property_drupalVersionId" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$drupalVersionId</h3>
|
||||
<pre class="signature">$drupalVersionId : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_uuid" name="property_uuid" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$uuid</h3>
|
||||
<pre class="signature">$uuid : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_vuuid" name="property_vuuid" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$vuuid</h3>
|
||||
<pre class="signature">$vuuid : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_type" name="property_type" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="public ">$type</h3>
|
||||
<pre class="signature">$type : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_apiUri" name="property_apiUri" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="protected ">$apiUri</h3>
|
||||
<pre class="signature">$apiUri : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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="property_apiBase" name="property_apiBase" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="protected ">$apiBase</h3>
|
||||
<pre class="signature">$apiBase : </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</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_className" name="method_className" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">className()</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;">className( <span class="argument">$type</span>) </pre>
|
||||
<p><em>TODO move this to the controller Connect class.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$type </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<span class="label label-info">static</span>
|
||||
<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___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( <span class="argument">$data = array()</span>) </pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$data </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<span class="label label-info">abstract</span>
|
||||
<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_set" name="method_set" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">set()</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;">set(array <span class="argument">$data</span>) </pre>
|
||||
<p><em>Set data for entity.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>$data </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_apiUri" name="method_apiUri" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">apiUri()</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;">apiUri() : string</pre>
|
||||
<p><em>Return the API URI for this entity.</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
string
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<span class="label label-info">abstract</span>
|
||||
<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_getUuid" name="method_getUuid" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getUuid()</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;">getUuid() : string|null</pre>
|
||||
<p><em>Return the UUID for the entity.</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
string|null
|
||||
|
||||
</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_getVuuid" name="method_getVuuid" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getVuuid()</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;">getVuuid() : string|null</pre>
|
||||
<p><em>Return the Version UUID for the entity.</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
string|null
|
||||
|
||||
</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_getInternalId" name="method_getInternalId" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getInternalId()</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;">getInternalId() : integer|null</pre>
|
||||
<p><em>Return the Drupal internal ID for the entity.</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
integer|null
|
||||
|
||||
</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_getInternalVid" name="method_getInternalVid" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getInternalVid()</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;">getInternalVid() : integer|null</pre>
|
||||
<p><em>Return the Drupal internal version ID for the entity.</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
integer|null
|
||||
|
||||
</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">Entity.php</h3>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<pre data-src="../files/Entity/Entity.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/Radar.html">\Radar</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 February 22nd, 2015 at 11:34.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
2144
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Event.html
vendored
Normal file
2144
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Event.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
2023
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Group.html
vendored
Normal file
2023
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Group.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
1970
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.ListingsGroup.html
vendored
Normal file
1970
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.ListingsGroup.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
1181
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Location.html
vendored
Normal file
1181
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Location.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
1458
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Node.html
vendored
Normal file
1458
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.Node.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
1017
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.TaxonomyTerm.html
vendored
Normal file
1017
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Entity.TaxonomyTerm.html
vendored
Normal file
File diff suppressed because it is too large
Load diff
766
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Filter.html
vendored
Normal file
766
vendor/events-radar/radar-api-php/docs/classes/Radar.Connect.Filter.html
vendored
Normal file
|
|
@ -0,0 +1,766 @@
|
|||
<!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/Radar.html">\Radar</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">146</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</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-1643600059"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1643600059" 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-1469084762"></a>
|
||||
<a href="../namespaces/Radar.html" style="margin-left: 30px; padding-left: 0">Radar</a>
|
||||
</div>
|
||||
<div id="namespace-1469084762" 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-1534935600"></a>
|
||||
<a href="../namespaces/Radar.Connect.html" style="margin-left: 30px; padding-left: 0">Connect</a>
|
||||
</div>
|
||||
<div id="namespace-1534935600" 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-757609820"></a>
|
||||
<a href="../namespaces/Radar.Connect.Entity.html" style="margin-left: 30px; padding-left: 0">Entity</a>
|
||||
</div>
|
||||
<div id="namespace-757609820" class="accordion-body collapse ">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Entity.html">Entity</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Event.html">Event</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Group.html">Group</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.ListingsGroup.html">ListingsGroup</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Location.html">Location</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.Node.html">Node</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Entity.TaxonomyTerm.html">TaxonomyTerm</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Cache.html">Cache</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Connect.html">Connect</a></li>
|
||||
<li class="class"><a href="../classes/Radar.Connect.Filter.html">Filter</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/Radar.Connect.html">\Radar\Connect</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>\Radar\Connect</small>Filter</h1>
|
||||
<p><em></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/Radar.Connect.Filter.html#method_addGroup" class="">addGroup()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addCountry" class="">addCountry()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addCity" class="">addCity()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addYear" class="">addYear()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addMonth" class="">addMonth()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addDay" class="">addDay()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addDate" class="">addDate()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addCategory" class="">addCategory()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_addPrice" class="">addPrice()</a><br />
|
||||
<a href="../classes/Radar.Connect.Filter.html#method_getQuery" class="">getQuery()</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">
|
||||
<em>No protected methods found</em>
|
||||
</section>
|
||||
<section class="span4">
|
||||
<em>No protected properties found</em>
|
||||
</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">
|
||||
<a href="../classes/Radar.Connect.Filter.html#property_query" class="">$query</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
<em>N/A</em>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>File</dt>
|
||||
<dd><a href="../files/Filter.html"><div class="path-wrapper">Filter.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">\Radar\Connect\Filter</div>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></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_query" name="property_query" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="private ">$query</h3>
|
||||
<pre class="signature">$query : array</pre>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
array
|
||||
— Query stack. </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_addGroup" name="method_addGroup" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addGroup()</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;">addGroup(integer <span class="argument">$id</span>) </pre>
|
||||
<p><em>Filter by group.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$id </td>
|
||||
<td><p>Presently requires the internal node ID, not the uuid.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addCountry" name="method_addCountry" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addCountry()</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;">addCountry(string <span class="argument">$country</span>) </pre>
|
||||
<p><em>Filter by country.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$country </td>
|
||||
<td><p>Country code. Generally ISO, but there are additions.
|
||||
@todo Make a query or a list for this.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addCity" name="method_addCity" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addCity()</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;">addCity(string <span class="argument">$city</span>) </pre>
|
||||
<p><em>Filter by city.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$city </td>
|
||||
<td><p>Name of city.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addYear" name="method_addYear" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addYear()</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;">addYear( <span class="argument">$year = 'now'</span>) </pre>
|
||||
<p><em>Filter by year.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$year </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addMonth" name="method_addMonth" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addMonth()</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;">addMonth(string <span class="argument">$month = 'now'</span>, string <span class="argument">$year = 'now'</span>) </pre>
|
||||
<p><em>Filter by month.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$month </td>
|
||||
<td><p>Optional: month in MM numeric format. Default current month.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$year </td>
|
||||
<td><p>Optional: year in YYYY format. Default current year.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addDay" name="method_addDay" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addDay()</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;">addDay( <span class="argument">$day = 'now'</span>, string <span class="argument">$month = 'now'</span>, string <span class="argument">$year = 'now'</span>) </pre>
|
||||
<p><em>Filter by day.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$day </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$month </td>
|
||||
<td><p>Optional: month in MM numeric format. Default current month.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$year </td>
|
||||
<td><p>Optional: year in YYYY format. Default current year.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addDate" name="method_addDate" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addDate()</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;">addDate(\DateTime <span class="argument">$date</span>) </pre>
|
||||
<p><em>Filter by date.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>\DateTime</td>
|
||||
<td>$date </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addCategory" name="method_addCategory" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addCategory()</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;">addCategory( <span class="argument">$category</span>) </pre>
|
||||
<p><em>Filter by category.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>$category </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_addPrice" name="method_addPrice" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">addPrice()</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;">addPrice(string <span class="argument">$price</span>) </pre>
|
||||
<p><em>Filter by price.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$price </td>
|
||||
<td><p>'free entrance', 'by donation', other strings entered as free text.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</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_getQuery" name="method_getQuery" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getQuery()</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;">getQuery() </pre>
|
||||
<p><em>Return the query array.</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>
|
||||
</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">Filter.php</h3>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<pre data-src="../files/Filter.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/Radar.html">\Radar</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 February 22nd, 2015 at 11:34.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue