Skip to content

Commit cc95c98

Browse files
committed
docs: improve documentation
1 parent 689afcb commit cc95c98

File tree

2 files changed

+81
-59
lines changed

2 files changed

+81
-59
lines changed

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

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -196,15 +196,17 @@ $session->destroy(): bool
196196

197197
## Cómo empezar
198198

199-
Para utilizar esta biblioteca con **Composer**:
199+
### Utilizando objetos
200200

201201
```php
202202
use Josantonius\Session\Session;
203203

204204
$session = new Session();
205205
```
206206

207-
O puedes utilizar la fachada para acceder a los métodos de manera estática:
207+
### Utilizando la fachada
208+
209+
Alternativamente puedes utilizar la fachada para acceder a los métodos de manera estática:
208210

209211
```php
210212
use Josantonius\Session\Facades\Session;
@@ -216,6 +218,8 @@ Ejemplo de uso para esta biblioteca:
216218

217219
### - Iniciar la sesión
218220

221+
[Utilizando objetos](#utilizando-objetos):
222+
219223
Sin establecer opciones:
220224

221225
```php
@@ -255,42 +259,44 @@ $session->start([
255259
]);
256260
```
257261

258-
Utilizando la fachada:
262+
[Utilizando la fachada](#utilizando-la-fachada):
259263

260264
```php
261265
Session::start();
262266
```
263267

264268
### - Comprobar si la sesión está iniciada
265269

266-
Utilizando el objeto de sesión:
270+
[Utilizando objetos](#utilizando-objetos):
267271

268272
```php
269273
$session->isStarted();
270274
```
271275

272-
Utilizando la fachada:
276+
[Utilizando la fachada](#utilizando-la-fachada):
273277

274278
```php
275279
Session::isStarted();
276280
```
277281

278282
### - Establecer un atributo por su nombre
279283

280-
Utilizando el objeto de sesión:
284+
[Utilizando objetos](#utilizando-objetos):
281285

282286
```php
283287
$session->set('foo', 'bar');
284288
```
285289

286-
Utilizando la fachada:
290+
[Utilizando la fachada](#utilizando-la-fachada):
287291

288292
```php
289293
Session::set('foo', 'bar');
290294
```
291295

292296
### - Obtener un atributo por su nombre
293297

298+
[Utilizando objetos](#utilizando-objetos):
299+
294300
Sin valor por defecto si el atributo no existe:
295301

296302
```php
@@ -303,56 +309,58 @@ Con valor por defecto si el atributo no existe:
303309
$session->get('foo', false); // false si el atributo no existe
304310
```
305311

306-
Utilizando la fachada:
312+
[Utilizando la fachada](#utilizando-la-fachada):
307313

308314
```php
309315
Session::get('foo');
310316
```
311317

312318
### - Obtener todos los atributos
313319

314-
Utilizando el objeto de sesión:
320+
[Utilizando objetos](#utilizando-objetos):
315321

316322
```php
317323
$session->all();
318324
```
319325

320-
Utilizando la fachada:
326+
[Utilizando la fachada](#utilizando-la-fachada):
321327

322328
```php
323329
Session::all();
324330
```
325331

326332
### - Comprobar si un atributo existe en la sesión
327333

328-
Utilizando el objeto de sesión:
334+
[Utilizando objetos](#utilizando-objetos):
329335

330336
```php
331337
$session->has('foo');
332338
```
333339

334-
Utilizando la fachada:
340+
[Utilizando la fachada](#utilizando-la-fachada):
335341

336342
```php
337343
Session::has('foo');
338344
```
339345

340346
### - Establecer múltiples atributos de una vez
341347

342-
Utilizando el objeto de sesión:
348+
[Utilizando objetos](#utilizando-objetos):
343349

344350
```php
345351
$session->replace(['foo' => 'bar', 'bar' => 'foo']);
346352
```
347353

348-
Utilizando la fachada:
354+
[Utilizando la fachada](#utilizando-la-fachada):
349355

350356
```php
351357
Session::replace(['foo' => 'bar', 'bar' => 'foo']);
352358
```
353359

354360
### - Eliminar un atributo por su nombre y devolver su valor
355361

362+
[Utilizando objetos](#utilizando-objetos):
363+
356364
Sin valor por defecto si el atributo no existe:
357365

358366
```php
@@ -365,70 +373,72 @@ Con valor por defecto si el atributo no existe:
365373
$session->pull('foo', false); // false si el atributo no existe
366374
```
367375

368-
Utilizando la fachada:
376+
[Utilizando la fachada](#utilizando-la-fachada):
369377

370378
```php
371379
Session::pull('foo');
372380
```
373381

374382
### - Eliminar un atributo por su nombre
375383

376-
Utilizando el objeto de sesión:
384+
[Utilizando objetos](#utilizando-objetos):
377385

378386
```php
379387
$session->remove('foo');
380388
```
381389

382-
Utilizando la fachada:
390+
[Utilizando la fachada](#utilizando-la-fachada):
383391

384392
```php
385393
Session::remove('foo');
386394
```
387395

388396
### - Liberar todas las variables de la sesión
389397

390-
Utilizando el objeto de sesión:
398+
[Utilizando objetos](#utilizando-objetos):
391399

392400
```php
393401
$session->clear();
394402
```
395403

396-
Utilizando la fachada:
404+
[Utilizando la fachada](#utilizando-la-fachada):
397405

398406
```php
399407
Session::clear();
400408
```
401409

402410
### - Obtiene el ID de la sesión
403411

404-
Utilizando el objeto de sesión:
412+
[Utilizando objetos](#utilizando-objetos):
405413

406414
```php
407415
$session->getId();
408416
```
409417

410-
Utilizando la fachada:
418+
[Utilizando la fachada](#utilizando-la-fachada):
411419

412420
```php
413421
Session::getId();
414422
```
415423

416424
### - Establecer el ID de la sesión
417425

418-
Utilizando el objeto de sesión:
426+
[Utilizando objetos](#utilizando-objetos):
419427

420428
```php
421429
$session->setId('foo');
422430
```
423431

424-
Utilizando la fachada:
432+
[Utilizando la fachada](#utilizando-la-fachada):
425433

426434
```php
427435
Session::setId('foo');
428436
```
429437

430438
### - Actualizar el ID de la sesión actual con uno recién generado
431439

440+
[Utilizando objetos](#utilizando-objetos):
441+
432442
Regenerar el ID sin borrar la sesión anterior:
433443

434444
```php
@@ -441,49 +451,49 @@ Regenerar el ID borrando la sesión anterior:
441451
$session->regenerateId(true);
442452
```
443453

444-
Utilizando la fachada:
454+
[Utilizando la fachada](#utilizando-la-fachada):
445455

446456
```php
447457
Session::regenerateId();
448458
```
449459

450460
### - Obtener el nombre de la sesión
451461

452-
Utilizando el objeto de sesión:
462+
[Utilizando objetos](#utilizando-objetos):
453463

454464
```php
455465
$session->getName();
456466
```
457467

458-
Utilizando la fachada:
468+
[Utilizando la fachada](#utilizando-la-fachada):
459469

460470
```php
461471
Session::getName();
462472
```
463473

464474
### - Establecer el nombre de la sesión
465475

466-
Utilizando el objeto de sesión:
476+
[Utilizando objetos](#utilizando-objetos):
467477

468478
```php
469479
$session->setName('foo');
470480
```
471481

472-
Utilizando la fachada:
482+
[Utilizando la fachada](#utilizando-la-fachada):
473483

474484
```php
475485
Session::setName('foo');
476486
```
477487

478488
### - Eliminar la sesión
479489

480-
Utilizando el objeto de sesión:
490+
[Utilizando objetos](#utilizando-objetos):
481491

482492
```php
483493
$session->destroy();
484494
```
485495

486-
Utilizando la fachada:
496+
[Utilizando la fachada](#utilizando-la-fachada):
487497

488498
```php
489499
Session::destroy();

0 commit comments

Comments
 (0)