streams/doc/html/classRedmatrix_1_1Import_1_1Import.html
2014-11-01 00:36:01 -07:00

407 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>The Red Matrix: Redmatrix\Import\Import Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="rm-64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">The Red Matrix
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classRedmatrix_1_1Import_1_1Import.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classRedmatrix_1_1Import_1_1Import-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Redmatrix\Import\Import Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a76dd522e47a48d80e1678211230f2ff5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a76dd522e47a48d80e1678211230f2ff5">get_credentials</a> ()</td></tr>
<tr class="separator:a76dd522e47a48d80e1678211230f2ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1af46c9f88257635f362d6027ea710c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a1af46c9f88257635f362d6027ea710c3">get_itemlist</a> ()</td></tr>
<tr class="separator:a1af46c9f88257635f362d6027ea710c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4420d6acf6ba2f3723c655251b12abef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a4420d6acf6ba2f3723c655251b12abef">get_item_ident</a> ($item)</td></tr>
<tr class="separator:a4420d6acf6ba2f3723c655251b12abef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae705dd1deb245b1d06baa73062330e43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#ae705dd1deb245b1d06baa73062330e43">get_item</a> ($item_ident)</td></tr>
<tr class="separator:ae705dd1deb245b1d06baa73062330e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1e4a1d404b5a5a9c518c205d1428154"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#ab1e4a1d404b5a5a9c518c205d1428154">get_taxonomy</a> ($item_ident)</td></tr>
<tr class="separator:ab1e4a1d404b5a5a9c518c205d1428154"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a832a4cc0d33d0eea29cb450004054580"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a832a4cc0d33d0eea29cb450004054580">get_children</a> ($item_ident)</td></tr>
<tr class="separator:a832a4cc0d33d0eea29cb450004054580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add4d39232c883b59634595be14441336"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#add4d39232c883b59634595be14441336">convert_item</a> ($item_ident)</td></tr>
<tr class="separator:add4d39232c883b59634595be14441336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a54b41c30aed8ac9ca6e486fd0b4b97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a5a54b41c30aed8ac9ca6e486fd0b4b97">convert_taxonomy</a> ($item_ident)</td></tr>
<tr class="separator:a5a54b41c30aed8ac9ca6e486fd0b4b97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9c6677ea07c496d81914b97aeb5fba5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#ad9c6677ea07c496d81914b97aeb5fba5">convert_child</a> ($child)</td></tr>
<tr class="separator:ad9c6677ea07c496d81914b97aeb5fba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70f9dd767d877530a7da7c6bd821e080"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a70f9dd767d877530a7da7c6bd821e080">store</a> ($item, $update=false)</td></tr>
<tr class="separator:a70f9dd767d877530a7da7c6bd821e080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af432ecbc45b812a03d58dfb378a212f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">run</a> ()</td></tr>
<tr class="separator:af432ecbc45b812a03d58dfb378a212f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afd251e6e5a18516bac4d1a40435602f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#afd251e6e5a18516bac4d1a40435602f1">$credentials</a> = null</td></tr>
<tr class="separator:afd251e6e5a18516bac4d1a40435602f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f69f16ecb7de1fb1daffbc38e68c9f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a2f69f16ecb7de1fb1daffbc38e68c9f1">$itemlist</a> = null</td></tr>
<tr class="separator:a2f69f16ecb7de1fb1daffbc38e68c9f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac578e85e4c491bf9e09fbbfa33f9d6b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#ac578e85e4c491bf9e09fbbfa33f9d6b7">$src_items</a> = null</td></tr>
<tr class="separator:ac578e85e4c491bf9e09fbbfa33f9d6b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31d73d48e1aa93319159c692d0197a3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRedmatrix_1_1Import_1_1Import.html#a31d73d48e1aa93319159c692d0197a3a">$items</a> = null</td></tr>
<tr class="separator:a31d73d48e1aa93319159c692d0197a3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad9c6677ea07c496d81914b97aeb5fba5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::convert_child </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$child</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="add4d39232c883b59634595be14441336"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::convert_item </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item_ident</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="a5a54b41c30aed8ac9ca6e486fd0b4b97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::convert_taxonomy </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item_ident</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="a832a4cc0d33d0eea29cb450004054580"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_children </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item_ident</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="a76dd522e47a48d80e1678211230f2ff5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_credentials </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="ae705dd1deb245b1d06baa73062330e43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_item </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item_ident</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="a4420d6acf6ba2f3723c655251b12abef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_item_ident </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1af46c9f88257635f362d6027ea710c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_itemlist </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="ab1e4a1d404b5a5a9c518c205d1428154"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::get_taxonomy </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item_ident</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRedmatrix_1_1Import_1_1Import.html#af432ecbc45b812a03d58dfb378a212f7">Redmatrix\Import\Import\run()</a>.</p>
</div>
</div>
<a class="anchor" id="af432ecbc45b812a03d58dfb378a212f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a70f9dd767d877530a7da7c6bd821e080"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::store </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$update</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afd251e6e5a18516bac4d1a40435602f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::$credentials = null</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2f69f16ecb7de1fb1daffbc38e68c9f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::$itemlist = null</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a31d73d48e1aa93319159c692d0197a3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::$items = null</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac578e85e4c491bf9e09fbbfa33f9d6b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Redmatrix\Import\Import::$src_items = null</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/Import/<a class="el" href="Importer_8php.html">Importer.php</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->