diff --git a/reference/intl/book.xml b/reference/intl/book.xml index a51ceefe15..df644c6dec 100644 --- a/reference/intl/book.xml +++ b/reference/intl/book.xml @@ -95,18 +95,23 @@ &reference.intl.locale; &reference.intl.normalizer; &reference.intl.messageformatter; - &reference.intl.intlcalendar; - &reference.intl.intltimezone; - &reference.intl.dateformatter; + &reference.intl.intlcalendar; + &reference.intl.intltimezone; + &reference.intl.dateformatter; &reference.intl.resourcebundle; &reference.intl.spoofchecker; &reference.intl.transliterator; + &reference.intl.intlbreakiterator; + &reference.intl.intlrulebasedbreakiterator; + &reference.intl.intlcodepointbreakiterator; + &reference.intl.intlpartsiterator; &reference.intl.uconverter; &reference.intl.grapheme; &reference.intl.idn; &reference.intl.intlexception; + &reference.intl.intliterator; &reference.intl.reference; diff --git a/reference/intl/intlbreakiterator.xml b/reference/intl/intlbreakiterator.xml new file mode 100644 index 0000000000..53c790d9a1 --- /dev/null +++ b/reference/intl/intlbreakiterator.xml @@ -0,0 +1,345 @@ + + + + + + The IntlBreakIterator class + IntlBreakIterator + + + + +
+ &reftitle.intro; + + A “break iterator” is an ICU object that exposes methods for locating + boundaries in text (e.g. word or sentence boundaries). + The PHP IntlBreakIterator serves as the the base class + for all types of ICU break iterators. Where extra functionality is + available, the intl extension may expose the ICU break iterator with + suitable subclasses, such as + IntlRuleBasedBreakIterator or + IntlCodePointBreaIterator. + + + This class implements Traversable. Traversing an + IntlBreakIterator yields non-negative integer + values representing the successive locations of the text boundaries, + expressed as UTF-8 code units (byte) counts, taken from the beggining of + the text (which has the location 0). The keys yielded + by the iterator simply form the sequence of natural numbers + {0, 1, 2, …}. + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlBreakIterator + + + + + IntlBreakIterator + + + + Traversable + + + + Constants + + const + integer + IntlBreakIterator::DONE + -1 + + + const + integer + IntlBreakIterator::WORD_NONE + 0 + + + const + integer + IntlBreakIterator::WORD_NONE_LIMIT + 100 + + + const + integer + IntlBreakIterator::WORD_NUMBER + 100 + + + const + integer + IntlBreakIterator::WORD_NUMBER_LIMIT + 200 + + + const + integer + IntlBreakIterator::WORD_LETTER + 200 + + + const + integer + IntlBreakIterator::WORD_LETTER_LIMIT + 300 + + + const + integer + IntlBreakIterator::WORD_KANA + 300 + + + const + integer + IntlBreakIterator::WORD_KANA_LIMIT + 400 + + + const + integer + IntlBreakIterator::WORD_IDEO + 400 + + + const + integer + IntlBreakIterator::WORD_IDEO_LIMIT + 500 + + + const + integer + IntlBreakIterator::LINE_SOFT + 0 + + + const + integer + IntlBreakIterator::LINE_SOFT_LIMIT + 100 + + + const + integer + IntlBreakIterator::LINE_HARD + 100 + + + const + integer + IntlBreakIterator::LINE_HARD_LIMIT + 200 + + + const + integer + IntlBreakIterator::SENTENCE_TERM + 0 + + + const + integer + IntlBreakIterator::SENTENCE_TERM_LIMIT + 100 + + + const + integer + IntlBreakIterator::SENTENCE_SEP + 100 + + + const + integer + IntlBreakIterator::SENTENCE_SEP_LIMIT + 200 + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + IntlBreakIterator::DONE + + + + + + + IntlBreakIterator::WORD_NONE + + + + + + + IntlBreakIterator::WORD_NONE_LIMIT + + + + + + + IntlBreakIterator::WORD_NUMBER + + + + + + + IntlBreakIterator::WORD_NUMBER_LIMIT + + + + + + + IntlBreakIterator::WORD_LETTER + + + + + + + IntlBreakIterator::WORD_LETTER_LIMIT + + + + + + + IntlBreakIterator::WORD_KANA + + + + + + + IntlBreakIterator::WORD_KANA_LIMIT + + + + + + + IntlBreakIterator::WORD_IDEO + + + + + + + IntlBreakIterator::WORD_IDEO_LIMIT + + + + + + + IntlBreakIterator::LINE_SOFT + + + + + + + IntlBreakIterator::LINE_SOFT_LIMIT + + + + + + + IntlBreakIterator::LINE_HARD + + + + + + + IntlBreakIterator::LINE_HARD_LIMIT + + + + + + + IntlBreakIterator::SENTENCE_TERM + + + + + + + IntlBreakIterator::SENTENCE_TERM_LIMIT + + + + + + + IntlBreakIterator::SENTENCE_SEP + + + + + + + IntlBreakIterator::SENTENCE_SEP_LIMIT + + + + + + +
+ + + + + + &reference.intl.entities.intlbreakiterator; + + + + diff --git a/reference/intl/intlbreakiterator/construct.xml b/reference/intl/intlbreakiterator/construct.xml new file mode 100644 index 0000000000..0a98b6ff88 --- /dev/null +++ b/reference/intl/intlbreakiterator/construct.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::__construct + Private constructor for disallowing instantiation + + + + &reftitle.description; + + private IntlBreakIterator::__construct + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createcharacterinstance.xml b/reference/intl/intlbreakiterator/createcharacterinstance.xml new file mode 100644 index 0000000000..2cf8e0eec8 --- /dev/null +++ b/reference/intl/intlbreakiterator/createcharacterinstance.xml @@ -0,0 +1,69 @@ + + + + + + IntlBreakIterator::createCharacterInstance + + Create break iterator for boundaries of combining character sequences + + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createCharacterInstance + string"locale" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createcodepointinstance.xml b/reference/intl/intlbreakiterator/createcodepointinstance.xml new file mode 100644 index 0000000000..bc3b2ec03f --- /dev/null +++ b/reference/intl/intlbreakiterator/createcodepointinstance.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::createCodePointInstance + Create break iterator for boundaries of code points + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createCodePointInstance + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createlineinstance.xml b/reference/intl/intlbreakiterator/createlineinstance.xml new file mode 100644 index 0000000000..899949ef3e --- /dev/null +++ b/reference/intl/intlbreakiterator/createlineinstance.xml @@ -0,0 +1,69 @@ + + + + + + IntlBreakIterator::createLineInstance + + Create break iterator for logically possible line breaks + + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createLineInstance + string"locale" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createsentenceinstance.xml b/reference/intl/intlbreakiterator/createsentenceinstance.xml new file mode 100644 index 0000000000..0c89d7f823 --- /dev/null +++ b/reference/intl/intlbreakiterator/createsentenceinstance.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::createSentenceInstance + Create break iterator for sentence breaks + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createSentenceInstance + string"locale" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createtitleinstance.xml b/reference/intl/intlbreakiterator/createtitleinstance.xml new file mode 100644 index 0000000000..acfa91a39d --- /dev/null +++ b/reference/intl/intlbreakiterator/createtitleinstance.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::createTitleInstance + Create break iterator for title-casing breaks + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createTitleInstance + string"locale" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/createwordinstance.xml b/reference/intl/intlbreakiterator/createwordinstance.xml new file mode 100644 index 0000000000..675f3fa4dc --- /dev/null +++ b/reference/intl/intlbreakiterator/createwordinstance.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::createWordInstance + Create break iterator for word breaks + + + + &reftitle.description; + + public static ReturnTypeIntlBreakIterator::createWordInstance + string"locale" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/current.xml b/reference/intl/intlbreakiterator/current.xml new file mode 100644 index 0000000000..b1e7449a82 --- /dev/null +++ b/reference/intl/intlbreakiterator/current.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::current + Get index of current position + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::current + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/first.xml b/reference/intl/intlbreakiterator/first.xml new file mode 100644 index 0000000000..dbe48012f3 --- /dev/null +++ b/reference/intl/intlbreakiterator/first.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::first + Set position to the first character in the text + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::first + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/following.xml b/reference/intl/intlbreakiterator/following.xml new file mode 100644 index 0000000000..9cfe54fad7 --- /dev/null +++ b/reference/intl/intlbreakiterator/following.xml @@ -0,0 +1,69 @@ + + + + + + IntlBreakIterator::following + + Advance the iterator to the first boundary following specified offset + + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::following + string"offset" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "offset" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/geterrorcode.xml b/reference/intl/intlbreakiterator/geterrorcode.xml new file mode 100644 index 0000000000..e2c8abcd93 --- /dev/null +++ b/reference/intl/intlbreakiterator/geterrorcode.xml @@ -0,0 +1,65 @@ + + + + + + IntlBreakIterator::getErrorCode + intl_get_error_code + Get last error code on the object + + + + &reftitle.description; + &style.oop; (method): + + public ReturnTypeIntlBreakIterator::getErrorCode + + + &style.procedural;: + + ReturnTypeintl_get_error_code + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/geterrormessage.xml b/reference/intl/intlbreakiterator/geterrormessage.xml new file mode 100644 index 0000000000..65f32ec48e --- /dev/null +++ b/reference/intl/intlbreakiterator/geterrormessage.xml @@ -0,0 +1,65 @@ + + + + + + IntlBreakIterator::getErrorMessage + intl_get_error_message + Get last error message on the object + + + + &reftitle.description; + &style.oop; (method): + + public ReturnTypeIntlBreakIterator::getErrorMessage + + + &style.procedural;: + + ReturnTypeintl_get_error_message + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/getlocale.xml b/reference/intl/intlbreakiterator/getlocale.xml new file mode 100644 index 0000000000..6a5c64dba5 --- /dev/null +++ b/reference/intl/intlbreakiterator/getlocale.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::getLocale + Get the locale associated with the object + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::getLocale + string"locale_type" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "locale_type" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/getpartsiterator.xml b/reference/intl/intlbreakiterator/getpartsiterator.xml new file mode 100644 index 0000000000..edc5e2d330 --- /dev/null +++ b/reference/intl/intlbreakiterator/getpartsiterator.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::getPartsIterator + Create iterator for navigating fragments between boundaries + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::getPartsIterator + string"key_type" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "key_type" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/gettext.xml b/reference/intl/intlbreakiterator/gettext.xml new file mode 100644 index 0000000000..4f17eaac3f --- /dev/null +++ b/reference/intl/intlbreakiterator/gettext.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::getText + Get the text being scanned + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::getText + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/isboundary.xml b/reference/intl/intlbreakiterator/isboundary.xml new file mode 100644 index 0000000000..216a75f23c --- /dev/null +++ b/reference/intl/intlbreakiterator/isboundary.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::isBoundary + Tell whether an offset is a boundaryʼs offset + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::isBoundary + string"offset" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "offset" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/last.xml b/reference/intl/intlbreakiterator/last.xml new file mode 100644 index 0000000000..87142be507 --- /dev/null +++ b/reference/intl/intlbreakiterator/last.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::last + Set the iterator position to index beyond the last character + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::last + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/next.xml b/reference/intl/intlbreakiterator/next.xml new file mode 100644 index 0000000000..12cb689e45 --- /dev/null +++ b/reference/intl/intlbreakiterator/next.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::next + Advance the iterator the next boundary + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::next + string"offset" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "offset" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/preceding.xml b/reference/intl/intlbreakiterator/preceding.xml new file mode 100644 index 0000000000..0a2f073d45 --- /dev/null +++ b/reference/intl/intlbreakiterator/preceding.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::preceding + Set the iterator position to the first boundary before an offset + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::preceding + string"offset" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "offset" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/previous.xml b/reference/intl/intlbreakiterator/previous.xml new file mode 100644 index 0000000000..30f26b66d5 --- /dev/null +++ b/reference/intl/intlbreakiterator/previous.xml @@ -0,0 +1,58 @@ + + + + + + IntlBreakIterator::previous + Set the iterator position to the boundary immediately before the current + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::previous + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlbreakiterator/settext.xml b/reference/intl/intlbreakiterator/settext.xml new file mode 100644 index 0000000000..5636acaa3a --- /dev/null +++ b/reference/intl/intlbreakiterator/settext.xml @@ -0,0 +1,67 @@ + + + + + + IntlBreakIterator::setText + Set the text being scanned + + + + &reftitle.description; + + public ReturnTypeIntlBreakIterator::setText + string"text" + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "text" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlcodepointbreakiterator.xml b/reference/intl/intlcodepointbreakiterator.xml new file mode 100644 index 0000000000..58ea433e7a --- /dev/null +++ b/reference/intl/intlcodepointbreakiterator.xml @@ -0,0 +1,339 @@ + + + + + + The IntlCodePointBreakIterator class + IntlCodePointBreakIterator + + + + +
+ &reftitle.intro; + + This break iterator + identifies the boundaries between UTF-8 code points. + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlCodePointBreakIterator + + + + + IntlCodePointBreakIterator + + + + extends + IntlBreakIterator + + + + Traversable + + + + Constants + + const + integer + IntlCodePointBreakIterator::DONE + -1 + + + const + integer + IntlCodePointBreakIterator::WORD_NONE + 0 + + + const + integer + IntlCodePointBreakIterator::WORD_NONE_LIMIT + 100 + + + const + integer + IntlCodePointBreakIterator::WORD_NUMBER + 100 + + + const + integer + IntlCodePointBreakIterator::WORD_NUMBER_LIMIT + 200 + + + const + integer + IntlCodePointBreakIterator::WORD_LETTER + 200 + + + const + integer + IntlCodePointBreakIterator::WORD_LETTER_LIMIT + 300 + + + const + integer + IntlCodePointBreakIterator::WORD_KANA + 300 + + + const + integer + IntlCodePointBreakIterator::WORD_KANA_LIMIT + 400 + + + const + integer + IntlCodePointBreakIterator::WORD_IDEO + 400 + + + const + integer + IntlCodePointBreakIterator::WORD_IDEO_LIMIT + 500 + + + const + integer + IntlCodePointBreakIterator::LINE_SOFT + 0 + + + const + integer + IntlCodePointBreakIterator::LINE_SOFT_LIMIT + 100 + + + const + integer + IntlCodePointBreakIterator::LINE_HARD + 100 + + + const + integer + IntlCodePointBreakIterator::LINE_HARD_LIMIT + 200 + + + const + integer + IntlCodePointBreakIterator::SENTENCE_TERM + 0 + + + const + integer + IntlCodePointBreakIterator::SENTENCE_TERM_LIMIT + 100 + + + const + integer + IntlCodePointBreakIterator::SENTENCE_SEP + 100 + + + const + integer + IntlCodePointBreakIterator::SENTENCE_SEP_LIMIT + 200 + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + IntlCodePointBreakIterator::DONE + + + + + + + IntlCodePointBreakIterator::WORD_NONE + + + + + + + IntlCodePointBreakIterator::WORD_NONE_LIMIT + + + + + + + IntlCodePointBreakIterator::WORD_NUMBER + + + + + + + IntlCodePointBreakIterator::WORD_NUMBER_LIMIT + + + + + + + IntlCodePointBreakIterator::WORD_LETTER + + + + + + + IntlCodePointBreakIterator::WORD_LETTER_LIMIT + + + + + + + IntlCodePointBreakIterator::WORD_KANA + + + + + + + IntlCodePointBreakIterator::WORD_KANA_LIMIT + + + + + + + IntlCodePointBreakIterator::WORD_IDEO + + + + + + + IntlCodePointBreakIterator::WORD_IDEO_LIMIT + + + + + + + IntlCodePointBreakIterator::LINE_SOFT + + + + + + + IntlCodePointBreakIterator::LINE_SOFT_LIMIT + + + + + + + IntlCodePointBreakIterator::LINE_HARD + + + + + + + IntlCodePointBreakIterator::LINE_HARD_LIMIT + + + + + + + IntlCodePointBreakIterator::SENTENCE_TERM + + + + + + + IntlCodePointBreakIterator::SENTENCE_TERM_LIMIT + + + + + + + IntlCodePointBreakIterator::SENTENCE_SEP + + + + + + + IntlCodePointBreakIterator::SENTENCE_SEP_LIMIT + + + + + + +
+ + + + + + &reference.intl.entities.intlcodepointbreakiterator; + + + + diff --git a/reference/intl/intlcodepointbreakiterator/getlastcodepoint.xml b/reference/intl/intlcodepointbreakiterator/getlastcodepoint.xml new file mode 100644 index 0000000000..ce65c28baa --- /dev/null +++ b/reference/intl/intlcodepointbreakiterator/getlastcodepoint.xml @@ -0,0 +1,58 @@ + + + + + + IntlCodePointBreakIterator::getLastCodePoint + Get last code point passed over after advancing or receding the iterator + + + + &reftitle.description; + + public ReturnTypeIntlCodePointBreakIterator::getLastCodePoint + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intliterator.xml b/reference/intl/intliterator.xml new file mode 100644 index 0000000000..5cf46f3c16 --- /dev/null +++ b/reference/intl/intliterator.xml @@ -0,0 +1,85 @@ + + + + + + The IntlIterator class + IntlIterator + + + + +
+ &reftitle.intro; + + This class represents iterator objects throughout the intl extension + whenever the iterator cannot be identified with any other object provided + by the extension. The distinct iterator object used internally by the + foreach + construct can only be obtained (in the relevant part here) from + objects, so objects of this class serve the purpose of providing the hook + through which this internal object can be obtained. As a convenience, this + class also implements the Iterator interface, + allowing the collection of values to be navigated using the methods + defined in that interface. Both these methods and the internal iterator + objects provided to foreach are backed by the same + state (e.g. the position of the iterator and its current value). + + + Subclasses may provide richer functionality. + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlIterator + + + + + IntlIterator + + + + Iterator + + + + + &Methods; + + + + +
+ + + + &reference.intl.entities.intliterator; + + + + diff --git a/reference/intl/intliterator/current.xml b/reference/intl/intliterator/current.xml new file mode 100644 index 0000000000..82374110cf --- /dev/null +++ b/reference/intl/intliterator/current.xml @@ -0,0 +1,58 @@ + + + + + + IntlIterator::current + Get the current element + + + + &reftitle.description; + + public ReturnTypeIntlIterator::current + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intliterator/key.xml b/reference/intl/intliterator/key.xml new file mode 100644 index 0000000000..2f448f0b7d --- /dev/null +++ b/reference/intl/intliterator/key.xml @@ -0,0 +1,58 @@ + + + + + + IntlIterator::key + Get the current key + + + + &reftitle.description; + + public ReturnTypeIntlIterator::key + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intliterator/next.xml b/reference/intl/intliterator/next.xml new file mode 100644 index 0000000000..adde0329e4 --- /dev/null +++ b/reference/intl/intliterator/next.xml @@ -0,0 +1,58 @@ + + + + + + IntlIterator::next + Move forward to the next element + + + + &reftitle.description; + + public ReturnTypeIntlIterator::next + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intliterator/rewind.xml b/reference/intl/intliterator/rewind.xml new file mode 100644 index 0000000000..22b9ddf12c --- /dev/null +++ b/reference/intl/intliterator/rewind.xml @@ -0,0 +1,58 @@ + + + + + + IntlIterator::rewind + Rewind the iterator to the first element + + + + &reftitle.description; + + public ReturnTypeIntlIterator::rewind + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intliterator/valid.xml b/reference/intl/intliterator/valid.xml new file mode 100644 index 0000000000..f1022e49e3 --- /dev/null +++ b/reference/intl/intliterator/valid.xml @@ -0,0 +1,58 @@ + + + + + + IntlIterator::valid + Check if curent position is valid + + + + &reftitle.description; + + public ReturnTypeIntlIterator::valid + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlpartsiterator.xml b/reference/intl/intlpartsiterator.xml new file mode 100644 index 0000000000..b7f2262133 --- /dev/null +++ b/reference/intl/intlpartsiterator.xml @@ -0,0 +1,140 @@ + + + + + + The IntlPartsIterator class + IntlPartsIterator + + + + +
+ &reftitle.intro; + + Objects of this class can be obtained from + IntlBreakIterator objects. While the break + iterators provide a sequence of boundary positions when iterated, + IntlPartsIterator objects provide, as a + convenience, the text fragments comprehended between two successive + boundaries. + + + The keys may represent the offset of the left boundary, right boundary, or + they may just the sequence of non-negative integers. See + IntlBreakIterator::getPartsIterator. + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlPartsIterator + + + + + IntlPartsIterator + + + + extends + IntlIterator + + + + Iterator + + + + Constants + + const + integer + IntlPartsIterator::KEY_SEQUENTIAL + 0 + + + const + integer + IntlPartsIterator::KEY_LEFT + 1 + + + const + integer + IntlPartsIterator::KEY_RIGHT + 2 + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + IntlPartsIterator::KEY_SEQUENTIAL + + + + + + + IntlPartsIterator::KEY_LEFT + + + + + + + IntlPartsIterator::KEY_RIGHT + + + + + + +
+ + + + + + &reference.intl.entities.intlpartsiterator; + + + + diff --git a/reference/intl/intlpartsiterator/getbreakiterator.xml b/reference/intl/intlpartsiterator/getbreakiterator.xml new file mode 100644 index 0000000000..e779a04fed --- /dev/null +++ b/reference/intl/intlpartsiterator/getbreakiterator.xml @@ -0,0 +1,58 @@ + + + + + + IntlPartsIterator::getBreakIterator + Get IntlBreakIterator backing this parts iterator + + + + &reftitle.description; + + public ReturnTypeIntlPartsIterator::getBreakIterator + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlrulebasedbreakiterator.xml b/reference/intl/intlrulebasedbreakiterator.xml new file mode 100644 index 0000000000..2ec5ff8926 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator.xml @@ -0,0 +1,345 @@ + + + + + + The IntlRuleBasedBreakIterator class + IntlRuleBasedBreakIterator + + + + +
+ &reftitle.intro; + + A subclass of IntlBreakIterator that encapsulates + ICU break iterators whose behavior is specified using a set of rules. This + is the most common kind of break iterators. + + + These rules are described in the ICU Boundary Analysis + User Guide. + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlRuleBasedBreakIterator + + + + + IntlRuleBasedBreakIterator + + + + extends + IntlBreakIterator + + + + Traversable + + + + Constants + + const + integer + IntlRuleBasedBreakIterator::DONE + -1 + + + const + integer + IntlRuleBasedBreakIterator::WORD_NONE + 0 + + + const + integer + IntlRuleBasedBreakIterator::WORD_NONE_LIMIT + 100 + + + const + integer + IntlRuleBasedBreakIterator::WORD_NUMBER + 100 + + + const + integer + IntlRuleBasedBreakIterator::WORD_NUMBER_LIMIT + 200 + + + const + integer + IntlRuleBasedBreakIterator::WORD_LETTER + 200 + + + const + integer + IntlRuleBasedBreakIterator::WORD_LETTER_LIMIT + 300 + + + const + integer + IntlRuleBasedBreakIterator::WORD_KANA + 300 + + + const + integer + IntlRuleBasedBreakIterator::WORD_KANA_LIMIT + 400 + + + const + integer + IntlRuleBasedBreakIterator::WORD_IDEO + 400 + + + const + integer + IntlRuleBasedBreakIterator::WORD_IDEO_LIMIT + 500 + + + const + integer + IntlRuleBasedBreakIterator::LINE_SOFT + 0 + + + const + integer + IntlRuleBasedBreakIterator::LINE_SOFT_LIMIT + 100 + + + const + integer + IntlRuleBasedBreakIterator::LINE_HARD + 100 + + + const + integer + IntlRuleBasedBreakIterator::LINE_HARD_LIMIT + 200 + + + const + integer + IntlRuleBasedBreakIterator::SENTENCE_TERM + 0 + + + const + integer + IntlRuleBasedBreakIterator::SENTENCE_TERM_LIMIT + 100 + + + const + integer + IntlRuleBasedBreakIterator::SENTENCE_SEP + 100 + + + const + integer + IntlRuleBasedBreakIterator::SENTENCE_SEP_LIMIT + 200 + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + IntlRuleBasedBreakIterator::DONE + + + + + + + IntlRuleBasedBreakIterator::WORD_NONE + + + + + + + IntlRuleBasedBreakIterator::WORD_NONE_LIMIT + + + + + + + IntlRuleBasedBreakIterator::WORD_NUMBER + + + + + + + IntlRuleBasedBreakIterator::WORD_NUMBER_LIMIT + + + + + + + IntlRuleBasedBreakIterator::WORD_LETTER + + + + + + + IntlRuleBasedBreakIterator::WORD_LETTER_LIMIT + + + + + + + IntlRuleBasedBreakIterator::WORD_KANA + + + + + + + IntlRuleBasedBreakIterator::WORD_KANA_LIMIT + + + + + + + IntlRuleBasedBreakIterator::WORD_IDEO + + + + + + + IntlRuleBasedBreakIterator::WORD_IDEO_LIMIT + + + + + + + IntlRuleBasedBreakIterator::LINE_SOFT + + + + + + + IntlRuleBasedBreakIterator::LINE_SOFT_LIMIT + + + + + + + IntlRuleBasedBreakIterator::LINE_HARD + + + + + + + IntlRuleBasedBreakIterator::LINE_HARD_LIMIT + + + + + + + IntlRuleBasedBreakIterator::SENTENCE_TERM + + + + + + + IntlRuleBasedBreakIterator::SENTENCE_TERM_LIMIT + + + + + + + IntlRuleBasedBreakIterator::SENTENCE_SEP + + + + + + + IntlRuleBasedBreakIterator::SENTENCE_SEP_LIMIT + + + + + + +
+ + + + + + &reference.intl.entities.intlrulebasedbreakiterator; + + + + diff --git a/reference/intl/intlrulebasedbreakiterator/construct.xml b/reference/intl/intlrulebasedbreakiterator/construct.xml new file mode 100644 index 0000000000..d93deab290 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator/construct.xml @@ -0,0 +1,76 @@ + + + + + + IntlRuleBasedBreakIterator::__construct + Create iterator from ruleset + + + + &reftitle.description; + + public IntlRuleBasedBreakIterator::__construct + stringrules + stringareCompiled + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + "rules" + + + + + + + + "areCompiled" + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlrulebasedbreakiterator/getbinaryrules.xml b/reference/intl/intlrulebasedbreakiterator/getbinaryrules.xml new file mode 100644 index 0000000000..b03d9254c7 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator/getbinaryrules.xml @@ -0,0 +1,58 @@ + + + + + + IntlRuleBasedBreakIterator::getBinaryRules + Get the binary form of compiled rules + + + + &reftitle.description; + + public ReturnTypeIntlRuleBasedBreakIterator::getBinaryRules + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlrulebasedbreakiterator/getrules.xml b/reference/intl/intlrulebasedbreakiterator/getrules.xml new file mode 100644 index 0000000000..a163ad5f43 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator/getrules.xml @@ -0,0 +1,58 @@ + + + + + + IntlRuleBasedBreakIterator::getRules + Get the rule set used to create this object + + + + &reftitle.description; + + public ReturnTypeIntlRuleBasedBreakIterator::getRules + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlrulebasedbreakiterator/getrulestatus.xml b/reference/intl/intlrulebasedbreakiterator/getrulestatus.xml new file mode 100644 index 0000000000..82b8d550c1 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator/getrulestatus.xml @@ -0,0 +1,58 @@ + + + + + + IntlRuleBasedBreakIterator::getRuleStatus + Get the largest status value from the break rules that determined the current break position + + + + &reftitle.description; + + public ReturnTypeIntlRuleBasedBreakIterator::getRuleStatus + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/intl/intlrulebasedbreakiterator/getrulestatusvec.xml b/reference/intl/intlrulebasedbreakiterator/getrulestatusvec.xml new file mode 100644 index 0000000000..257fe6d896 --- /dev/null +++ b/reference/intl/intlrulebasedbreakiterator/getrulestatusvec.xml @@ -0,0 +1,58 @@ + + + + + + IntlRuleBasedBreakIterator::getRuleStatusVec + Get the status values from the break rules that determined the current break position + + + + &reftitle.description; + + public ReturnTypeIntlRuleBasedBreakIterator::getRuleStatusVec + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + +