wearearchitect/sharepoint-oauth-app-client

SharePoint OAuth App Client

SharePoint OAuth App Client

The SharePoint OAuth App Client is a PHP library that makes it easy to authenticate via OAuth2 with the SharePoint Online (2013) REST API and work with Lists, Folders, Items, Files and Users., _(*1)

This library aims for PSR-1, PSR-2 and PSR-4 standards compliance., _(*2)

Requirements

• PHP 5.4+
• Guzzle
• PHP-JWT
• Carbon

Installation

``` bash composer require "wearearchitect/sharepoint-oauth-app-client:0.9.*", <sub>(*3)</sub>

## Basic usage example
```php
<?php

require 'vendor/autoload.php';

use WeAreArchitect\SharePoint\SPException;
use WeAreArchitect\SharePoint\SPList;
use WeAreArchitect\SharePoint\SPSite;

try {
    $settings = [
        'site' => [
            'resource'  => '00000000-0000-ffff-0000-000000000000/example.sharepoint.com@09g7c3b0-f0d4-416d-39a7-09671ab91f64',
            'client_id' => '52848cad-bc13-4d69-a371-30deff17bb4d/example.com@09g7c3b0-f0d4-416d-39a7-09671ab91f64',
            'secret'    => 'YzcZQ7N4lTeK5COin/nmNRG5kkL35gAW1scrum5mXVgE=',
        ]
    ];

    // create a SharePoint Site instance
    $site = SPSite::create('https://example.sharepoint.com/sites/mySite/', $settings);

    // generate an Access Token (App-only Policy)
    $site->createSPAccessToken();

    // get all the Lists and respective Items 
    $lists = SPList::getAll($site, [
        'fetch' => true,
    ]);

    // iterate through each List
    foreach ($lists as $list) {
        var_dump($list);

        // iterate through each List Item
        foreach ($list as $item) {
            var_dump($item);
        }
    }

} catch (SPException $e) {
    // handle exceptions
}

Class documentation

• SPSite
• SPAccessToken
• SPFormDigest
• SPList
• SPItem
• SPFolder
• SPFile
• SPUser

SharePoint credentials

See how to generate the SharePoint credentials here., <sub>(*4)</sub>

Troubleshooting

Check for common library issues and how to solve them, <sub>(*5)</sub>

SharePoint Documentation

• Working with lists and list items with REST
• Working with folders and files with REST
• Files and folders REST API reference

License

The MIT License (MIT). Please see License File for more information., <sub>(*6)</sub>