Skip to content

Adding explanation for prefixing user-agents #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2015
Merged

Adding explanation for prefixing user-agents #543

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af23542
Adding explanation for prefixing user-agents
Feb 25, 2015
11ed0ad
Add example outputs
Feb 25, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/userguide/Clients.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,34 @@ To set default HTTP headers:
$client->setDefaultOption('headers/X-Custom-Header', 'FooBar');
```

## User agents

php-opencloud will send a default `User-Agent` header for every HTTP request, unless a custom value is provided by the end-user. The default header will be in this format:

> User-Agent: OpenCloud/xxx cURL/yyy PHP/zzz

where `xxx` is the current version of the SDK, `yyy` is the current version of cURL, and `zzz` is the current PHP version. To override this default, you must run:

```php
$client->setUserAgent('MyCustomUserAgent');
Copy link
Contributor

@ycombinator ycombinator Feb 25, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be helpful to show the user agent that will be sent over the wire in this case and the next (prefix) one.

Copy link
Contributor Author

@jamiehannaford jamiehannaford Feb 25, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah me too, added

```

which will result in:

> User-Agent: MyCustomUserAgent

If you want to set a _prefix_ for the user agent, but retain the default `User-Agent` as a suffix, you must run:

```php
$client->setUserAgent('MyPrefix', true);
```

which will result in:

> User-Agent: MyPrefix OpenCloud/xxx cURL/yyy PHP/zzz

where `$client` is an instance of `OpenCloud\OpenStack` or `OpenCloud\Rackspace`.

## 5. Other functionality

For a full list of functionality provided by Guzzle, please consult the [official documentation](http://docs.guzzlephp.org/en/latest/http-client/client.html).