概要
SharePoint上で管理されているファイルをPHPでダウンロードする処理を作る際に
日本語の情報が少なかったので、手順を纏めました。
※SharePointにてサイトは作成されていることを想定した手順となります。
クライアントの登録
システムからファイル情報、及びファイルの取得を行う際はREST-APIを使用します。
REST-APIを使用する際にトークンが必要となるため、トークン発行を行うためのクライアントの登録を行います。
基本的には下記の記事を参考にさせて頂きました。
クライアントIDを生成
- 下記へ接続
https://[テナント名].sharepoint.com/sites/[サイト名]/_layouts/15/AppRegNew.aspx
※サイトへアクセスできない場合
- 下記のテーブルに従って値を入力
- 「作成」を押下
| 項目 | 値 |
|---|---|
| クライアントID | 生成ボタン押下 |
| クライアント シークレート | 生成ボタン押下 |
| タイトル | 任意 |
| アプリドメイン | ※ローカル環境の場合は「localhost:80」など |
| リダイレクト先 | 存在しないURIでも可 例：「 https://localhost:80/hoge.php 」など |
クライアントスコープ範囲の登録
- 下記へ接続
https://[テナント名].sharepoint.com/sites/[サイト名]/_layouts/15/AppInv.aspx
※サイトへアクセスできない場合
- 作成したクライアントIDを「アプリID」へ入力し「参照」を押下
- 「権限の要求XML」へ下記を入力
<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/sitecollection/tenant" Right="FullControl"/>
</AppPermissionRequests>
※作成したクライアントに対する操作範囲を設定します。
その他の設定値は以下で確認できます。
4.「作成」を押下
サイトの操作権限が無いためサイトへアクセスできない場合
サイトの操作権限が無いためサイトへアクセスできない状態となります。
アクセスするには権限を持つアカウントへ切り替えるか、権限を持つユーザが以下の対応を行ってください。
- 下記へ接続
https://[テナント名]-admin.sharepoint.com/
※サイトへアクセスできるアカウントが無い場合 - 「サイト」<「アクティブなサイト」を選択
- 一覧から該当するサイトを選択
- 一覧ヘッダーにある「権限」<「その他の管理者の管理」を選択
- 管理者の追加へアクセスできないアカウントを追加
SharePointの操作権限が無い場合
サイト権限が付与できない場合はSharePointの管理者権限が与えられていないためとなります。
アクセスするには権限を持つユーザが下記の対応を行ってください。
- 下記へ接続
https://admin.microsoft.com/AdminPortal/Home?#/users - 該当ユーザを選択
- 「アカウント」< 「役割の管理」を選択
- 「管理センターに対するアクセス許可」にチェックを入れる
- 「SharePoint管理者」にチェックを入れる
- 「保存」を押下
PHPでファイルの取得処理を作成
PHPのcurl関数を使うことで、ファイルやフォルダの一覧をjson形式で取得することはできましたが
何故かファイルダウンロードのときだけ「403エラー」が出続けたため、代わりに「phpSPO」という
Office365用のPHPライブラリを使用することにしました。
※このライブラリも一部の動作に関しては正常に動作しないようですが、今回は関係ありませんでした。
phpSPOをインストール
※導入方法や簡単な記述はREADMEを参照
PHPサンプル
下記コードをコピーして、必要な項目を変更することで取得が可能となります。
ファイル・フォルダの取得
<?php
require('vendor/autoload.php');
use Office365\SharePoint\ClientContext;
use Office365\Runtime\Auth\ClientCredential;
$credentials = new ClientCredential("クライアントID", "クライアントシークレット");
$client = (new ClientContext("https://teikokushoin.sharepoint.com/sites/masterdata"))->withCredentials($credentials);
$targetFolderPath = "SharePointの格納先パス";
$saveFolder = "保存先";
//指定フォルダ内のファイルを取得
$data = $client->getWeb()->getFolderByServerRelativeUrl($targetFolderPath)->getFiles();
//指定フォルダ内のフォルダを取得
//$data = $client->getWeb()->getFolderByServerRelativeUrl($targetFolderPath)->getFolders();
$client->load($data);
$client->executeQuery();
echo('<pre>');
var_dump($data);
echo('</pre>');
?>
ダウンロード
<?php
require('vendor/autoload.php');
use Office365\SharePoint\ClientContext;
use Office365\Runtime\Auth\ClientCredential;
$credentials = new ClientCredential("クライアントID", "クライアントシークレット");
$client = (new ClientContext("https://teikokushoin.sharepoint.com/sites/masterdata"))->withCredentials($credentials);
$saveFolder = 保存先のパスとファイル名;
$targetFilePath = 保存対象のフルパスとファイル名;
$fileContent = Office365\SharePoint\File::openBinary($client, $targetFilePath);
file_put_contents($saveFolder, $fileContent);
?>
以上