PHP Conference Japan 2024

SoapServer::setPersistence

(PHP 5, PHP 7, PHP 8)

SoapServer::setPersistenceDefine o modo de persistência do SoapServer

Descrição

public SoapServer::setPersistence(int $mode): void

Esta função permite alterar o estado de persistência de um objeto SoapServer entre solicitações. Esta função permite salvar dados entre solicitações utilizando sessões PHP. Este método só tem efeito em um SoapServer após ele ter exportado funções utilizando SoapServer::setClass().

Nota:

A persistência de SOAP_PERSISTENCE_SESSION faz apenas objetos de uma determinada classe persistentes, mas não os dados estáticos da classe. Neste caso, use $this->bar em vez de self::$bar.

Nota:

SOAP_PERSISTENCE_SESSION serializa dados no objeto de classe entre solicitações. Para utilizar adequadamente os recursos (por exemplo, PDO), __wakeup() e __sleep() métodos mágicos devem ser utilizados.

Parâmetros

mode

Uma das constantes SOAP_PERSISTENCE_*.

SOAP_PERSISTENCE_REQUEST - Os dados do SoapServer não persistem entre solicitações. Este é o comportamento padrão de qualquer objeto SoapServer após setClass ser chamado.

SOAP_PERSISTENCE_SESSION - Os dados do SoapServer persistem entre as solicitações. Isso é feito serializando os dados da classe SoapServer em $_SESSION['_bogus_session_name'], por causa disso session_start() deve ser chamado antes que este modo de persistência seja definido.

Valor Retornado

Nenhum valor é retornado.

Exemplos

Exemplo #1 Exemplo de SoapServer::setPersistence()

<?php
class MyFirstPersistentSoapServer {
private
$resource; // (Such as PDO, mysqli, etc..)
public $myvar1;
public
$myvar2;

public function
__construct() {
$this->__wakeup(); // We're calling our wakeup to handle starting our resource
}

public function
__wakeup() {
$this->resource = CodeToStartOurResourceUp();
}

public function
__sleep() {
// Certificamo-nos de deixar $resource de fora aqui, para que nossos dados de sessão permaneçam persistentes
// Não fazer isso resultará em falha durante a desserialização dos dados
// na próxima solicitação; portanto, nosso SoapObject não seria persistente nas solicitações.
return array('myvar1','myvar2');
}
}

try {
session_start();
$server = new SoapServer(null, array('uri' => $_SERVER['REQUEST_URI']));
$server->setClass('MyFirstPersistentSoapServer');
// setPersistence DEVE ser chamado depois de setClass, porque o comportamento de setClass
// define SESSION_PERSISTENCE_REQUEST ao ativar o método.
$server->setPersistence(SOAP_PERSISTENCE_SESSION);
$server->handle();
} catch(
SoapFault $e) {
error_log("SOAP ERROR: ". $e->getMessage());
}
?>

Veja Também

adicione uma nota

Notas Enviadas por Usuários (em inglês) 6 notes

up
3
csnaitsirch at web dot de
14 years ago
I want to give one example for the order of commands if you want to use a class in persistence mode.

<?php
// 1. class definition or include
class UserService
{
public function
__construct() { }
}

// 2. start the session after defining or including the class!!
session_start();

// 3. instanciate the server
$server = new SoapServer(null, array("something"));

// 4. set the class to use
$server->setClass('UserService');

// 5. set persistance mode
$server->setPersistence(SOAP_PERSISTENCE_SESSION);

// 6. handle the request
$server->handle();
?>
up
2
boogiebug at gmail dot com
16 years ago
setPersistence works only for a single instance of service class.

To use multiple instance of services objects, you need to instantiate the classes into objects and use an undocumented SoapServer's method - setObject() to add the service object into the SoapServer object, and handle the service object persistence with $_SESSION instead.

For example:

$ServiceObjects = array()
$ServiceObjects[0] = new ServiceClass1();
$ServiceObjects[1] = new ServiceClass2();
$ServiceObjects[2] = new ServiceClass3();

$_SESSION['ServiceClass1'] = $ServiceObjects[0];
$_SESSION['ServiceClass2'] = $ServiceObjects[1];
$_SESSION['ServiceClass3'] = $ServiceObjects[2];

...

$Servers = array()
for ( $i = 0; $i < count($ServiceObjects); i++)
{
$s = new SoapServer($wsdl);
$s->setObject($ServiceObject[$i]);
$Servers[] = $s;
}

...

$Server[$i]->handle()

...
up
2
jan at pinna dot nl
16 years ago
I found that using both modes (SOAP_PERSISTENCE_SESSION and SOAP_PERSISTENCE_REQUEST) cannot be used simultaniously. Because it didn't work at once, I started experimenting by using different settings and as stated below in the comments, "...also use SOAP_PERSISTENCE_REQUEST to save objects between requests" led me to think it was nessecary to use both modes. Well, it might for others, be but for me it turned out a day of freaking out ;) (trying all kinds of session stuff, etc etc).
Also, if persistence doesn't work, please check if session_start() is called somewhere in the script and try not to call it twice or whatsoever: it won't work...
up
2
jared at ws-db dot com
19 years ago
I had some issues getting session persistence (SOAP_PERSISTENCE_SESSION) to work. I finally got it working after setting session.auto_start=0, and then only calling session_start() in the script containing the SoapServer. Maybe this is obvious, but took me a bit to figure it out.

I only tried it with session.use_cookies=1, so if the settings above don't work for you, make sure cookies are enabled, though it may work without the need for cookies.
up
2
cperez1000 at hotmail dot com
19 years ago
Always remember to place the "setPersistence" method before the handle method, otherwise it won't work. It sounds obvious, but it's still a very common mistake, since no errors are shown.
up
1
doug dot manley at gmail dot com
16 years ago
When using "SoapServer::setPersistence( SOAP_PERSISTENCE_SESSION )", you apparently MUST include the class that was used in "SoapServer::setClass()" BEFORE any "session_*" commands.

I found this out using "__autoload()" and a whole lot of "syslog()"; it kept failing to include the class that I was using for my soap server, but that class is ONLY ever referenced by the page itself, and even then only for the purposes of setting the class for the soap server; none of my code would ever cause it to autoload. The problem was that I was including my session-handling code first.

If the session gets started BEFORE the page defines the class definition, then persistence CANNOT happen.

The order should be:
1. Include the class for use with the soap server.
2. Start up your session.
3. Set up your soap server.
4. Handle your soap request.
To Top