ldap_set_option(3) [php man page]

LDAP_SET_OPTION(3)							 1							LDAP_SET_OPTION(3)

ldap_set_option - Set the value of the given option

SYNOPSIS

       bool ldap_set_option (resource  $link_identifier, int  $option, mixed  $newval)

DESCRIPTION

	Sets the value of the specified option to be $newval.

PARAMETERS

	      o $link_identifier
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $option
		- The parameter $option can be one of:

	      LDAP_OPT_SERVER_CONTROLS and LDAP_OPT_CLIENT_CONTROLS require a list of controls, this means that the value must be an array of con-
	      trols. A control consists of an oid identifying the control, an optional value, and an optional flag for criticality. In PHP a  con-
	      trol  is given by an array containing an element with the key oid and string value, and two optional elements. The optional elements
	      are key value with string value and key iscritical with boolean value.  iscritical defaults to FALSE if  not  supplied.  See  draft-
	      ietf-ldapext-ldap-c-api-xx.txt for details. See also the second example below.

	      o $newval
		- The new value for the specified $option.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      Set protocol version

	      <?php
	      // $ds is a valid link identifier for a directory server
	      if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
		  echo "Using LDAPv3";
	      } else {
		  echo "Failed to set protocol version to 3";
	      }
	      ?>

       Example #2

	      Set server controls

	      <?php
	      // $ds is a valid link identifier for a directory server
	      // control with no value
	      $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
	      // iscritical defaults to FALSE
	      $ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
	      // try to set both controls
	      if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
		  echo "Failed to set server controls";
	      }
	      ?>

NOTES

       Note

	       This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.

SEE ALSO

       ldap_get_option(3).

PHP Documentation Group 													LDAP_SET_OPTION(3)

LDAP_GET_OPTION(3)							 1							LDAP_GET_OPTION(3)

ldap_get_option - Get the current value for given option

SYNOPSIS

       bool ldap_get_option (resource  $link_identifier, int  $option, mixed  &$retval)

DESCRIPTION

	Sets $retval to the value of the specified option.

PARAMETERS

	      o $link_identifier
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $option
		- The parameter $option can be one of:

	      +--------------------------+---------+
	      | 	Option		 |	   |
	      | 			 |	   |
	      | 			 |  Type   |
	      | 			 |	   |
	      +--------------------------+---------+
	      | 			 |	   |
	      |     LDAP_OPT_DEREF	 |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |   LDAP_OPT_SIZELIMIT	 |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |   LDAP_OPT_TIMELIMIT	 |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |LDAP_OPT_NETWORK_TIMEOUT  |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |LDAP_OPT_PROTOCOL_VERSION |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |  LDAP_OPT_ERROR_NUMBER	 |	   |
	      | 			 |	   |
	      | 			 | integer |
	      | 			 |	   |
	      | 			 |	   |
	      |   LDAP_OPT_REFERRALS	 |	   |
	      | 			 |	   |
	      | 			 |  bool   |
	      | 			 |	   |
	      | 			 |	   |
	      |    LDAP_OPT_RESTART	 |	   |
	      | 			 |	   |
	      | 			 |  bool   |
	      | 			 |	   |
	      | 			 |	   |
	      |   LDAP_OPT_HOST_NAME	 |	   |
	      | 			 |	   |
	      | 			 | string  |
	      | 			 |	   |
	      | 			 |	   |
	      |  LDAP_OPT_ERROR_STRING	 |	   |
	      | 			 |	   |
	      | 			 | string  |
	      | 			 |	   |
	      | 			 |	   |
	      |   LDAP_OPT_MATCHED_DN	 |	   |
	      | 			 |	   |
	      | 			 | string  |
	      | 			 |	   |
	      | 			 |	   |
	      |LDAP_OPT_SERVER_CONTROLS  |	   |
	      | 			 |	   |
	      | 			 |  array  |
	      | 			 |	   |
	      | 			 |	   |
	      |LDAP_OPT_CLIENT_CONTROLS  |	   |
	      | 			 |	   |
	      | 			 |  array  |
	      | 			 |	   |
	      +--------------------------+---------+
	      o $retval
		- This will be set to the option value.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      Check protocol version

	      <?php
	      // $ds is a valid link identifier for a directory server
	      if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
		  echo "Using protocol version $version
";
	      } else {
		  echo "Unable to determine protocol version
";
	      }
	      ?>

NOTES

       Note

	       This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.

SEE ALSO

       ldap_set_option(3).

PHP Documentation Group 													LDAP_GET_OPTION(3)