Skip to content

docs: Port "Session" service page to 7.2 #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless-for-oss wants to merge 1 commit into
base: 7.2
Choose a base branch
from
Open

docs: Port "Session" service page to 7.2 #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion docs/plugin_services/session.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,46 @@ Session

Please read the :xref:`dev docs contributing guidelines` and :xref:`Contributing to Mautic’s documentation` to get started.

.. vale on
.. vale on

In Mautic 7, the session is part of the request. Obtain it from the current ``Request`` rather than from a ``session`` service. Inject ``Symfony\Component\HttpFoundation\RequestStack`` and call ``getSession()`` on the current request:

.. code-block:: php

@promptless-for-oss promptless-for-oss Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ported the session operations (all(), get() with a default, has(), set(), remove(), clear()) from the legacy _plugin_services_session.md guide. Updated the access pattern to RequestStack::getSession() for Mautic 7, since the legacy $this->get('session') service getter (and Symfony 2.8 Session class) no longer applies.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_services_session.md


<?php

use Symfony\Component\HttpFoundation\RequestStack;

final class ExampleService
{
public function __construct(private RequestStack $requestStack)
{
}

public function handleSession(): void
{
$session = $this->requestStack->getSession();

// Get all session parameters
$all = $session->all();

// Get a specific parameter, using 'mars' as the default
$world = $session->get('helloworld.world', 'mars');

// Check whether a parameter exists
if ($session->has('helloworld.world')) {
// Do something.
}

// Set a session parameter
$session->set('helloworld.world', 'mars');

// Remove a session parameter
$session->remove('helloworld.world');

// Clear the whole session
$session->clear();
}
}

Within a controller action, you can also type-hint ``Symfony\Component\HttpFoundation\Request`` as an argument and call ``$request->getSession()`` directly.
Loading