initiate-project

.gitignore

@@ -0,0 +1,2 @@
+
+.idea/

README.md

@@ -0,0 +1,151 @@
+# Confluence PHP Client
+[![CI](https://github.com/CloudPlayDev/confluence-php-client/actions/workflows/ci.yml/badge.svg)](https://github.com/CloudPlayDev/confluence-php-client/actions/workflows/ci.yml) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/CloudPlayDev/confluence-php-client/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/CloudPlayDev/confluence-php-client/?branch=main)
+
+A Confluence RESTful API client in PHP
+
+An Object Oriented wrapper for Confluence
+
+## Requirements
+
+* PHP >= 7.4.0
+
+## Installation
+
+```bash
+$ composer require cloudplaydev/confluence-php-client
+```
+
+## Usage
+
+### Authentication
+
+#### Using Personal Access Tokens
+```php
+use CloudPlayDev\ConfluenceClient\ConfluenceClient;
+
+$client = new ConfluenceClient('https://url-to-conluence');
+
+//authenticate with a private access token
+//@see https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html
+$client->authenticate('NjU2OTA4NDI2MTY5OkBznOUO8YjaUF7KoOruZRXhILJ9');
+```
+#### Using BaseAuth
+```php
+$client = new ConfluenceClient('https://USERNAME:PASSWORD@url-to-conluence');
+```
+or
+```php
+use CloudPlayDev\ConfluenceClient\ConfluenceClient;
+
+$client = new ConfluenceClient('https://url-to-conluence');
+$client->authenticateBasicAuth('USERNAME', 'PASSWORD');
+```
+
+### Fetch pages, comments and attachments
+
+#### Find pages by title and space key
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+
+//Get the page we created
+$searchResults = $client->content()->find([
+    'spaceKey' => 'testSpaceKey',
+    'title' => 'Test'
+]);
+
+//first page
+$createdPage = $searchResults->getResultAt(0);
+```
+
+#### Fetch a page or comment by content id
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//Get a page or comment
+$resultContent = $client->content()->get(1234567890);
+```
+
+#### Fetch page descendants
+```php
+use CloudPlayDev\ConfluenceClient\Api\Content;
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+/* @var $page CloudPlayDev\ConfluenceClient\Entity\ContentPage */
+
+//get child content
+$childContent = $client->content()->children($page, Content::CONTENT_TYPE_PAGE); //\CloudPlayDev\ConfluenceClient\Entity\ContentSearchResult
+```
+
+### Manipulating  content
+
+#### Create new page
+```php
+use CloudPlayDev\ConfluenceClient\Entity\ContentPage;
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//Create a confluence content page
+$page = new ContentPage();
+
+//Configure your page
+$page->setSpace('testSpaceKey')
+    ->setTitle('Test')
+    ->setContent('<p>test page</p>');
+
+//Create the page in confluence in the test space
+$client->content()->create($page);
+```
+
+#### Create new comment
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//get a page by id
+$page = $client->content()->get(123456789);
+
+//attach a comment to the page
+$comment = $page->createComment('my comment text');
+
+//save the comment
+$client->content()->create($comment);
+```
+
+#### Create subpage
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//get a page by id
+$page = $client->content()->get(123456789);
+
+//attach a subpage to page
+$subPage = $page->createSubpage('subpage title', 'subpage content');
+
+//save the page
+$client->content()->create($subPage);
+```
+
+#### Update content
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//get content by id
+$page = $client->content()->get(123456789);
+
+//change content
+$page->setContent('new content')
+    ->setTitle('new title');
+
+//save the changes
+$client->content()->update($page);
+```
+
+#### Delete content
+```php
+/* @var $client CloudPlayDev\ConfluenceClient\ConfluenceClient */
+
+//get content by id
+$page = $client->content()->get(123456789);
+
+//delete content
+$client->content()->delete($page);
+```
+

composer.json

@@ -0,0 +1,44 @@
+{
+  "name": "maxlen/confluence-php-client",
+  "description": "Provides methods for Confluence REST APIs",
+  "version": "0.4.0",
+  "license": "MIT",
+  "keywords": [
+    "Atlassian",
+    "Confluence",
+    "API",
+    "Authentication",
+    "PHP",
+    "Client"
+  ],
+  "require": {
+    "php": "^7.4 || ^8.1",
+    "ext-json": "*",
+    "psr/http-message": "^1.0",
+    "psr/http-client": "^1.0",
+    "psr/http-client-implementation": "^1.0",
+    "psr/http-factory": "^1.0",
+    "php-http/httplug": "^2.0",
+    "php-http/discovery": "^1.11",
+    "php-http/promise": "^1.0",
+    "php-http/client-common": "^2.2",
+    "webmozart/assert": "^1.10",
+    "php-http/message": "^1.10"
+  },
+  "require-dev": {
+    "guzzlehttp/guzzle": "^7.2",
+    "http-interop/http-factory-guzzle": "^1.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "php-http/discovery": true
+    }
+  },
+  "autoload": {
+    "psr-4": {
+      "Maxlen\\ConfluenceClient\\": [
+        "src/"
+      ]
+    }
+  }
+}