adesso-mobile/php-confluence-client

This is the confluence rest resources endpoint documentation

0.1.0 2019-08-15 12:59 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^7.4
• squizlabs/php_codesniffer: ~2.6

unlicense

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

This is the confluence rest resources endpoint documentation

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 6.15.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/adesso-mobile/php-confluence-client.git"
    }
  ],
  "require": {
    "adesso-mobile/php-confluence-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/php-confluence-client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: crowdAuth
$config = ConfluenceClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ConfluenceClient\Api\ConfluenceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_id = 56; // int | The page ID to return information about the page.
$status = 'status_example'; // string | list of Content statuses to filter results on. Default value: [current]
$version = new \stdClass; // object | 
$expand = 'history,space,version'; // string | A comma separated list of properties to expand on the content. Default value: history,space,version We can also specify some extensions such as extensions.inlineProperties (for getting inline comment-specific properties) or extensions.resolution for the resolution status of each comment in the results

try {
    $result = $apiInstance->getContentById($page_id, $status, $version, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfluenceApi->getContentById: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/rest/api

Class	Method	HTTP request	Description
ConfluenceApi	getContentById	GET /content/{pageId}	Gets a confluence page content by id.
ConfluenceApi	getSpace	GET /space/{spaceKey}	Returns information about a space.

Documentation For Models

• ConfluencePageRepresentation
• ConfluencePageRepresentationExpandable
• ConfluencePageRepresentationExtensions
• ConfluencePageRepresentationHistory
• ConfluencePageRepresentationHistoryCreatedBy
• ConfluencePageRepresentationHistoryCreatedByExpandable
• ConfluencePageRepresentationHistoryCreatedByLinks
• ConfluencePageRepresentationHistoryCreatedByProfilePicture
• ConfluencePageRepresentationHistoryExpandable
• ConfluencePageRepresentationLinks
• ConfluencePageRepresentationSpace
• ConfluencePageRepresentationSpaceExpandable
• ConfluencePageRepresentationSpaceLinks
• ConfluencePageRepresentationVersion
• ConfluencePageRepresentationVersionExpandable
• ConfluenceSpaceError
• ConfluenceSpaceExists

Documentation For Authorization

crowdAuth

• Type: HTTP basic authentication

Author