Skip to content

Commit 23cc6a3

Browse files
github-actions[bot]github-actions[bot]
committed
CI: Automated build push
1 parent e4410c6 commit 23cc6a3

File tree

107 files changed

+33670
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+33670
-0
lines changed

‎docs/Classes.html

+871
Large diffs are not rendered by default.

‎docs/Classes/PluralUtils.html

+282
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,282 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>PluralUtils Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
<a name="//apple_ref/swift/Class/PluralUtils" class="dashAnchor"></a>
17+
<a title="PluralUtils Class Reference"></a>
18+
<header>
19+
<div class="content-wrapper">
20+
<p><a href="../index.html">Transifex Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/transifex/transifex-swift"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</div>
27+
</div>
28+
</header>
29+
<div class="content-wrapper">
30+
<p id="breadcrumbs">
31+
<a href="../index.html">Transifex</a>
32+
<img id="carat" src="../img/carat.png" alt=""/>
33+
<a href="../Classes.html">Classes</a>
34+
<img id="carat" src="../img/carat.png" alt=""/>
35+
PluralUtils Class Reference
36+
</p>
37+
</div>
38+
<div class="content-wrapper">
39+
<nav class="sidebar">
40+
<ul class="nav-groups">
41+
<li class="nav-group-name">
42+
<a href="../Classes.html">Classes</a>
43+
<ul class="nav-group-tasks">
44+
<li class="nav-group-task">
45+
<a href="../Classes/PluralUtils.html">PluralUtils</a>
46+
</li>
47+
<li class="nav-group-task">
48+
<a href="../Classes/TXCompositePolicy.html">TXCompositePolicy</a>
49+
</li>
50+
<li class="nav-group-task">
51+
<a href="../Classes/TXDecoratorCache.html">TXDecoratorCache</a>
52+
</li>
53+
<li class="nav-group-task">
54+
<a href="../Classes/TXDiskCacheProvider.html">TXDiskCacheProvider</a>
55+
</li>
56+
<li class="nav-group-task">
57+
<a href="../Classes/TXFileOutputCacheDecorator.html">TXFileOutputCacheDecorator</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a href="../Classes/TXLocaleState.html">TXLocaleState</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../Classes/TXLogger.html">TXLogger</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a href="../Classes/TXMemoryCache.html">TXMemoryCache</a>
67+
</li>
68+
<li class="nav-group-task">
69+
<a href="../Classes/TXNative.html">TXNative</a>
70+
</li>
71+
<li class="nav-group-task">
72+
<a href="../Classes/TXNoOpCache.html">TXNoOpCache</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a href="../Classes/TXPreferredLocaleProvider.html">TXPreferredLocaleProvider</a>
76+
</li>
77+
<li class="nav-group-task">
78+
<a href="../Classes/TXProviderBasedCache.html">TXProviderBasedCache</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a href="../Classes/TXPseudoTranslationPolicy.html">TXPseudoTranslationPolicy</a>
82+
</li>
83+
<li class="nav-group-task">
84+
<a href="../Classes/TXPushConfiguration.html">TXPushConfiguration</a>
85+
</li>
86+
<li class="nav-group-task">
87+
<a href="../Classes/TXReadonlyCacheDecorator.html">TXReadonlyCacheDecorator</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a href="../Classes/TXRenderedSourceErrorPolicy.html">TXRenderedSourceErrorPolicy</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a href="../Classes/TXSourceString.html">TXSourceString</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a href="../Classes/TXSourceStringPolicy.html">TXSourceStringPolicy</a>
97+
</li>
98+
<li class="nav-group-task">
99+
<a href="../Classes/TXStandardCache.html">TXStandardCache</a>
100+
</li>
101+
<li class="nav-group-task">
102+
<a href="../Classes/TXStandardLogHandler.html">TXStandardLogHandler</a>
103+
</li>
104+
<li class="nav-group-task">
105+
<a href="../Classes/TXStringUpdateFilterCache.html">TXStringUpdateFilterCache</a>
106+
</li>
107+
<li class="nav-group-task">
108+
<a href="../Classes/TXWrappedStringPolicy.html">TXWrappedStringPolicy</a>
109+
</li>
110+
</ul>
111+
</li>
112+
<li class="nav-group-name">
113+
<a href="../Enums.html">Enumerations</a>
114+
<ul class="nav-group-tasks">
115+
<li class="nav-group-task">
116+
<a href="../Enums/TXCDSError.html">TXCDSError</a>
117+
</li>
118+
<li class="nav-group-task">
119+
<a href="../Enums/TXCDSWarning.html">TXCDSWarning</a>
120+
</li>
121+
<li class="nav-group-task">
122+
<a href="../Enums/TXCacheUpdatePolicy.html">TXCacheUpdatePolicy</a>
123+
</li>
124+
<li class="nav-group-task">
125+
<a href="../Enums/TXLogLevel.html">TXLogLevel</a>
126+
</li>
127+
<li class="nav-group-task">
128+
<a href="../Enums/TXRenderingStategy.html">TXRenderingStategy</a>
129+
</li>
130+
</ul>
131+
</li>
132+
<li class="nav-group-name">
133+
<a href="../Functions.html">Functions</a>
134+
<ul class="nav-group-tasks">
135+
<li class="nav-group-task">
136+
<a href="../Functions.html#/s:9Transifex13txGenerateKey12sourceString7contextS2S_SSSgtF">txGenerateKey(sourceString:context:)</a>
137+
</li>
138+
</ul>
139+
</li>
140+
<li class="nav-group-name">
141+
<a href="../Protocols.html">Protocols</a>
142+
<ul class="nav-group-tasks">
143+
<li class="nav-group-task">
144+
<a href="../Protocols/TXCache.html">TXCache</a>
145+
</li>
146+
<li class="nav-group-task">
147+
<a href="../Protocols/TXCacheProvider.html">TXCacheProvider</a>
148+
</li>
149+
<li class="nav-group-task">
150+
<a href="../Protocols/TXCurrentLocaleProvider.html">TXCurrentLocaleProvider</a>
151+
</li>
152+
<li class="nav-group-task">
153+
<a href="../Protocols/TXErrorPolicy.html">TXErrorPolicy</a>
154+
</li>
155+
<li class="nav-group-task">
156+
<a href="../Protocols/TXLogHandler.html">TXLogHandler</a>
157+
</li>
158+
<li class="nav-group-task">
159+
<a href="../Protocols/TXMissingPolicy.html">TXMissingPolicy</a>
160+
</li>
161+
</ul>
162+
</li>
163+
<li class="nav-group-name">
164+
<a href="../Typealiases.html">Type Aliases</a>
165+
<ul class="nav-group-tasks">
166+
<li class="nav-group-task">
167+
<a href="../Typealiases.html#/s:9Transifex15TXLocaleStringsa">TXLocaleStrings</a>
168+
</li>
169+
<li class="nav-group-task">
170+
<a href="../Typealiases.html#/s:9Transifex23TXPullCompletionHandlera">TXPullCompletionHandler</a>
171+
</li>
172+
<li class="nav-group-task">
173+
<a href="../Typealiases.html#/s:9Transifex12TXStringInfoa">TXStringInfo</a>
174+
</li>
175+
<li class="nav-group-task">
176+
<a href="../Typealiases.html#/s:9Transifex14TXTranslationsa">TXTranslations</a>
177+
</li>
178+
</ul>
179+
</li>
180+
</ul>
181+
</nav>
182+
<article class="main-content">
183+
<section>
184+
<section class="section">
185+
<h1>PluralUtils</h1>
186+
<div class="declaration">
187+
<div class="language">
188+
189+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">PluralUtils</span></code></pre>
190+
191+
</div>
192+
</div>
193+
<p>Utility class that allows SDK clients to leverage the logic used for pluralization rules.</p>
194+
195+
</section>
196+
<section class="section task-group-section">
197+
<div class="task-group">
198+
<ul>
199+
<li class="item">
200+
<div>
201+
<code>
202+
<a name="/s:9Transifex11PluralUtilsC13extractTokens4fromSaySS_S2StGSS_tFZ"></a>
203+
<a name="//apple_ref/swift/Method/extractTokens(from:)" class="dashAnchor"></a>
204+
<a class="token" href="#/s:9Transifex11PluralUtilsC13extractTokens4fromSaySS_S2StGSS_tFZ">extractTokens(from:<wbr>)</a>
205+
</code>
206+
</div>
207+
<div class="height-container">
208+
<div class="pointer-container"></div>
209+
<section class="section">
210+
<div class="pointer"></div>
211+
<div class="abstract">
212+
<p>For a given substitutions phrase, it returns an array with the parsed tokens.</p>
213+
<h2 id='string-catalogs-code-xcstrings-code' class='heading'>String Catalogs (<code>.xcstrings</code>)</h2>
214+
<pre class="highlight swift"><code><span class="kt">This</span> <span class="n">iPhone</span> <span class="n">contains</span> <span class="o">%</span><span class="mi">1</span><span class="err">$#</span><span class="kd">@token1</span><span class="err">@</span> <span class="n">with</span> <span class="o">%</span><span class="mi">2</span><span class="err">$#</span><span class="kd">@token2</span><span class="err">@</span>
215+
</code></pre>
216+
217+
<p>The extracted tokens will be:</p>
218+
219+
<ul>
220+
<li><code>(&quot;%1$#@token1@&quot;, &quot;1$&quot;, &quot;token1&quot;)</code></li>
221+
<li><code>(&quot;%2$#@token2@&quot;, &quot;2$&quot;, &quot;token2&quot;)</code></li>
222+
</ul>
223+
<h2 id='strings-dictionary-files-code-stringsdict-code' class='heading'>Strings Dictionary Files (<code>.stringsdict</code>)</h2>
224+
<pre class="highlight swift"><code><span class="kt">This</span> <span class="n">iPhone</span> <span class="n">contains</span> <span class="o">%</span><span class="err">#</span><span class="kd">@token1</span><span class="err">@</span> <span class="n">with</span> <span class="o">%</span><span class="err">#</span><span class="kd">@token2</span><span class="err">@</span>
225+
</code></pre>
226+
227+
<p>The extracted tokens will be: </p>
228+
229+
<ul>
230+
<li><code>(&quot;%#@token1@&quot;, &quot;&quot;, &quot;token1&quot;)</code></li>
231+
<li><p><code>(&quot;%#@token2@&quot;, &quot;&quot;, &quot;token2&quot;)</code></p></li>
232+
</ul>
233+
234+
</div>
235+
<div class="declaration">
236+
<h4>Declaration</h4>
237+
<div class="language">
238+
<p class="aside-title">Swift</p>
239+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">extractTokens</span><span class="p">(</span><span class="n">from</span> <span class="nv">substitutionsPhrase</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span></code></pre>
240+
241+
</div>
242+
</div>
243+
<div>
244+
<h4>Parameters</h4>
245+
<table class="graybox">
246+
<tbody>
247+
<tr>
248+
<td>
249+
<code>
250+
<em>substitutionsPhrase</em>
251+
</code>
252+
</td>
253+
<td>
254+
<div>
255+
<p>The substitutions phrase</p>
256+
</div>
257+
</td>
258+
</tr>
259+
</tbody>
260+
</table>
261+
</div>
262+
<div>
263+
<h4>Return Value</h4>
264+
<p>The array of extracted token tuples. A tuple of three elements: The first one is the
265+
original token, the second is the exported prefix (positional specifier) and the cleaned up version of
266+
the token without the specifiers and the delimiters.</p>
267+
</div>
268+
</section>
269+
</div>
270+
</li>
271+
</ul>
272+
</div>
273+
</section>
274+
</section>
275+
<section id="footer">
276+
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2024-07-09)</p>
277+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
278+
</section>
279+
</article>
280+
</div>
281+
</body>
282+
</html>

0 commit comments

Comments
 (0)