mirror of
https://github.com/php/doc-fr.git
synced 2026-03-24 07:02:06 +01:00
282 lines
8.4 KiB
XML
282 lines
8.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 71166b721ba6bb7dd3110da86efa3b723e1f7651 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
<refentry xml:id="function.substr" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>substr</refname>
|
|
<refpurpose>Retourne un segment de chaîne</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>substr</methodname>
|
|
<methodparam><type>string</type><parameter>string</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retourne le segment de <parameter>string</parameter> défini par
|
|
<parameter>offset</parameter> et <parameter>length</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La &string; d'entrée.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>offset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Si <parameter>offset</parameter> est positif, la chaîne
|
|
retournée commencera au caractère numéro <parameter>offset</parameter>,
|
|
dans la chaîne <parameter>string</parameter>. Le premier caractère
|
|
est numéroté zéro. En effet, dans la chaîne '<literal>abcdef</literal>',
|
|
le caractère à la position <literal>0</literal> est '<literal>a</literal>',
|
|
le caractère à la position <literal>2</literal> est '<literal>c</literal>',
|
|
et ainsi de suite.
|
|
</para>
|
|
<para>
|
|
Si <parameter>offset</parameter> est négatif, la chaîne retournée
|
|
commencera au caractère numéro <parameter>offset</parameter> à compter
|
|
de la fin de la chaîne <parameter>string</parameter>.
|
|
</para>
|
|
<para>
|
|
Si <parameter>string</parameter> est plus petit que
|
|
<parameter>offset</parameter> caractères de long, une chaîne vide sera retournée.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Exemple de <parameter>offset</parameter> négatif</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo substr("abcdef", -1), PHP_EOL; // retourne "f"
|
|
echo substr("abcdef", -2), PHP_EOL; // retourne "ef"
|
|
echo substr("abcdef", -3, 1), PHP_EOL; // retourne "d"
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Si <parameter>length</parameter> est fourni et est positif,
|
|
la chaîne retournée contiendra au plus <parameter>length</parameter>
|
|
caractères, en commençant à partir du caractère
|
|
<parameter>offset</parameter> (en fonction de la taille de la chaîne
|
|
<parameter>string</parameter>).
|
|
</para>
|
|
<para>
|
|
Si <parameter>length</parameter> est fourni et négatif, alors le même
|
|
caractère sera omis de la fin de <parameter>string</parameter>.
|
|
Si <parameter>offset</parameter> indique la position de cette troncature ou
|
|
une position hors de la chaîne, une chaîne vide sera retournée.
|
|
</para>
|
|
<para>
|
|
Si le paramètre <parameter>length</parameter> est fourni
|
|
et vaut <literal>0</literal>, une chaîne vide sera retournée.
|
|
</para>
|
|
<para>
|
|
Si <parameter>length</parameter> est omis ou &null;, la sous chaîne commençant
|
|
à partir de <parameter>offset</parameter> jusqu'à la fin sera retournée.
|
|
</para>
|
|
<example>
|
|
<title>Utilisation d'une valeur négative pour <parameter>length</parameter></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo substr("abcdef", 0, -1), PHP_EOL; // retourne "abcde"
|
|
echo substr("abcdef", 2, -1), PHP_EOL; // retourne "cde"
|
|
echo substr("abcdef", 4, -4), PHP_EOL; // retourne ""; antérieur à PHP 8.0.0, false était retourné
|
|
echo substr("abcdef", -3, -1), PHP_EOL; // retourne "de"
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne la partie extraite de la chaîne <parameter>string</parameter>,
|
|
ou une chaîne vide.
|
|
</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>length</parameter> est désormais nullable.
|
|
Lorsque <parameter>length</parameter> est explicitement défini à &null;,
|
|
la fonction retourne une sous-chaîne terminant à la fin de la chaîne,
|
|
alors qu'elle renvoyait auparavant une chaîne vide.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
Cette fonction retourne une chaîne vide où auparavant elle retournait &false;
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Exemple avec <function>substr</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo substr('abcdef', 1), PHP_EOL; // bcdef
|
|
echo substr("abcdef", 1, null), PHP_EOL; // bcdef; antérieur à PHP 8.0.0, une chaîne vide était retournée
|
|
echo substr('abcdef', 1, 3), PHP_EOL; // bcd
|
|
echo substr('abcdef', 0, 4), PHP_EOL; // abcd
|
|
echo substr('abcdef', 0, 8), PHP_EOL; // abcdef
|
|
echo substr('abcdef', -1, 1), PHP_EOL; // f
|
|
|
|
// Accéder à un simple caractère dans une chaîne
|
|
// peut également être réalisé en utilisant des crochets
|
|
$string = 'abcdef';
|
|
echo $string[0], PHP_EOL; // a
|
|
echo $string[3], PHP_EOL; // d
|
|
echo $string[strlen($string)-1], PHP_EOL; // f
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>Comportement du cast avec <function>substr</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class apple {
|
|
public function __toString() {
|
|
return "green";
|
|
}
|
|
}
|
|
|
|
echo "1) ", var_export(substr("pear", 0, 2), true), PHP_EOL;
|
|
echo "2) ", var_export(substr(54321, 0, 2), true), PHP_EOL;
|
|
echo "3) ", var_export(substr(new apple(), 0, 2), true), PHP_EOL;
|
|
echo "4) ", var_export(substr(true, 0, 1), true), PHP_EOL;
|
|
echo "5) ", var_export(substr(false, 0, 1), true), PHP_EOL;
|
|
echo "6) ", var_export(substr("", 0, 1), true), PHP_EOL;
|
|
echo "7) ", var_export(substr(1.2e3, 0, 4), true), PHP_EOL;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
1) 'pe'
|
|
2) '54'
|
|
3) 'gr'
|
|
4) '1'
|
|
5) ''
|
|
6) ''
|
|
7) '1200'
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
|
|
<example>
|
|
<title>Intervalle de Caractères Invalide</title>
|
|
<para>
|
|
Si un intervalle de caractères invalide est demandé,
|
|
<function>substr</function> retourne une chaîne vide à partir de PHP 8.0.0;
|
|
auparavant &false; était retourné à la place.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
var_dump(substr('a', 2));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.8;
|
|
<screen>
|
|
<![CDATA[
|
|
string(0) ""
|
|
]]>
|
|
</screen>
|
|
&example.outputs.7;
|
|
<screen>
|
|
<![CDATA[
|
|
bool(false)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>strrchr</function></member>
|
|
<member><function>substr_replace</function></member>
|
|
<member><function>preg_match</function></member>
|
|
<member><function>trim</function></member>
|
|
<member><function>mb_substr</function></member>
|
|
<member><function>wordwrap</function></member>
|
|
<member><link linkend="language.types.string.substr">Accès et modification d'une chaîne, par caractère</link></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
|
|
-->
|