Skip to content

Commit c23a64f

Browse files
GirgiasGirgias
committed
Sync part of Session docs with EN to improve build situation
1 parent be7a463 commit c23a64f

File tree

15 files changed

+213
-232
lines changed

15 files changed

+213
-232
lines changed

‎reference/session/sessionhandler.xml

Lines changed: 33 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 7fa66b6c0b15efc7e1d5ef0f5f01280c73f981f9 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 4d17b7b4947e7819ff5036715dd706be87ae4def Maintainer: seros Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<reference xml:id="class.sessionhandler" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
7-
5+
86
<title>La clase SessionHandler</title>
97
<titleabbrev>SessionHandler</titleabbrev>
10-
8+
119
<partintro>
12-
10+
1311
<!-- {{{ SessionHandler intro -->
1412
<section xml:id="sessionhandler.intro">
1513
&reftitle.intro;
@@ -59,34 +57,36 @@
5957
</para>
6058
</section>
6159
<!-- }}} -->
62-
60+
6361
<section xml:id="sessionhandler.synopsis">
6462
&reftitle.classsynopsis;
65-
63+
6664
<!-- {{{ Synopsis -->
67-
<classsynopsis>
68-
<ooclass><classname>SessionHandler</classname></ooclass>
69-
70-
<!-- {{{ Class synopsis -->
71-
<classsynopsisinfo>
72-
<ooclass>
73-
<classname>SessionHandler</classname>
74-
</ooclass>
75-
76-
<oointerface>
77-
<interfacename>SessionHandlerInterface</interfacename>
78-
</oointerface>
79-
</classsynopsisinfo>
80-
<!-- }}} -->
81-
65+
<classsynopsis class="class">
66+
<ooclass>
67+
<classname>SessionHandler</classname>
68+
</ooclass>
69+
70+
<oointerface>
71+
<modifier>implements</modifier>
72+
<interfacename>SessionHandlerInterface</interfacename>
73+
</oointerface>
74+
75+
<oointerface>
76+
<interfacename>SessionIdInterface</interfacename>
77+
</oointerface>
78+
8279
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
83-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sessionhandler')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
80+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sessionhandler')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SessionHandler'])">
81+
<xi:fallback/>
82+
</xi:include>
8483
</classsynopsis>
8584
<!-- }}} -->
86-
85+
8786
</section>
88-
87+
8988
<section xml:id="session.notes">
89+
&reftitle.notes;
9090
<warning>
9191
<para>
9292
Esta clase está diseñada para exponer el gestor de almacenamiento de sesiones interno de PHP, si quiere
@@ -95,32 +95,9 @@
9595
</para>
9696
</warning>
9797
</section>
98-
99-
<section role="changelog" xml:id="sessionhandler.changelog"><!-- {{{ -->
100-
&reftitle.changelog;
101-
<para>
102-
<informaltable>
103-
<tgroup cols="2">
104-
<thead>
105-
<row>
106-
<entry>&Version;</entry>
107-
<entry>&Description;</entry>
108-
</row>
109-
</thead>
110-
<tbody>
111-
<row>
112-
<entry>5.5.1</entry>
113-
<entry>
114-
Se añadió <function>SessionHandler::create_sid</function>.
115-
</entry>
116-
</row>
117-
</tbody>
118-
</tgroup>
119-
</informaltable>
120-
</para>
121-
</section><!-- }}} -->
122-
98+
12399
<section xml:id="sessionhandler.examples">
100+
&reftitle.examples;
124101
<example>
125102
<title>
126103
Usar <classname>SessionHandler</classname> para añadir encriptación a los gestores de almacenamiento internos de PHP.
@@ -164,8 +141,8 @@ function decrypt($edata, $password) {
164141
* @return base64 encrypted data
165142
*/
166143
function encrypt($data, $password) {
167-
// Set a random salt
168-
$salt = openssl_random_pseudo_bytes(16);
144+
// Generate a cryptographically secure random salt using random_bytes()
145+
$salt = random_bytes(16);
169146
170147
$salted = '';
171148
$dx = '';
@@ -233,13 +210,12 @@ session_start();
233210
</para>
234211
</note>
235212
</section>
236-
213+
237214
</partintro>
238-
215+
239216
&reference.session.entities.sessionhandler;
240-
241-
</reference>
242217

218+
</reference>
243219
<!-- Keep this comment at the end of the file
244220
Local variables:
245221
mode: sgml

‎reference/session/sessionhandler/close.xml

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: aebf045bfb7f4f2350db5e1e908cf290be334075 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: seros Status: ready -->
43
<!-- Reviewed: yes Maintainer: seros -->
5-
64
<refentry xml:id="sessionhandler.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>SessionHandler::close</refname>
97
<refpurpose>Cerrar la sesión</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="SessionHandler">
1513
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::close</methodname>
16-
<void />
14+
<void/>
1715
</methodsynopsis>
1816
<para>
1917
Cierra la sesión actual. Este método es ejecutado de forma automática internamente por PHP al
@@ -34,23 +32,22 @@
3432
Para más información sobre lo que se espera que haga este método, consulte la documentación de
3533
<function>SessionHandlerInterface::close</function>.
3634
</para>
37-
35+
3836
</refsect1>
39-
37+
4038
<refsect1 role="parameters">
4139
&reftitle.parameters;
4240
&no.function.parameters;
4341
</refsect1>
44-
42+
4543
<refsect1 role="returnvalues">
4644
&reftitle.returnvalues;
4745
<para>
4846
&returns.session.storage.retval;
4947
</para>
5048
</refsect1>
51-
52-
</refentry>
5349

50+
</refentry>
5451
<!-- Keep this comment at the end of the file
5552
Local variables:
5653
mode: sgml

‎reference/session/sessionhandler/create-sid.xml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: efd6aa8b0c567335996c6a27b2fbd264b30f90f8 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: seros Status: ready -->
43
<!-- Reviewed: no Maintainer: andresdzphp -->
5-
64
<refentry xml:id="sessionhandler.create-sid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>SessionHandler::create_sid</refname>
97
<refpurpose>Devuelve un nuevo ID de sesión</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="SessionHandler">
1513
<modifier>public</modifier> <type>string</type><methodname>SessionHandler::create_sid</methodname>
1614
<void/>
1715
</methodsynopsis>
1816
<para>
1917
Genera y devuelve un nuevo ID de sesión
2018
</para>
2119
</refsect1>
22-
20+
21+
<refsect1 role="parameters">
22+
&reftitle.parameters;
23+
&no.function.parameters;
24+
</refsect1>
25+
2326
<refsect1 role="returnvalues">
2427
&reftitle.returnvalues;
2528
<para>
2629
Un ID de sesión válido para el manejador de sesión predeterminado.
2730
</para>
2831
</refsect1>
29-
32+
3033
<refsect1 role="seealso">
3134
&reftitle.seealso;
3235
<para>
@@ -37,7 +40,6 @@
3740
</para>
3841
</refsect1>
3942
</refentry>
40-
4143
<!-- Keep this comment at the end of the file
4244
Local variables:
4345
mode: sgml

‎reference/session/sessionhandler/destroy.xml

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: aebf045bfb7f4f2350db5e1e908cf290be334075 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: seros Status: ready -->
43
<!-- Reviewed: yes Maintainer: seros -->
5-
64
<refentry xml:id="sessionhandler.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>SessionHandler::destroy</refname>
97
<refpurpose>Destruir una sesión</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="SessionHandler">
1513
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::destroy</methodname>
16-
<methodparam><type>string</type><parameter>session_id</parameter></methodparam>
14+
<methodparam><type>string</type><parameter>id</parameter></methodparam>
1715
</methodsynopsis>
1816
<para>
1917
Destruye una sesión. Llamado internamente por PHP con <function>session_regenerate_id</function> (se asume
@@ -35,13 +33,13 @@
3533
de <function>SessionHandlerInterface::destroy</function>.
3634
</para>
3735
</refsect1>
38-
36+
3937
<refsect1 role="parameters">
4038
&reftitle.parameters;
4139
<para>
4240
<variablelist>
4341
<varlistentry>
44-
<term><parameter>session_id</parameter></term>
42+
<term><parameter>id</parameter></term>
4543
<listitem>
4644
<para>
4745
El ID de sesión a ser destruido.
@@ -51,17 +49,16 @@
5149
</variablelist>
5250
</para>
5351
</refsect1>
54-
52+
5553
<refsect1 role="returnvalues">
5654
&reftitle.returnvalues;
5755
<para>
5856
&returns.session.storage.retval;
5957
</para>
6058
</refsect1>
61-
62-
63-
</refentry>
6459

60+
61+
</refentry>
6562
<!-- Keep this comment at the end of the file
6663
Local variables:
6764
mode: sgml

‎reference/session/sessionhandler/gc.xml

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: aebf045bfb7f4f2350db5e1e908cf290be334075 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: seros Status: wip -->
43
<!-- Reviewed: yes Maintainer: seros -->
5-
64
<refentry xml:id="sessionhandler.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>SessionHandler::gc</refname>
97
<refpurpose>Eliminar las sesiones antiguas</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
15-
<modifier>public</modifier> <type>int</type><methodname>SessionHandler::gc</methodname>
16-
<methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
12+
<methodsynopsis role="SessionHandler">
13+
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandler::gc</methodname>
14+
<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
1715
</methodsynopsis>
1816
<para>
1917
Elimina las sesiones expiradas. Este método llamado de forma aleatoria internamente por PHP al iniciar una sesión o cuando
@@ -37,31 +35,52 @@
3735
<function>SessionHandlerInterface::gc</function>.
3836
</para>
3937
</refsect1>
40-
38+
4139
<refsect1 role="parameters">
4240
&reftitle.parameters;
4341
<variablelist>
4442
<varlistentry>
45-
<term><parameter>maxlifetime</parameter></term>
43+
<term><parameter>max_lifetime</parameter></term>
4644
<listitem>
4745
<para>
48-
Las sesiones que no se han actualizado desde los últimos <parameter>maxlifetime</parameter> segundos serán eliminadas.
46+
Las sesiones que no se han actualizado desde los últimos <parameter>max_lifetime</parameter> segundos serán eliminadas.
4947
</para>
5048
</listitem>
5149
</varlistentry>
5250
</variablelist>
5351
</refsect1>
54-
52+
5553
<refsect1 role="returnvalues">
5654
&reftitle.returnvalues;
5755
<para>
58-
&returns.session.storage.retval;
56+
Returns the number of deleted sessions on success, &return.falseforfailure;.
57+
Note this value is returned internally to PHP for processing.
5958
</para>
6059
</refsect1>
61-
62-
63-
</refentry>
6460

61+
<refsect1 role="changelog">
62+
&reftitle.changelog;
63+
<informaltable>
64+
<tgroup cols="2">
65+
<thead>
66+
<row>
67+
<entry>&Version;</entry>
68+
<entry>&Description;</entry>
69+
</row>
70+
</thead>
71+
<tbody>
72+
<row>
73+
<entry>7.1.0</entry>
74+
<entry>
75+
Prior to this version, the function returned &true; on success.
76+
</entry>
77+
</row>
78+
</tbody>
79+
</tgroup>
80+
</informaltable>
81+
</refsect1>
82+
83+
</refentry>
6584
<!-- Keep this comment at the end of the file
6685
Local variables:
6786
mode: sgml

0 commit comments

Comments
 (0)