Files
2025-01-28 14:31:04 -03:00

179 lines
5.0 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: e6e9c116083c3d1aeb3d1fc2e45f51fbcb0d5182 Maintainer: leonardolara Status: ready --><!-- CREDITS: felipe,fabioluciano,cviniciussdias,leonardolara -->
<refentry xml:id="function.empty" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>empty</refname>
<refpurpose>Determina se uma variável está vazia</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>empty</methodname>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para>
Determina se uma variável é considerada vazia. Uma variável é considerada vazia se não existir ou seu valor for igual a &false;. A função <function>empty</function> não gera um aviso se a variável não existir.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
Variável a ser verificada
</para>
<para>
Nenhum aviso é gerado se a variável não existir.
Isso significa que a função <function>empty</function> é essencialmente
o equivalente sucinto de <command>!isset($var) || $var == false</command>.
Isto também se aplica a estruturas aninhadas, tais como um array multidimensional ou propriedades em encadeadas.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna &true; se <parameter>var</parameter> não existir ou se tiver um valor que é vazio ou igual a zero.
Consulte <link linkend="language.types.boolean.casting">conversão para booleano</link>.
Caso contrário, retorna &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
Uma simples comparação entre as funções <function>empty</function> /
<function>isset</function>.
</title>
<programlisting role="php">
<![CDATA[
<?php
$var = 0;
// Avaliado como verdadeiro porque $var está vazia
if (empty($var)) {
echo '$var é 0, vazia ou não definida';
}
// Avaliado como verdadeiro porque $var está definida
if (isset($var)) {
echo '$var está definida embora esteja vazia';
}
?>
]]>
</programlisting>
</example>
</para>
<example>
<title>Função <function>empty</function> em posições de string</title>
<programlisting role="php">
<![CDATA[
<?php
$expected_array_got_string = 'somestring';
var_dump(empty($expected_array_got_string['some_key']));
var_dump(empty($expected_array_got_string[0]));
var_dump(empty($expected_array_got_string['0']));
var_dump(empty($expected_array_got_string['0.5']));
var_dump(empty($expected_array_got_string['0 Mostel']));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(false)
bool(false)
bool(true)
bool(true)
]]>
</screen>
</example>
<example>
<title><function>empty</function> on array multidimensional</title>
<programlisting role="php">
<![CDATA[
<?php
$multidimensional = [
'some' => [
'deep' => [
'nested' => 'value'
]
]
];
if (!empty($multidimensional['some']['some']['nested'])) {
$someVariable = $multidimensional['some']['deep']['nested'];
}
var_dump(empty($multidimensional['some-undefined-key']));
var_dump(empty($multidimensional['some']['deep']['unknown']));
var_dump(empty($multidimensional['some']['deep']['nested']));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(true)
bool(false)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.language-construct;
<note>
<para>
Ao utilizar a função <function>empty</function> em propriedades de objetos inacessíveis,
o método de sobrecarga <link linkend="object.isset">__isset()</link>
será chamado, se declarado.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>isset</function></member>
<member><link linkend="object.isset">__isset()</link></member>
<member><function>unset</function></member>
<member><function>array_key_exists</function></member>
<member><function>count</function></member>
<member><function>strlen</function></member>
<member><link linkend="types.comparisons">A tabela de comparação de tipos</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
-->