Download the PHP package hoa/ustring without Composer
On this page you can find all versions of the php package hoa/ustring. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package ustring
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Ustring
This library allows to manipulate UTF-8 strings easily with some search algorithms.
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/ustring
:
For more installation procedures, please read the Source page.
Testing
Before running the test suites, the development dependencies must be installed:
Then, to run all the test suites:
For more information, please read the contributor guide.
Quick usage
We propose a quick overview of two usages: manipulate UTF-8 strings and one search algorithm.
Natural UTF-8 strings manipulation
The Hoa\Ustring\Ustring
class allows to manipulate easily UTF-8 strings in a
very natural way. This class implements the \ArrayAccess
, \Countable
and
\IteratorAggregate
interfaces. We will use the following examples:
To get the first character, we will do:
And to get the last character, we will do [-1]
. It supports unbounded (and
modulo) indexes.
We note that it cares about text direction. Look at $arabic[0]
, it returns
أ
and not ك
. To get the direction, we can use the
Hoa\Ustring\Ustring::getDirection
method (which call the
Hoa\Ustring\Ustring::getCharDirection
static method), it returns either
Hoa\Ustring\Ustring::LTR
(0
) or Hoa\Ustring\Ustring::RTL
(1
):
Text direction is also important for the append
, prepend
, pad
… methods on
Hoa\Ustring\Ustring
for example.
To get the length of a string, we can use the count
function:
We are also able to iterate over the string:
Again, text direction is useful here. For $arabic
, the iteration is done from
right to left.
Some static methods are helpful, such as fromCode
, toCode
or isUtf8
on
Hoa\Ustring\Ustring
:
We can also transform any text into ASCII:
Search algorithm
The Hoa\Ustring\Search
implements search algorithms on strings.
For example, the Hoa\Ustring\Search::approximated
method make a search by
approximated patterns (with k differences based upon the principle diagonal
monotony). If we search the word GATAA
in CAGATAAGAGAA
with 1 difference, we
will do:
We will found AGATA
, GATAA
, ATAAG
and GAGAA
.
The result is not very handy but the algorithm is much optimized and found many applications.
Documentation
The
hack book of Hoa\Ustring
contains
detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
More documentation can be found on the project's website: hoa-project.net.
Getting help
There are mainly two ways to get help:
- On the
#hoaproject
IRC channel, - On the forum at users.hoa-project.net.
Contribution
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE
for details.