SetParam

Note: This page documents capabilities available in the older 1.x version. Please see this repository's README file for the new 2.x version documentation.

SetParam

SetParam ( string $name, string $value )

Parameters

$name and $value represent setting pairs as described below:

• cookie_file - Path to file to use for temporary session information storage. Default is system temporary file
• debug_mode - Sets cURL output to verbose if True. Default is False.
• debug_file - Sets cURL output file. Default is rets_debug.txt in local folder.
• compression_enabled - Enables GZIP compression if True. Default is False.
• force_ua_authentication - Forces UA authentication when True. Default is False.
• disable_follow_location - In case of PHP safe_mode errors, set to True. Default is False.
• force_basic_authentication - Forces HTTP Basic authentication when True for buggy IIS servers. Default is False.
• use_interealty_ua_auth - Forces use of a different calculation for UA-Auth. Default is False.
• disable_encoding_fix - Disables automatic XML encoding fix if true
• catch_last_response - Enables GetLastServerResponse(). Default is False.
• offset_support - Turns on auto-'Offset' feature. Default is False
• override_offset_protection - Disables infinite loop protection of auto-'Offset' feature if true. Default is False.

Return Value

Returns TRUE if passed parameter was valid. Returns FALSE otherwise.

Changelog

1.0rc2 - Added new parameters override_offset_protection, offset_support, catch_last_response and disable_encoding_fix
1.0 - Added new parameters debug_file, force_basic_authentication and use_interealty_ua_auth

Usage Examples

<?php
$rets->SetParam("debug_mode", true);
$rets->SetParam("debug_file", "debug_log.txt");

<?php
$rets->SetParam("compression_enabled", true);

<?php
$rets->SetParam("disable_follow_location", true);

Related To

Connect, AddHeader