index.md

CommonPHP Session Documentation

CommonPHP Session is a small, driver-based session package. It owns session lifecycle behavior, session data access, named data bags, flash messages, and native PHP session integration.

The package is intentionally explicit. A session must be started before data can be read or written, storage details live behind SessionDriverInterface, and expected session failures are reported through CommonPHP session exceptions.

Start Here

• Getting started
• Usage
• Package boundaries

Session Concepts

• Lifecycle
• Session bags and flash data
• Drivers
• Native driver
• Error handling

Examples

• Examples index
• Basic session
• Flash messages
• Custom driver

Development

• Testing and QA

Public API Map

Entry points:

• CommonPHP\Session\SessionManager
• CommonPHP\Session\SessionBag
• CommonPHP\Session\FlashBag

Contracts:

• CommonPHP\Session\Contracts\SessionInterface
• CommonPHP\Session\Contracts\SessionDriverInterface
• CommonPHP\Session\Contracts\SessionBagInterface
• CommonPHP\Session\Contracts\FlashBagInterface
• CommonPHP\Session\Contracts\AbstractSessionDriver

Drivers:

• CommonPHP\Session\Drivers\NativeSessionDriver

Enums:

• CommonPHP\Session\Enums\SessionStatus

Exceptions:

• CommonPHP\Session\Exceptions\SessionException
• CommonPHP\Session\Exceptions\SessionDriverException
• CommonPHP\Session\Exceptions\InvalidSessionDriverException
• CommonPHP\Session\Exceptions\SessionNotStartedException
• CommonPHP\Session\Exceptions\SessionStartException
• CommonPHP\Session\Exceptions\SessionStorageException
• CommonPHP\Session\Exceptions\CorruptSessionDataException