archived-doc-pt-br/reference/session/sessionhandlerinterface.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 62126c55f1c6ed444043e7272c4f9e233818a44b Maintainer: leonardolara Status: ready --><!-- CREDITS: marcosmarcolin, leonardolara -->
<reference xml:id="class.sessionhandlerinterface" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>A classe SessionHandlerInterface</title>
 <titleabbrev>SessionHandlerInterface</titleabbrev>

 <partintro>

<!-- {{{ SessionHandlerInterface intro -->
  <section xml:id="sessionhandlerinterface.intro">
   &reftitle.intro;
   <para>
    <classname>SessionHandlerInterface</classname> é uma interface que define o protótipo
    mínimo para criar um manipulador de sessão personalizado. Para passar um
    manipulador de sessão personalizado para <function>session_set_save_handler</function> usando
    invocação <abbrev>OOP</abbrev> (Orientada à Objetos), a classe deve implementar esta interface.
   </para>
   <para>
    Note que os métodos de callbacks desta classe são projetos para serem chamados internamente pelo
    PHP e não para serem chamados pelo código do usuário.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="sessionhandlerinterface.synopsis">
   &reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="interface">
    <oointerface>
     <interfacename>SessionHandlerInterface</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sessionhandlerinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SessionHandlerInterface'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

  <section xml:id="sessionhandlerinterface.examples">
   &reftitle.examples;
   <example>
    <title>
     Exemplo usando <classname>SessionHandlerInterface</classname>
    </title>
    <para>
     O exemplo a seguir apresenta um armazenamento de sessão baseada em arquivos semelhante aos
     manipuladores de gravação de sessão padrões do PHP <parameter>files</parameter>.  Este
     exemplo poderia ser facilmente estendido para cobrir armazenamento em banco de dados usando sua
     engine de banco de dados favorita que seja suportada pelo PHP.
    </para>
    <para>
     Note que é usado orientação à objetos com <function>session_set_save_handler</function> e
     a função de encerramento (register_shutdown) é registrada usando sua respectiva flag.  Isto é
     aconselhável ao registrar objetos como manipuladores de gravação de sessão.
    </para>
    <caution>
     <para>
      Por brevidade, este exemplo omite a validação de entrada. No entanto, o
      Os parâmetros <literal>$id</literal> são, na verdade, valores fornecidos pelo usuário que
      exigem validação/sanitização adequada para evitar vulnerabilidades, como
      problemas de passagem de caminho. <emphasis>Portanto, não use este exemplo não modificado em
      ambientes de produção.</emphasis>
     </para>
    </caution>
    <programlisting role="php">
<![CDATA[
<?php
class MySessionHandler implements SessionHandlerInterface
{
    private $savePath;

    public function open($savePath, $sessionName): bool
    {
        $this->savePath = $savePath;
        if (!is_dir($this->savePath)) {
            mkdir($this->savePath, 0777);
        }

        return true;
    }

    public function close(): bool
    {
        return true;
    }

    #[\ReturnTypeWillChange]
    public function read($id)
    {
        return (string)@file_get_contents("$this->savePath/sess_$id");
    }

    public function write($id, $data): bool
    {
        return file_put_contents("$this->savePath/sess_$id", $data) === false ? false : true;
    }

    public function destroy($id): bool
    {
        $file = "$this->savePath/sess_$id";
        if (file_exists($file)) {
            unlink($file);
        }

        return true;
    }

    #[\ReturnTypeWillChange]
    public function gc($maxlifetime)
    {
        foreach (glob("$this->savePath/sess_*") as $file) {
            if (filemtime($file) + $maxlifetime < time() && file_exists($file)) {
                unlink($file);
            }
        }

        return true;
    }
}

$handler = new MySessionHandler();
session_set_save_handler($handler, true);
session_start();

// proceder para definir e recuperar valores pela chave de $_SESSION
]]>
    </programlisting>
   </example>
  </section>

 </partintro>

 &reference.session.entities.sessionhandlerinterface;

</reference>
<!-- 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
-->