<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Insert into a list</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sdo-exception.getcause.html">SDO_Exception::getCause</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sdo-model-property.getcontainingtype.html">SDO_Model_Property::getContainingType</a></div>
<div class="up"><a href="ref.sdo.html">SDO Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="sdo-list.insert" class="refentry">
<div class="refnamediv">
<h1 class="refname">SDO_List::insert</h1>
<p class="verinfo">(^)</p><p class="refpurpose"><span class="refname">SDO_List::insert</span> — <span class="dc-title">
Insert into a list
</span></p>
</div>
<div class="refsect1 description" id="refsect1-sdo-list.insert-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SDO_List::insert</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
] )</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
<p class="para">
Insert a new element at a specified position in the list.
All subsequent list items are moved up.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-sdo-list.insert-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">value</code></em>
</span>
<dd>
<p class="para">
The new value to be inserted.
This can be either a primitive or an SDO_DataObject.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">index</code></em>
</span>
<dd>
<p class="para">
The position at which to insert the new element.
If this argument is not specified then the new value will be appended.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-sdo-list.insert-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
None.
</p>
</div>
<div class="refsect1 errors" id="refsect1-sdo-list.insert-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">SDO_IndexOutOfBoundsException</code></em>
</span>
<dd>
<p class="para">
Thrown if the list index is less than zero or greater
than the size of the list.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">SDO_InvalidConversionException</code></em>
</span>
<dd>
<p class="para">
Thrown if the type of the new value does not match the type
for the list
(e.g. the type of the many-valued property that the list represents).
</p>
</dd>
</dt>
</dl>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sdo-exception.getcause.html">SDO_Exception::getCause</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sdo-model-property.getcontainingtype.html">SDO_Model_Property::getContainingType</a></div>
<div class="up"><a href="ref.sdo.html">SDO Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
