Magento\Framework\Session Namespace Reference

Namespaces
	Config
	SaveHandler
	Test

Data Structures
class	Config
class	ConfigTest
class	Generic
class	SaveHandler
class	SaveHandlerFactory
interface	SaveHandlerInterface
class	SaveHandlerTest
class	SessionManager
interface	SessionManagerInterface
class	SessionManagerTest
class	SidResolver
interface	SidResolverInterface
class	SidResolverTest
class	Storage
interface	StorageInterface
class	Validator
interface	ValidatorInterface

Functions
	ini_set ($varName, $newValue)
	session_regenerate_id ($var)
	ini_get ($varName)
	session_status ()
	headers_sent ()
	session_set_save_handler ()

Detailed Description

Session configuration object

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Session config interface

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Magento session manager

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Magento session manager interface

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

SID resolver

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

SID resolver interface

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Default session storage

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Session storage interface

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Session validator interface

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Function Documentation

headers_sent()

Magento\Framework\Session\headers_sent

(

)

Definition at line 32 of file SessionManagerTest.php.

    {
        global $mockPHPFunctions;
        if ($mockPHPFunctions) {
            return false;
        }
        return call_user_func_array('\headers_sent', func_get_args());
    }

ini_get()

Magento\Framework\Session\ini_get

(

$varName

)

Mock ini_get global function

Returns

string

Definition at line 22 of file ConfigTest.php.

    {
        global $mockPHPFunctions;
        if ($mockPHPFunctions == 1) {
            switch ($varName) {
                case 'session.save_path':
                    return 'preset_save_path';
                case 'session.save_handler':
                    return 'php';
                default:
                    return '';
            }
        } elseif ($mockPHPFunctions == 2) {
            return null;
        }
        return call_user_func_array('\ini_get', func_get_args());
    }

ini_set()

ini_set	(		$varName,
			$newValue
	)

Mock ini_set global function

Parameters

string	$varName
string	$newValue

Returns

bool|string

Definition at line 18 of file mock_ini_set.php.

{
    global $mockPHPFunctions;
    if ($mockPHPFunctions) {
        SessionManagerTest::$isIniSetInvoked = true;
        SessionManagerTest::assertSame(SessionManagerTest::SESSION_USE_ONLY_COOKIES, $varName);
        SessionManagerTest::assertSame(SessionManagerTest::SESSION_USE_ONLY_COOKIES_ENABLE, $newValue);
        return true;
    }
    return call_user_func_array('\ini_set', func_get_args());
}

session_regenerate_id()

Magento\Framework\Session\session_regenerate_id

(

$var

)

Mock session_regenerate_id to fail if false is passed

Parameters

bool

$var

Returns

bool

Definition at line 17 of file mock_session_regenerate_id.php.

{
    global $mockPHPFunctions;
    if ($mockPHPFunctions) {
        SessionManagerTest::assertTrue($var);
        return true;
    }
    return call_user_func_array('\session_regenerate_id', func_get_args());
}

session_set_save_handler()

Magento\Framework\Session\session_set_save_handler

(

)

Mock session_set_save_handler global function

Returns

bool

Definition at line 63 of file SessionManagerTest.php.

    {
        global $mockPHPFunctions;
        if ($mockPHPFunctions) {
            SessionManagerTest::$isSessionSetSaveHandlerInvoked = true;
            return true;
        }
        return call_user_func_array('\session_set_save_handler', func_get_args());
    }

session_status()

Magento\Framework\Session\session_status

(

)

Mock session_status if in test mode, or continue normal execution otherwise

Returns

int Session status code

Definition at line 23 of file SessionManagerTest.php.

    {
        global $mockPHPFunctions;
        if ($mockPHPFunctions) {
            return PHP_SESSION_NONE;
        }
        return call_user_func_array('\session_status', func_get_args());
    }