diff --git a/.github/lang/es-ES/README.md b/.github/lang/es-ES/README.md index 2e25a23..236d53a 100644 --- a/.github/lang/es-ES/README.md +++ b/.github/lang/es-ES/README.md @@ -26,7 +26,7 @@ Biblioteca PHP para manejo de sesiones. - [Cómo empezar](#cómo-empezar) - [Uso](#uso) - [Tests](#tests) -- [Tareas pendientes](#-tareas-pendientes) +- [Tareas pendientes](#tareas-pendientes) - [Registro de Cambios](#registro-de-cambios) - [Contribuir](#contribuir) - [Patrocinar](#patrocinar) @@ -68,163 +68,131 @@ Métodos disponibles en esta biblioteca: ### Iniciar la sesión ```php -$session->start(array $options = []); +$session->start(array $options = []): bool ``` **@see** -para ver la lista de las `$opciones` disponibles y sus valores por defecto +para ver la lista de las `$opciones` disponibles y sus valores por defecto. -**@throws** `SessionException` Si los _headers_ ya se enviaron +**@throws** `SessionException` si los _headers_ ya se enviaron. -**@throws** `SessionException` Si la sesión ya está iniciada +**@throws** `SessionException` si la sesión ya está iniciada. -**@throws** `SessionException` Si hay algún fallo con las opciones - -**@Return** `bool` +**@throws** `SessionException` si hay algún fallo con las opciones. ### Comprobar si la sesión está iniciada ```php -$session->isStarted(); +$session->isStarted(): bool ``` -**@Return** `bool` - ### Establecer un atributo por su nombre ```php -$session->set(string $name, mixed $value = null); +$session->set(string $name, mixed $value): void ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión no está iniciada. ### Obtener un atributo por su nombre Opcionalmente define un valor por defecto cuando el atributo no existe. ```php -$session->get(string $name, mixed $default = null); +$session->get(string $name, mixed $default = null): mixed ``` -**@Return** `mixed` Valor - ### Obtener todos los atributos ```php -$session->all(); +$session->all(): array ``` -**@Return** `array` Contenido de la $_SESSION - ### Comprobar si un atributo existe en la sesión ```php -$session->has(string $name); +$session->has(string $name): bool ``` -**@Return** `bool` - ### Establecer múltiples atributos de una vez Si los atributos existen se sustituyen, si no existen se crean. ```php -$session->replace(array $data); +$session->replace(array $data): void ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión no está iniciada. ### Eliminar un atributo por su nombre y devolver su valor Opcionalmente define un valor por defecto cuando el atributo no existe. ```php -$session->pull(string $name, mixed $default = null); +$session->pull(string $name, mixed $default = null): mixed ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `mixed` Valor +**@throws** `SessionException` si la sesión no está iniciada. ### Eliminar un atributo por su nombre ```php -$session->remove(string $name); +$session->remove(string $name): void ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión no está iniciada. ### Liberar todas las variables de la sesión ```php -$session->clear(); +$session->clear(): void ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión no está iniciada. ### Obtiene el ID de la sesión ```php -$session->getId(); +$session->getId(): string ``` -**@Return** `string` ID de la sesión - ### Establecer el ID de la sesión ```php -$session->setId(string $sessionId); +$session->setId(string $sessionId): void ``` -**@throws** `SessionException` Si la sesión ya está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión ya está iniciada. ### Actualizar el ID de la sesión actual con uno recién generado ```php -$session->regenerateId(bool $deleteOldSession = false); +$session->regenerateId(bool $deleteOldSession = false): bool ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `bool` +**@throws** `SessionException` si la sesión no está iniciada. ### Obtener el nombre de la sesión ```php -$session->getName(); +$session->getName(): string ``` -**@Return** `string` Nombre de la sesión - ### Establecer el nombre de la sesión ```php -$session->setName(string $name); +$session->setName(string $name): void ``` -**@throws** `SessionException` Si la sesión ya está iniciada - -**@Return** `void` +**@throws** `SessionException` si la sesión ya está iniciada. ### Eliminar la sesión ```php -$session->destroy(); +$session->destroy(): bool ``` -**@throws** `SessionException` Si la sesión no está iniciada - -**@Return** `bool` +**@throws** `SessionException` si la sesión no está iniciada. ## Cómo empezar @@ -561,17 +529,17 @@ Ejecutar todas las pruebas anteriores: composer tests ``` -## ☑ Tareas pendientes +## Tareas pendientes -- [ ] Añadir nueva funcionalidad. -- [ ] Mejorar pruebas. -- [ ] Mejorar documentación. -- [ ] Mejorar la traducción al inglés en el archivo README. -- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. -Ver [phpmd.xml](phpmd.xml) y [phpcs.xml](phpcs.xml). -- [ ] Mostrar un ejemplo de renovación de la duración de la sesión. -- [ ] Funcionalidad para activar/desactivar excepciones? -- [ ] Funcionalidad para añadir prefijos en los atributos de sesión? +- [ ] Añadir nueva funcionalidad +- [ ] Mejorar pruebas +- [ ] Mejorar documentación +- [ ] Mejorar la traducción al inglés en el archivo README +- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas +(ver [phpmd.xml](phpmd.xml) y [phpcs.xml](phpcs.xml)) +- [ ] Mostrar un ejemplo de renovación de la duración de la sesión +- [ ] ¿Funcionalidad para activar/desactivar excepciones? +- [ ] ¿Funcionalidad para añadir prefijos en los atributos de sesión? ## Registro de Cambios @@ -583,7 +551,7 @@ Los cambios detallados de cada versión se documentan en las Por favor, asegúrate de leer la [Guía de contribución](CONTRIBUTING.md) antes de hacer un _pull request_, comenzar una discusión o reportar un _issue_. -¡Gracias por [colaborar](https://github.com/josantonius/php-json/graphs/contributors)! :heart: +¡Gracias por [colaborar](https://github.com/josantonius/php-session/graphs/contributors)! :heart: ## Patrocinar diff --git a/README.md b/README.md index 9eeae17..d0a3208 100644 --- a/README.md +++ b/README.md @@ -68,163 +68,131 @@ Available methods in this library: ### Starts the session ```php -$session->start(array $options = []); +$session->start(array $options = []): bool ``` **@see** -for List of available `$options` and their default values +for List of available `$options` and their default values. -**@throws** `SessionException` If headers already sent +**@throws** `SessionException` if headers already sent. -**@throws** `SessionException` If session already started +**@throws** `SessionException` if session already started. -**@throws** `SessionException` If setting options failed - -**@Return** `bool` +**@throws** `SessionException` if setting options failed. ### Check if the session is started ```php -$session->isStarted(); +$session->isStarted(): bool ``` -**@Return** `bool` - ### Sets an attribute by name ```php -$session->set(string $name, mixed $value = null); +$session->set(string $name, mixed $value): void ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `void` +**@throws** `SessionException` if session is unstarted. ### Gets an attribute by name Optionally defines a default value when the attribute does not exist. ```php -$session->get(string $name, mixed $default = null); +$session->get(string $name, mixed $default = null): mixed ``` -**@Return** `mixed` Value - ### Gets all attributes ```php -$session->all(); +$session->all(): array ``` -**@Return** `array` $_SESSION content - ### Check if an attribute exists in the session ```php $session->has(string $name); ``` -**@Return** `bool` - ### Sets several attributes at once If attributes exist they are replaced, if they do not exist they are created. ```php -$session->replace(array $data); +$session->replace(array $data): void ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `void` +**@throws** `SessionException` if session is unstarted. ### Deletes an attribute by name and returns its value Optionally defines a default value when the attribute does not exist. ```php -$session->pull(string $name, mixed $default = null); +$session->pull(string $name, mixed $default = null): mixed ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `mixed` Attribute value +**@throws** `SessionException` if session is unstarted. ### Deletes an attribute by name ```php -$session->remove(string $name); +$session->remove(string $name): void ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `void` +**@throws** `SessionException` if session is unstarted. ### Free all session variables ```php -$session->clear(); +$session->clear(): void ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `void` +**@throws** `SessionException` if session is unstarted. ### Gets the session ID ```php -$session->getId(); +$session->getId() string ``` -**@Return** `string` Session ID - ### Sets the session ID ```php -$session->setId(string $sessionId); +$session->setId(string $sessionId): void ``` -**@throws** `SessionException` If session already started - -**@Return** `void` +**@throws** `SessionException` if session already started. ### Update the current session id with a newly generated one ```php -$session->regenerateId(bool $deleteOldSession = false); +$session->regenerateId(bool $deleteOldSession = false): bool ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `bool` +**@throws** `SessionException` if session is unstarted. ### Gets the session name ```php -$session->getName(); +$session->getName(): string ``` -**@Return** `string` Session name - ### Sets the session name ```php -$session->setName(string $name); +$session->setName(string $name): void ``` -**@throws** `SessionException` If session already started - -**@Return** `void` +**@throws** `SessionException` if session already started. ### Destroys the session ```php -$session->destroy(); +$session->destroy(): bool ``` -**@throws** `SessionException` If session is unstarted - -**@Return** `bool` +**@throws** `SessionException` if session is unstarted. ## Quick Start @@ -567,7 +535,7 @@ composer tests - [ ] Improve tests - [ ] Improve documentation - [ ] Improve English translation in the README file -- [ ] Refactor code for disabled code style rules. See [phpmd.xml](phpmd.xml) and [phpcs.xml](phpcs.xml) +- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml) - [ ] Show an example of renewing the session lifetime - [ ] Feature to enable/disable exceptions? - [ ] Feature to add prefixes in session attributes?