Synopsis

string plexcel_get_authority(resource $px, bool $user = FALSE)

Description

The plexcel_get_authority function returns the hostname of the server with which the supplied $px resource is bound. If the $user parameter is FALSE , the hostname of the directory binding is returned. If the $user value is TRUE , the hostname of the server that is an authority for the user is returned.

For example, if plexcel_new(NULL, NULL) is used, plexcel_get_authority will return the hostname of the specific domain controller chosen by Plexcel. HTTP scripts can, and should, use this function to retrieve the directory binding and either store it in the user's session or passed to the client so that it may be used with plexcel_new in subsequent request to ensure that the same server is used. This behavior is sometimes referred to as "server stickyness". Otherwise, setting data on one server may not be visible in a subsequent request because a different authority was chosen and the data has not replicated between them.

Returns

The plexcel_get_authority function a hostname string or FALSE to indicate that an error has occurred in which case plexcel_status should be consulted.

Example

The following PHP script prints the hostname of the $px resource's domain controller.

<?php

$px = plexcel_new(NULL, NULL);
if (!$px)
    die('<pre>' . plexcel_status(NULL) . '</pre>');

$authority = plexcel_get_authority($px, FALSE); 
if ($authority === FALSE)
    die('<pre>' . plexcel_status($px) . '</pre>');

echo $authority;