Skip to content

Commit 84a7263

Browse files
apemselapemsel
committed
update documentation
1 parent 14618a9 commit 84a7263

4 files changed

Lines changed: 110 additions & 10 deletions

‎doc/class-apemsel.AttributedString.AttributedString.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1185,7 +1185,7 @@ <h4>Implementation of</h4>
11851185
<tr data-order="attributes" id="$attributes">
11861186
<td class="attributes"><code>
11871187
protected
1188-
1188+
array
11891189
</code></td>
11901190

11911191
<td class="name">
@@ -1203,7 +1203,7 @@ <h4>Implementation of</h4>
12031203
<td class="value">
12041204
<div>
12051205
<a href="#$attributes" class="anchor">#</a>
1206-
<code></code>
1206+
<code>[]</code>
12071207
</div>
12081208
</td>
12091209
</tr>

‎doc/class-apemsel.AttributedString.MutableAttributedString.html‎

Lines changed: 83 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1>Class MutableAttributedString</h1>
126126

127127
<b>Author:</b>
128128
Adrian Pemsel <a href="&#x6d;&#x61;&#x69;&#x6c;&#116;&#111;&#58;&#97;&#112;&#x65;&#x6d;&#x73;&#x65;&#x6c;&#64;&#103;&#109;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#x6d;">&#97;&#112;&#x65;&#x6d;&#x73;&#x65;&#x6c;&#64;&#103;&#109;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#x6d;</a><br>
129-
<b>Located at</b> <a href="source-class-apemsel.AttributedString.MutableAttributedString.html#4-116" title="Go to source code">MutableAttributedString.php</a>
129+
<b>Located at</b> <a href="source-class-apemsel.AttributedString.MutableAttributedString.html#4-136" title="Go to source code">MutableAttributedString.php</a>
130130
<br>
131131
</div>
132132

@@ -255,6 +255,88 @@ <h4>See</h4>
255255
</div>
256256
</div></td>
257257
</tr>
258+
<tr data-order="offsetSet" id="_offsetSet">
259+
260+
<td class="attributes"><code>
261+
public
262+
263+
264+
</code>
265+
</td>
266+
267+
<td class="name"><div>
268+
<a class="anchor" href="#_offsetSet">#</a>
269+
<code><a href="source-class-apemsel.AttributedString.MutableAttributedString.html#119-126" title="Go to source code">offsetSet</a>( <span>integer <var>$offset</var></span>, <span> <var>$value</var></span> )</code>
270+
271+
<div class="description short">
272+
<p>Replace char at given offset</p>
273+
</div>
274+
275+
<div class="description detailed hidden">
276+
<p>Replace char at given offset</p>
277+
278+
279+
<h4>Parameters</h4>
280+
<div class="list"><dl>
281+
<dt><var>$offset</var></dt>
282+
<dd>offset</dd>
283+
<dt><var>$value</var></dt>
284+
<dd></dd>
285+
</dl></div>
286+
287+
288+
<h4>Throws</h4>
289+
<div class="list">
290+
InvalidArgumentException<br>always
291+
</div>
292+
293+
294+
<h4>Overrides</h4>
295+
<div class="list"><code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetSet">apemsel\AttributedString\AttributedString::offsetSet</a></code></div>
296+
297+
</div>
298+
</div></td>
299+
</tr>
300+
<tr data-order="offsetUnset" id="_offsetUnset">
301+
302+
<td class="attributes"><code>
303+
public
304+
305+
306+
</code>
307+
</td>
308+
309+
<td class="name"><div>
310+
<a class="anchor" href="#_offsetUnset">#</a>
311+
<code><a href="source-class-apemsel.AttributedString.MutableAttributedString.html#128-135" title="Go to source code">offsetUnset</a>( <span>integer <var>$offset</var></span> )</code>
312+
313+
<div class="description short">
314+
<p>Unset char at given offset</p>
315+
</div>
316+
317+
<div class="description detailed hidden">
318+
<p>Unset char at given offset</p>
319+
320+
321+
<h4>Parameters</h4>
322+
<div class="list"><dl>
323+
<dt><var>$offset</var></dt>
324+
<dd>offset</dd>
325+
</dl></div>
326+
327+
328+
<h4>Throws</h4>
329+
<div class="list">
330+
InvalidArgumentException<br>always
331+
</div>
332+
333+
334+
<h4>Overrides</h4>
335+
<div class="list"><code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetUnset">apemsel\AttributedString\AttributedString::offsetUnset</a></code></div>
336+
337+
</div>
338+
</div></td>
339+
</tr>
258340
</table>
259341
</div>
260342

@@ -278,8 +360,6 @@ <h4>See</h4>
278360
<code><a href="class-apemsel.AttributedString.AttributedString.html#_is">is()</a></code>,
279361
<code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetExists">offsetExists()</a></code>,
280362
<code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetGet">offsetGet()</a></code>,
281-
<code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetSet">offsetSet()</a></code>,
282-
<code><a href="class-apemsel.AttributedString.AttributedString.html#_offsetUnset">offsetUnset()</a></code>,
283363
<code><a href="class-apemsel.AttributedString.AttributedString.html#_searchAttribute">searchAttribute()</a></code>,
284364
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setLength">setLength()</a></code>,
285365
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setPattern">setPattern()</a></code>,

‎doc/source-class-apemsel.AttributedString.AttributedString.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3>Classes</h3>
9595
</span><span id="11" class="l"><a href="#11"> 11 </a><span class="php-keyword1">class</span> AttributedString <span class="php-keyword1">implements</span> \Countable, \ArrayAccess
9696
</span><span id="12" class="l"><a href="#12"> 12 </a>{
9797
</span><span id="13" class="l"><a href="#13"> 13 </a> <span class="php-keyword1">protected</span> <span class="php-var">$string</span>;
98-
</span><span id="14" class="l"><a href="#14"> 14 </a> <span class="php-keyword1">protected</span> <span class="php-var">$attributes</span>;
98+
</span><span id="14" class="l"><a href="#14"> 14 </a> <span class="php-keyword1">protected</span> <span class="php-var">$attributes</span> = [];
9999
</span><span id="15" class="l"><a href="#15"> 15 </a> <span class="php-keyword1">protected</span> <span class="php-var">$length</span>;
100100
</span><span id="16" class="l"><a href="#16"> 16 </a> <span class="php-keyword1">protected</span> <span class="php-var">$byteToChar</span>;
101101
</span><span id="17" class="l"><a href="#17"> 17 </a>

‎doc/source-class-apemsel.AttributedString.MutableAttributedString.html‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ <h3>Classes</h3>
135135
</span></span><span id="51" class="l"><a href="#51"> 51 </a><span class="php-comment"> */</span>
136136
</span><span id="52" class="l"><a href="#52"> 52 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$pos</span>, <span class="php-var">$length</span>) {
137137
</span><span id="53" class="l"><a href="#53"> 53 </a> <span class="php-var">$leftPart</span> = <span class="php-quote">&quot;&quot;</span>;
138-
</span><span id="54" class="l"><a href="#54"> 54 </a> <span class="php-keyword1">if</span> (<span class="php-var">$pos</span> &gt; <span class="php-num">0</span>) {
139-
</span><span id="55" class="l"><a href="#55"> 55 </a> <span class="php-var">$leftPart</span> = <span class="php-keyword2">mb_substr</span>(<span class="php-var">$this</span>-&gt;string, <span class="php-num">0</span>, <span class="php-var">$pos</span> - <span class="php-num">1</span>, <span class="php-quote">&quot;utf-8&quot;</span>);
138+
</span><span id="54" class="l"><a href="#54"> 54 </a> <span class="php-keyword1">if</span> (<span class="php-var">$pos</span> &gt;= <span class="php-num">0</span>) {
139+
</span><span id="55" class="l"><a href="#55"> 55 </a> <span class="php-var">$leftPart</span> = <span class="php-keyword2">mb_substr</span>(<span class="php-var">$this</span>-&gt;string, <span class="php-num">0</span>, <span class="php-var">$pos</span>, <span class="php-quote">&quot;utf-8&quot;</span>);
140140
</span><span id="56" class="l"><a href="#56"> 56 </a> }
141141
</span><span id="57" class="l"><a href="#57"> 57 </a>
142142
</span><span id="58" class="l"><a href="#58"> 58 </a> <span class="php-var">$rightPart</span> = <span class="php-quote">&quot;&quot;</span>;
@@ -197,8 +197,28 @@ <h3>Classes</h3>
197197
</span><span id="113" class="l"><a href="#113">113 </a>
198198
</span><span id="114" class="l"><a href="#114">114 </a> <span class="php-keyword1">return</span> <span class="php-keyword2">join</span>(<span class="php-var">$smatches</span>[<span class="php-num">0</span>]);
199199
</span><span id="115" class="l"><a href="#115">115 </a> }
200-
</span><span id="116" class="l"><a href="#116">116 </a>}
201-
</span><span id="117" class="l"><a href="#117">117 </a></span></code></pre>
200+
</span><span id="116" class="l"><a href="#116">116 </a>
201+
</span><span id="117" class="l"><a href="#117">117 </a> <span class="php-comment">// Modified ArrayAccess interface</span>
202+
</span><span id="118" class="l"><a href="#118">118 </a>
203+
</span><span id="119" class="l"><a href="#119">119 </a> <span class="php-comment">/**
204+
</span></span><span id="120" class="l"><a href="#120">120 </a><span class="php-comment"> * Replace char at given offset
205+
</span></span><span id="121" class="l"><a href="#121">121 </a><span class="php-comment"> *
206+
</span></span><span id="122" class="l"><a href="#122">122 </a><span class="php-comment"> * @param int $offset offset
207+
</span></span><span id="123" class="l"><a href="#123">123 </a><span class="php-comment"> */</span>
208+
</span><span id="124" class="l"><a href="#124">124 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> offsetSet(<span class="php-var">$offset</span>, <span class="php-var">$value</span>) {
209+
</span><span id="125" class="l"><a href="#125">125 </a> <span class="php-var">$this</span>-&gt;string = self::mb_substr_replace(<span class="php-var">$this</span>-&gt;string, <span class="php-var">$value</span>, <span class="php-var">$offset</span>, <span class="php-keyword2">mb_strlen</span>(<span class="php-var">$value</span>, <span class="php-quote">&quot;utf-8&quot;</span>));
210+
</span><span id="126" class="l"><a href="#126">126 </a> }
211+
</span><span id="127" class="l"><a href="#127">127 </a>
212+
</span><span id="128" class="l"><a href="#128">128 </a> <span class="php-comment">/**
213+
</span></span><span id="129" class="l"><a href="#129">129 </a><span class="php-comment"> * Unset char at given offset
214+
</span></span><span id="130" class="l"><a href="#130">130 </a><span class="php-comment"> *
215+
</span></span><span id="131" class="l"><a href="#131">131 </a><span class="php-comment"> * @param int $offset offset
216+
</span></span><span id="132" class="l"><a href="#132">132 </a><span class="php-comment"> */</span>
217+
</span><span id="133" class="l"><a href="#133">133 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> offsetUnset(<span class="php-var">$offset</span>) {
218+
</span><span id="134" class="l"><a href="#134">134 </a> <span class="php-var">$this</span>-&gt;<span class="php-keyword2">delete</span>(<span class="php-var">$offset</span>, <span class="php-num">1</span>);
219+
</span><span id="135" class="l"><a href="#135">135 </a> }
220+
</span><span id="136" class="l"><a href="#136">136 </a>}
221+
</span><span id="137" class="l"><a href="#137">137 </a></span></code></pre>
202222
</div>
203223

204224
<div id="footer">

0 commit comments

Comments
 (0)