Skip to content

Commit 36ec51f

Browse files
committed
docs: improve documentation
1 parent 64bbf88 commit 36ec51f

File tree

2 files changed

+57
-42
lines changed

2 files changed

+57
-42
lines changed

.github/lang/es-ES/README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ git clone https://github.com/josantonius/php-cookie.git
6868

6969
```php
7070
/**
71-
* Opciones por defecto:
71+
* Opciones:
7272
*
73-
* domain: '' - Dominio para el que estará disponible la cookie.
74-
* expires: 0 - Cuándo expirará la cookie.
75-
* httpOnly: false - Si la cookie sólo estará disponible a través del protocolo HTTP.
76-
* path: '/' - Ruta para la que estará disponible la cookie.
77-
* raw: false - Si la cookie se enviará como una cadena sin procesar.
78-
* sameSite: null - Impone el uso de una política samesite laxa o estricta.
79-
* secure: false - Si la cookie sólo estará disponible a través del protocolo HTTPS.
73+
* domain: Dominio para el que estará disponible la cookie.
74+
* expires: Cuándo expirará la cookie.
75+
* httpOnly: Si la cookie sólo estará disponible a través del protocolo HTTP.
76+
* path: Ruta para la que estará disponible la cookie.
77+
* raw: Si la cookie se enviará como una cadena sin procesar.
78+
* sameSite: Impone el uso de una política samesite laxa o estricta.
79+
* secure: Si la cookie sólo estará disponible a través del protocolo HTTPS.
8080
*
8181
* Estos ajustes se utilizarán para crear y eliminar cookies.
8282
*/
@@ -100,7 +100,11 @@ para conocer los formatos de fecha y hora admitidos.
100100
### Establece una cookie por nombre
101101

102102
```php
103-
$cookie->set(string $name, mixed $value, null|int|string|DateTime $expires = null): void;
103+
$cookie->set(
104+
string $name,
105+
mixed $value,
106+
null|int|string|DateTime $expires = null
107+
): void
104108
```
105109

106110
**@throws** `CookieException` si las cabeceras ya han sido enviadas.
@@ -112,7 +116,10 @@ $cookie->set(string $name, mixed $value, null|int|string|DateTime $expires = nul
112116
Si las cookies existen se sustituyen, si no existen se crean.
113117

114118
```php
115-
$cookie->replace(array $data, null|int|string|DateTime $expires = null): void
119+
$cookie->replace(
120+
array $data,
121+
null|int|string|DateTime $expires = null
122+
): void
116123
```
117124

118125
**@throws** `CookieException` si las cabeceras ya han sido enviadas.
@@ -382,16 +389,13 @@ se utilizará este en lugar del valor de **_expires_** establecido en las opcion
382389
expires: 'now +1 minute'
383390
);
384391

385-
$cookie->set('foo', 'bar'); // Esta cookie expirará en 1 minuto
392+
$cookie->set('foo', 'bar'); // Caduca en 1 minuto
386393

387-
$cookie->set('bar', 'foo', 'now +8 days'); // Esta cookie expirará en 8 días
394+
$cookie->set('bar', 'foo', 'now +8 days'); // Caduca en 8 días
388395

389-
$cookie->replace(['foo' => 'bar']); // Estas cookies expirarán en 1 minuto
396+
$cookie->replace(['foo' => 'bar']); // Caduca en 1 minuto
390397

391-
$cookie->replace( // Estas cookies expirarán en 1 hora
392-
['foo' => 'bar'],
393-
time() + 3600
394-
);
398+
$cookie->replace(['foo' => 'bar'], time() + 3600); // Caduca en 1 hora
395399
```
396400

397401
- Si el parámetro **expires** pasado en las opciones es una cadena de fecha/hora,
@@ -402,8 +406,7 @@ se formateará cuando se utiliza el método `set` o `replace` y no cuando se est
402406
expires: 'now +1 minute', // Todavía no se formateará como tiempo unix
403407
);
404408

405-
$cookie->set('foo', 'bar'); // Se formateará en este momento
406-
// y expirará 1 minuto después de la creación de esta cookie
409+
$cookie->set('foo', 'bar'); // Se formateará ahora y expirará en 1 minuto
407410
```
408411

409412
## Tests

README.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@ Available methods in this library:
7070

7171
```php
7272
/**
73-
* Default options:
73+
* Cookie options:
7474
*
75-
* domain: '' - Domain for which the cookie is available.
76-
* expires: 0 - The time the cookie will expire.
77-
* httpOnly: false - If cookie will only be available through the HTTP protocol.
78-
* path: '/' - Path for which the cookie is available.
79-
* raw: false - If cookie will be sent as a raw string.
80-
* sameSite: null - Enforces the use of a Lax or Strict SameSite policy.
81-
* secure: false - If cookie will only be available through the HTTPS protocol.
75+
* domain: Domain for which the cookie is available.
76+
* expires: The time the cookie will expire.
77+
* httpOnly: If cookie will only be available through the HTTP protocol.
78+
* path: Path for which the cookie is available.
79+
* raw: If cookie will be sent as a raw string.
80+
* sameSite: Enforces the use of a Lax or Strict SameSite policy.
81+
* secure: If cookie will only be available through the HTTPS protocol.
8282
*
8383
* These settings will be used to create and delete cookies.
8484
*/
@@ -102,7 +102,11 @@ for supported date and time formats.
102102
### Sets a cookie by name
103103

104104
```php
105-
$cookie->set(string $name, mixed $value, null|int|string|DateTime $expires = null): void;
105+
$cookie->set(
106+
string $name,
107+
mixed $value,
108+
null|int|string|DateTime $expires = null
109+
): void
106110
```
107111

108112
**@throws** `CookieException` if headers already sent.
@@ -114,7 +118,10 @@ $cookie->set(string $name, mixed $value, null|int|string|DateTime $expires = nul
114118
If cookies exist they are replaced, if they do not exist they are created.
115119

116120
```php
117-
$cookie->replace(array $data, null|int|string|DateTime $expires = null): void
121+
$cookie->replace(
122+
array $data,
123+
null|int|string|DateTime $expires = null
124+
): void
118125
```
119126

120127
**@throws** `CookieException` if headers already sent.
@@ -249,19 +256,28 @@ Cookie::set('foo', 'bar', new DateTime('now +1 hour'));
249256
Without modifying the expiration time:
250257

251258
```php
252-
$cookie->replace(['foo' => 'bar', 'bar' => 'foo']);
259+
$cookie->replace([
260+
'foo' => 'bar',
261+
'bar' => 'foo'
262+
]);
253263
```
254264

255265
Modifying the expiration time:
256266

257267
```php
258-
$cookie->replace(['foo' => 'bar', 'bar' => 'foo'], time() + 3600);
268+
$cookie->replace([
269+
'foo' => 'bar',
270+
'bar' => 'foo'
271+
], time() + 3600);
259272
```
260273

261274
[Using the facade](#using-the-facade):
262275

263276
```php
264-
Cookie::replace(['foo' => 'bar', 'bar' => 'foo'], time() + 3600);
277+
Cookie::replace([
278+
'foo' => 'bar',
279+
'bar' => 'foo'
280+
], time() + 3600);
265281
```
266282

267283
### - Gets a cookie by name
@@ -384,16 +400,13 @@ it will be taken instead of the **expires** value set in the cookie options.
384400
expires: 'now +1 minute'
385401
);
386402

387-
$cookie->set('foo', 'bar'); // This cookie will expire in 1 minute
403+
$cookie->set('foo', 'bar'); // Expires in 1 minute
388404

389-
$cookie->set('bar', 'foo', 'now +8 days'); // This cookie will expire in 8 days
405+
$cookie->set('bar', 'foo', 'now +8 days'); // Expires in 8 days
390406

391-
$cookie->replace(['foo' => 'bar']); // This cookies will expire in 1 minute
407+
$cookie->replace(['foo' => 'bar']); // Expires in 1 minute
392408

393-
$cookie->replace( // This cookies will expire in 1 hour
394-
['foo' => 'bar'],
395-
time() + 3600
396-
);
409+
$cookie->replace(['foo' => 'bar'], time() + 3600); // Expires in 1 hour
397410
```
398411

399412
- If the **expires** parameter passed in the options is a date/time string,
@@ -404,8 +417,7 @@ it is formatted when using the `set` or `replace` method and not when setting th
404417
expires: 'now +1 minute', // It will not be formatted as unix time yet
405418
);
406419

407-
$cookie->set('foo', 'bar'); // It is will formatted now
408-
// and will expire 1 minute after this cookie is created
420+
$cookie->set('foo', 'bar'); // It is will formatted now and expires in 1 minute
409421
```
410422

411423
## Tests
@@ -456,7 +468,7 @@ composer tests
456468
- [ ] Improve tests
457469
- [ ] Improve documentation
458470
- [ ] Improve English translation in the README file
459-
- [ ] Refactor code for disabled code style rules. See [phpmd.xml](phpmd.xml) and [phpcs.xml](phpcs.xml)
471+
- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
460472

461473
## Changelog
462474

0 commit comments

Comments
 (0)