UpdraftPlus

https://github.com/wpplugins/updraftplus
Admin
UpdraftPlus is a WordPress backup and restoration plugin that enables automatic or manual backups to...
Tokens:640,823
Snippets:4,347
Trust Score:8.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Composer

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/rackspace/php-opencloud/README.md

Install Composer to manage the php-opencloud dependency.

```bash
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Before: Using Guzzle\Service\Inspector::fromConfig

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

Shows the original client factory using Inspector::fromConfig. Replace with Collection::fromConfig as shown in the after example.

```php
use Guzzle\Service\Inspector;

class YourClient extends \Guzzle\Service\Client
{
    public static function factory($config = array())
    {
        $default = array();
        $required = array('base_url', 'username', 'api_key');
        $config = Inspector::fromConfig($config, $default, $required);

        $client = new self(
            $config->get('base_url'),
            $config->get('username'),
            $config->get('api_key')
        );
        $client->setConfig($config);

        $client->setDescription(ServiceDescription::factory(__DIR__ . DIRECTORY_SEPARATOR . 'client.json'));

        return $client;
    }
}
```

--------------------------------

### Install Guzzle Iterator via Composer

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/src/Guzzle/Iterator/README.md

Commands to install Composer and add the guzzle/iterator package as a dependency.

```bash
# Install Composer
curl -sS https://getcomposer.org/installer | php

# Add Guzzle as a dependency
php composer.phar require guzzle/iterator:~3.0
```

--------------------------------

### Convert XML Service Description to JSON (Before/After)

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

Shows the before and after of converting an XML service description to JSON. The XML uses <command> elements with method, uri, and param attributes; the JSON uses an operations map with httpMethod, uri, summary, and parameters. Note the JSON example omits the closing brace for the top-level object.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<client>
    <commands>
        <!-- Groups -->
        <command name="list_groups" method="GET" uri="groups.json">
            <doc>Get a list of groups</doc>
        </command>
        <command name="search_groups" method="GET" uri='search.json?query="{{query}} type:group"'>
            <doc>Uses a search query to get a list of groups</doc>
            <param name="query" type="string" required="true" />
        </command>
        <command name="create_group" method="POST" uri="groups.json">
            <doc>Create a group</doc>
            <param name="data" type="array" location="body" filters="json_encode" doc="Group JSON"/>
            <param name="Content-Type" location="header" static="application/json"/>
        </command>
        <command name="delete_group" method="DELETE" uri="groups/{{id}}.json">
            <doc>Delete a group by ID</doc>
            <param name="id" type="integer" required="true"/>
        </command>
        <command name="get_group" method="GET" uri="groups/{{id}}.json">
            <param name="id" type="integer" required="true"/>
        </command>
        <command name="update_group" method="PUT" uri="groups/{{id}}.json">
            <doc>Update a group</doc>
            <param name="id" type="integer" required="true"/>
            <param name="data" type="array" location="body" filters="json_encode" doc="Group JSON"/>
            <param name="Content-Type" location="header" static="application/json"/>
        </command>
    </commands>
</client>
```

```json
{
    "name":       "Zendesk REST API v2",
    "apiVersion": "2012-12-31",
    "description":"Provides access to Zendesk views, groups, tickets, ticket fields, and users",
    "operations": {
        "list_groups":  {
            "httpMethod":"GET",
            "uri":       "groups.json",
            "summary":   "Get a list of groups"
        },
        "search_groups":{
            "httpMethod":"GET",
            "uri":       "search.json?query=\"{query} type:group\"",
            "summary":   "Uses a search query to get a list of groups",
            "parameters":{
                "query":{
                    "location":   "uri",
                    "description":"Zendesk Search Query",
                    "type":       "string",
                    "required":   true
                }
            }
        },
        "create_group": {
            "httpMethod":"POST",
            "uri":       "groups.json",
            "summary":   "Create a group",
            "parameters":{
                "data":        {
                    "type":       "array",
                    "location":   "body",
                    "description":"Group JSON",
                    "filters":    "json_encode",
                    "required":   true
                },
                "Content-Type":{
                    "type":    "string",
                    "location":"header",
                    "static":  "application/json"
                }
            }
        },
        "delete_group": {
            "httpMethod":"DELETE",
            "uri":       "groups/{id}.json",
            "summary":   "Delete a group",
            "parameters":{
                "id":{
                    "location":   "uri",
                    "description":"Group to delete by ID",
                    "type":       "integer",
                    "required":   true
                }
            }
        },
        "get_group":    {
            "httpMethod":"GET",
            "uri":       "groups/{id}.json",
            "summary":   "Get a ticket",
            "parameters":{
                "id":{
                    "location":   "uri",
                    "description":"Group to get by ID",
                    "type":       "integer",
                    "required":   true
                }
            }
        },
        "update_group": {
            "httpMethod":"PUT",
            "uri":       "groups/{id}.json",
            "summary":   "Update a group",
            "parameters":{
                "id":          {
                    "location":   "uri",
                    "description":"Group to update by ID",
                    "type":       "integer",
                    "required":   true
                },
                "data":        {
                    "type":       "array",
                    "location":   "body",
                    "description":"Group JSON",
                    "filters":    "json_encode",
                    "required":   true
                },
                "Content-Type":{
                    "type":    "string",
                    "location":"header",
                    "static":  "application/json"
                }
            }
        }
}
```

--------------------------------

### ExponentialBackoffPlugin to BackoffPlugin

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

The ExponentialBackoffPlugin has been renamed to BackoffPlugin and moved to a new namespace. The before example uses the old class, and the after example uses the new factory method with HttpBackoffStrategy.

```php
use Guzzle\Http\Plugin\ExponentialBackoffPlugin;

$backoffPlugin = new ExponentialBackoffPlugin($maxRetries, array_merge(
        ExponentialBackoffPlugin::getDefaultFailureCodes(), array(429)
    ));

$client->addSubscriber($backoffPlugin);
```

```php
use Guzzle\Plugin\Backoff\BackoffPlugin;
use Guzzle\Plugin\Backoff\HttpBackoffStrategy;

// Use convenient factory method instead -- see implementation for ideas of what
// you can do with chaining backoff strategies
$backoffPlugin = BackoffPlugin::getExponentialBackoff($maxRetries, array_merge(
        HttpBackoffStrategy::getDefaultFailureCodes(), array(429)
    ));
$client->addSubscriber($backoffPlugin);
```

--------------------------------

### LogPlugin and ClosureLogAdapter namespace changes

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

The LogPlugin and ClosureLogAdapter have moved to new namespaces. The before example uses the old namespaces, and the after example uses the new ones. Note the change from $verbosity to $format and the use of MessageFormatter::DEBUG_FORMAT.

```php
use Guzzle\Common\Log\ClosureLogAdapter;
use Guzzle\Http\Plugin\LogPlugin;

/** @var \Guzzle\Http\Client */
$client;

// $verbosity is an integer indicating desired message verbosity level
$client->addSubscriber(new LogPlugin(new ClosureLogAdapter(function($m) { echo $m; }, $verbosity = LogPlugin::LOG_VERBOSE);
```

```php
use Guzzle\Log\ClosureLogAdapter;
use Guzzle\Log\MessageFormatter;
use Guzzle\Plugin\Log\LogPlugin;

/** @var \Guzzle\Http\Client */
$client;

// $format is a string indicating desired message format -- @see MessageFormatter
$client->addSubscriber(new LogPlugin(new ClosureLogAdapter(function($m) { echo $m; }, $format = MessageFormatter::DEBUG_FORMAT);
```

--------------------------------

### ServiceDescription: Commands to Operations

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

In Guzzle 3.0, the ServiceDescription class renames command-related methods to operation-related methods. The before example shows the old API, and the after example shows the new API.

```php
use Guzzle\Service\Description\ServiceDescription;

$sd = new ServiceDescription();
$sd->getCommands();     // @returns ApiCommandInterface[]
$sd->hasCommand($name);
$sd->getCommand($name); // @returns ApiCommandInterface|null
$sd->addCommand($command); // @param ApiCommandInterface $command
```

```php
use Guzzle\Service\Description\ServiceDescription;

$sd = new ServiceDescription();
$sd->getOperations();           // @returns OperationInterface[]
$sd->hasOperation($name);
$sd->getOperation($name);       // @returns OperationInterface|null
$sd->addOperation($operation);  // @param OperationInterface $operation
```

--------------------------------

### Require Composer's autoloader

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/src/Guzzle/Iterator/README.md

After installing, include Composer's autoloader to use the library.

```php
require 'vendor/autoload.php';
```

--------------------------------

### After: Using Guzzle\Common\Collection::fromConfig

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

Shows the updated client factory using Collection::fromConfig. This is the recommended replacement for Inspector::fromConfig.

```php
use Guzzle\Common\Collection;

class YourClient extends \Guzzle\Service\Client
{
    public static function factory($config = array())
    {
        $default = array();
        $required = array('base_url', 'username', 'api_key');
        $config = Collection::fromConfig($config, $default, $required);

        $client = new self(
            $config->get('base_url'),
            $config->get('username'),
            $config->get('api_key')
        );
        $client->setConfig($config);

        $client->setDescription(ServiceDescription::factory(__DIR__ . DIRECTORY_SEPARATOR . 'client.json'));

        return $client;
    }
}
```

--------------------------------

### Run unit tests with phpunit

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/rackspace/php-opencloud/CONTRIBUTING.md

Run the unit tests for the php-opencloud library. Execute from the project's base directory.

```bash
vendor/bin/phpunit
```

--------------------------------

### Run acceptance tests with Runner.php

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/rackspace/php-opencloud/CONTRIBUTING.md

Run the full suite of acceptance tests. Requires setting the PHP_OpenCloud_USERNAME and PHP_OpenCloud_API_KEY environment variables and having variables-order set to "EGCRS".

```bash
php tests/OpenCloud/Smoke/Runner.php
```

--------------------------------

### Using LoggerInterface in a class

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/psr/log/README.md

Shows how to use the Psr\Log\LoggerInterface in a class constructor and call the info method. The logger is optional and checked before use.

```php
<?php

use Psr\Log\LoggerInterface;

class Foo
{
    private $logger;

    public function __construct(LoggerInterface $logger = null)
    {
        $this->logger = $logger;
    }

    public function doSomething()
    {
        if ($this->logger) {
            $this->logger->info('Doing work');
        }

        // do something useful
    }
}
```

--------------------------------

### Require php-opencloud as a dependency

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/rackspace/php-opencloud/README.md

Adds php-opencloud as a Composer dependency.

```bash
# Require php-opencloud as a dependency
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Enable E_USER_DEPRECATED warnings in Guzzle 3.7

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/guzzle/guzzle/UPGRADING.md

Set \.Guzzle\Common\Version::$emitWarnings to true to enable E_USER_DEPRECATED warnings and see if you are using any deprecated methods.

```php
\Guzzle\Common\Version::$emitWarnings = true;
```

--------------------------------

### Fix code style with php-cs-fixer

Source: https://github.com/wpplugins/updraftplus/blob/master/vendor/rackspace/php-opencloud/CONTRIBUTING.md

Automatically fix code style to comply with PSR-2. Run from the base directory before submitting a contribution. This command modifies your code, so commit the changes afterward.

```bash
$ vendor/bin/php-cs-fixer fix --level psr2 .
```
Tokens:
Raw