<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: d335ba69a16f4013280de8e3e71d9ba19fe3cb3c Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.str-word-count" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>str_word_count</refname>

<refpurpose>Cuenta el número de palabras utilizadas en un string</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>int</type></type><methodname>str_word_count</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>format</parameter><initializer>0</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>characters</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

<function>str_word_count</function> cuenta el número de palabras en

el string <parameter>string</parameter>. Si el argumento opcional

<parameter>format</parameter> no está especificado, entonces el valor

devuelto será un integer, representando el número de palabras encontradas.

Si <parameter>format</parameter> está especificado, el valor devuelto

será un array, que depende del formato <parameter>format</parameter>.

Los valores posibles para <parameter>format</parameter> se listan a continuación.

</para>

<para>

En esta función, la noción de palabra depende de la configuración

de la configuración local. Es un string que contiene todos los caracteres

alfabéticos, y que puede contener, pero no comenzar por

&quot;'&quot; y &quot;-&quot;.

Cabe señalar que las configuraciones locales multioctetos no están soportadas.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

El string

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>format</parameter></term>

<listitem>

<para>

Especifica el valor de retorno de esta función. Los valores

actualmente soportados son:

<itemizedlist>

<listitem>

<simpara>

0: devuelve el número de palabras encontradas

</simpara>

</listitem>

<listitem>

<simpara>

1: devuelve un array que contiene todas las palabras encontradas dentro

de <parameter>string</parameter>

</simpara>

</listitem>

<listitem>

<simpara>

2: devuelve un array asociativo, donde la clave indica la posición

numérica de la palabra dentro de <parameter>string</parameter> y

el valor es la palabra actual

</simpara>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>characters</parameter></term>

<listitem>

<para>

Una lista de caracteres adicionales que serán considerados como una

palabra

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve un array o un integer, dependiendo del

<parameter>format</parameter> elegido.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>characters</parameter> ahora es nullable.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <function>str_word_count</function></title>

<programlisting role="php">

<![CDATA[

<?php

$str = "Salut l'ami, vous

avez une b3lle mine !";

print_r(str_word_count($str, 1));

print_r(str_word_count($str, 2));

print_r(str_word_count($str, 1, 'àáãç3'));

echo str_word_count($str);

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

Array

(

[0] => Salut

[1] => l'ami

[2] => vous

[3] => avez

[4] => une

[5] => b

[6] => lle

[7] => mine

)

Array

(

[0] => Salut

[6] => l'ami

[13] => vous

[27] => avez

[41] => une

[45] => b

[47] => lle

[51] => mine

)

Array

(

[0] => Salut

[1] => l'ami

[2] => vous

[3] => avez

[4] => une

[5] => b3lle

[6] => mine

)

8

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>explode</function></member>

<member><function>preg_split</function></member>

<member><function>count_chars</function></member>

<member><function>substr_count</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->