";
-
-echo pageFooter(__FILE__);
diff --git a/examples/batch.php b/examples/batch.php
index 3c8812f51..5d546562b 100644
--- a/examples/batch.php
+++ b/examples/batch.php
@@ -14,7 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
+
echo pageHeader("Batching Queries");
/************************************************
@@ -22,7 +25,6 @@
books API again as an example, but this time we
will batch up two queries into a single call.
************************************************/
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
/************************************************
We create the client and set the simple API
@@ -32,51 +34,50 @@
************************************************/
$client = new Google_Client();
$client->setApplicationName("Client_Library_Examples");
-$apiKey = ""; // Change to your API key.
-// Warn if the API key isn't changed!
-if (strpos($apiKey, "<") !== false) {
+
+// Warn if the API key isn't set.
+if (!$apiKey = getApiKey()) {
echo missingApiKeyWarning();
exit;
-} else {
- $client->setDeveloperKey($apiKey);
+}
+$client->setDeveloperKey($apiKey);
- $service = new Google_Service_Books($client);
+$service = new Google_Service_Books($client);
- /************************************************
- To actually make the batch call we need to
- enable batching on the client - this will apply
- globally until we set it to false. This causes
- call to the service methods to return the query
- rather than immediately executing.
- ************************************************/
- $client->setUseBatch(true);
+/************************************************
+ To actually make the batch call we need to
+ enable batching on the client - this will apply
+ globally until we set it to false. This causes
+ call to the service methods to return the query
+ rather than immediately executing.
+ ************************************************/
+$client->setUseBatch(true);
- /************************************************
- We then create a batch, and add each query we
- want to execute with keys of our choice - these
- keys will be reflected in the returned array.
- ************************************************/
- $batch = new Google_Http_Batch($client);
- $optParams = array('filter' => 'free-ebooks');
- $req1 = $service->volumes->listVolumes('Henry David Thoreau', $optParams);
- $batch->add($req1, "thoreau");
- $req2 = $service->volumes->listVolumes('George Bernard Shaw', $optParams);
- $batch->add($req2, "shaw");
+/************************************************
+ We then create a batch, and add each query we
+ want to execute with keys of our choice - these
+ keys will be reflected in the returned array.
+************************************************/
+$batch = new Google_Http_Batch($client);
+$optParams = array('filter' => 'free-ebooks');
+$req1 = $service->volumes->listVolumes('Henry David Thoreau', $optParams);
+$batch->add($req1, "thoreau");
+$req2 = $service->volumes->listVolumes('George Bernard Shaw', $optParams);
+$batch->add($req2, "shaw");
- /************************************************
- Executing the batch will send all requests off
- at once.
- ************************************************/
- $results = $batch->execute();
+/************************************************
+ Executing the batch will send all requests off
+ at once.
+ ************************************************/
+$results = $batch->execute();
- echo "
";
+foreach ($results['response-shaw'] as $item) {
+ echo $item['volumeInfo']['title'], " \n";
}
echo pageFooter(__FILE__);
diff --git a/examples/idtoken.php b/examples/idtoken.php
index 80aefa621..465c64f22 100644
--- a/examples/idtoken.php
+++ b/examples/idtoken.php
@@ -14,45 +14,57 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
-session_start();
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+echo pageHeader("Retrieving An Id Token");
+
+/*************************************************
+ * Ensure you've downloaded your oauth credentials
+ ************************************************/
+if (!$oauth_credentials = getOAuthCredentialsFile()) {
+ echo missingOAuth2CredentialsWarning();
+ exit;
+}
/************************************************
- ATTENTION: Fill in these values! Make sure
- the redirect URI is to this page, e.g:
- http://localhost:8080/user-example.php
+ * NOTICE:
+ * The redirect URI is to the current page, e.g:
+ * http://localhost:8080/idtoken.php
************************************************/
-$client_id = '';
-$client_secret = '';
-$redirect_uri = '';
+$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
$client = new Google_Client();
-$client->setClientId($client_id);
-$client->setClientSecret($client_secret);
+$client->setAuthConfig($oauth_credentials);
$client->setRedirectUri($redirect_uri);
$client->setScopes('email');
/************************************************
- If we're logging out we just need to clear our
- local access token in this case
+ * If we're logging out we just need to clear our
+ * local access token in this case
************************************************/
if (isset($_REQUEST['logout'])) {
- unset($_SESSION['access_token']);
+ unset($_SESSION['id_token']);
}
+
/************************************************
- If we have a code back from the OAuth 2.0 flow,
- we need to exchange that with the authenticate()
- function. We store the resultant access token
- bundle in the session, and redirect to ourself.
+ * If we have a code back from the OAuth 2.0 flow,
+ * we need to exchange that with the
+ * Google_Client::fetchAccessTokenWithAuthCode()
+ * function. We store the resultant access token
+ * bundle in the session, and redirect to ourself.
************************************************/
if (isset($_GET['code'])) {
- $client->authenticate($_GET['code']);
- $_SESSION['access_token'] = $client->getAccessToken();
- $redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
- header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
+ $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
+ $client->setAccessToken($token);
+
+ // store in the session also
+ $_SESSION['id_token'] = $token;
+
+ // redirect back to the example
+ header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}
/************************************************
@@ -60,11 +72,10 @@ function. We store the resultant access token
requests, else we generate an authentication URL.
************************************************/
if (
- isset($_SESSION['access_token'])
- && $_SESSION['access_token']
- && false !== strpos($_SESSION['access_token'], 'id_token')
+ !empty($_SESSION['id_token'])
+ && isset($_SESSION['id_token']['id_token'])
) {
- $client->setAccessToken($_SESSION['access_token']);
+ $client->setAccessToken($_SESSION['id_token']);
} else {
$authUrl = $client->createAuthUrl();
}
@@ -78,34 +89,21 @@ function. We store the resultant access token
and that can be cached.
************************************************/
if ($client->getAccessToken()) {
- $_SESSION['access_token'] = $client->getAccessToken();
$token_data = $client->verifyIdToken();
}
-
-echo pageHeader("User Query - Retrieving An Id Token");
-if (strpos($client_id, "googleusercontent") == false) {
- echo missingClientSecretsWarning();
- exit;
-}
?>
+
-
diff --git a/examples/fileupload.php b/examples/large-file-upload.php
similarity index 60%
rename from examples/fileupload.php
rename to examples/large-file-upload.php
index 2247087e9..641308a68 100644
--- a/examples/fileupload.php
+++ b/examples/large-file-upload.php
@@ -14,50 +14,57 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
-session_start();
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+echo pageHeader("File Upload - Uploading a large file");
-/************************************************
- We'll setup an empty 20MB file to upload.
+/*************************************************
+ * Ensure you've downloaded your oauth credentials
************************************************/
-DEFINE("TESTFILE", 'testfile.txt');
-if (!file_exists(TESTFILE)) {
- $fh = fopen(TESTFILE, 'w');
- fseek($fh, 1024*1024*20);
- fwrite($fh, "!", 1);
- fclose($fh);
+if (!$oauth_credentials = getOAuthCredentialsFile()) {
+ echo missingOAuth2CredentialsWarning();
+ exit;
}
/************************************************
- ATTENTION: Fill in these values! Make sure
- the redirect URI is to this page, e.g:
- http://localhost:8080/fileupload.php
+ * The redirect URI is to the current page, e.g:
+ * http://localhost:8080/large-file-upload.php
************************************************/
-$client_id = '';
-$client_secret = '';
-$redirect_uri = '';
+$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
$client = new Google_Client();
-$client->setClientId($client_id);
-$client->setClientSecret($client_secret);
+$client->setAuthConfig($oauth_credentials);
$client->setRedirectUri($redirect_uri);
$client->addScope("https://www.googleapis.com/auth/drive");
$service = new Google_Service_Drive($client);
+// add "?logout" to the URL to remove a token from the session
if (isset($_REQUEST['logout'])) {
unset($_SESSION['upload_token']);
}
+/************************************************
+ * If we have a code back from the OAuth 2.0 flow,
+ * we need to exchange that with the
+ * Google_Client::fetchAccessTokenWithAuthCode()
+ * function. We store the resultant access token
+ * bundle in the session, and redirect to ourself.
+ ************************************************/
if (isset($_GET['code'])) {
- $client->authenticate($_GET['code']);
- $_SESSION['upload_token'] = $client->getAccessToken();
- $redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
- header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
+ $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
+ $client->setAccessToken($token);
+
+ // store in the session also
+ $_SESSION['upload_token'] = $token;
+
+ // redirect back to the example
+ header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}
-if (isset($_SESSION['upload_token']) && $_SESSION['upload_token']) {
+// set the access token as part of the client
+if (!empty($_SESSION['upload_token'])) {
$client->setAccessToken($_SESSION['upload_token']);
if ($client->isAccessTokenExpired()) {
unset($_SESSION['upload_token']);
@@ -67,10 +74,21 @@
}
/************************************************
- If we're signed in then lets try to upload our
- file.
+ * If we're signed in then lets try to upload our
+ * file.
************************************************/
-if ($client->getAccessToken()) {
+if ($_SERVER['REQUEST_METHOD'] == 'POST' && $client->getAccessToken()) {
+ /************************************************
+ * We'll setup an empty 20MB file to upload.
+ ************************************************/
+ DEFINE("TESTFILE", 'testfile.txt');
+ if (!file_exists(TESTFILE)) {
+ $fh = fopen(TESTFILE, 'w');
+ fseek($fh, 1024*1024*20);
+ fwrite($fh, "!", 1);
+ fclose($fh);
+ }
+
$file = new Google_Service_Drive_DriveFile();
$file->title = "Big File";
$chunkSizeBytes = 1 * 1024 * 1024;
@@ -111,11 +129,7 @@
fclose($handle);
}
-echo pageHeader("File Upload - Uploading a large file");
-if (strpos($client_id, "googleusercontent") == false) {
- echo missingClientSecretsWarning();
- exit;
-}
+
function readVideoChunk ($handle, $chunkSize)
{
$byteCount = 0;
@@ -133,22 +147,22 @@ function readVideoChunk ($handle, $chunkSize)
return $giantChunk;
}
?>
+
-
diff --git a/examples/multi-api.php b/examples/multi-api.php
index e518b5da7..c6f9193e9 100644
--- a/examples/multi-api.php
+++ b/examples/multi-api.php
@@ -14,62 +14,75 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
-session_start();
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+echo pageHeader("User Query - Multiple APIs");
-/************************************************
- ATTENTION: Fill in these values! Make sure
- the redirect URI is to this page, e.g:
- http://localhost:8080/user-example.php
+
+/*************************************************
+ * Ensure you've downloaded your oauth credentials
************************************************/
- $client_id = '';
- $client_secret = '';
- $redirect_uri = '';
+if (!$oauth_credentials = getOAuthCredentialsFile()) {
+ echo missingOAuth2CredentialsWarning();
+ exit;
+}
/************************************************
- Make an API request on behalf of a user. In
- this case we need to have a valid OAuth 2.0
- token for the user, so we need to send them
- through a login flow. To do this we need some
- information from our API console project.
+ * The redirect URI is to the current page, e.g:
+ * http://localhost:8080/multi-api.php
************************************************/
+$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
+
$client = new Google_Client();
-$client->setClientId($client_id);
-$client->setClientSecret($client_secret);
+$client->setAuthConfig($oauth_credentials);
$client->setRedirectUri($redirect_uri);
$client->addScope("https://www.googleapis.com/auth/drive");
$client->addScope("https://www.googleapis.com/auth/youtube");
-/************************************************
- We are going to create both YouTube and Drive
- services, and query both.
- ************************************************/
-$yt_service = new Google_Service_YouTube($client);
-$dr_service = new Google_Service_Drive($client);
+$service = new Google_Service_Drive($client);
+// add "?logout" to the URL to remove a token from the session
+if (isset($_REQUEST['logout'])) {
+ unset($_SESSION['multi-api-token']);
+}
/************************************************
- Boilerplate auth management - see
- user-example.php for details.
+ * If we have a code back from the OAuth 2.0 flow,
+ * we need to exchange that with the
+ * Google_Client::fetchAccessTokenWithAuthCode()
+ * function. We store the resultant access token
+ * bundle in the session, and redirect to ourself.
************************************************/
-if (isset($_REQUEST['logout'])) {
- unset($_SESSION['access_token']);
-}
if (isset($_GET['code'])) {
- $client->authenticate($_GET['code']);
- $_SESSION['access_token'] = $client->getAccessToken();
- $redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
- header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
+ $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
+ $client->setAccessToken($token);
+
+ // store in the session also
+ $_SESSION['multi-api-token'] = $token;
+
+ // redirect back to the example
+ header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}
-if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
- $client->setAccessToken($_SESSION['access_token']);
+// set the access token as part of the client
+if (!empty($_SESSION['multi-api-token'])) {
+ $client->setAccessToken($_SESSION['multi-api-token']);
+ if ($client->isAccessTokenExpired()) {
+ unset($_SESSION['multi-api-token']);
+ }
} else {
$authUrl = $client->createAuthUrl();
}
+/************************************************
+ We are going to create both YouTube and Drive
+ services, and query both.
+ ************************************************/
+$yt_service = new Google_Service_YouTube($client);
+$dr_service = new Google_Service_Drive($client);
+
/************************************************
If we're signed in, retrieve channels from YouTube
and a list of files from Drive.
@@ -86,29 +99,24 @@
array("playlistId" => $likePlaylist)
);
}
-
-echo pageHeader("User Query - Multiple APIs");
-if (strpos($client_id, "googleusercontent") == false) {
- echo missingClientSecretsWarning();
- exit;
-}
?>
+
-
diff --git a/examples/service-account.php b/examples/service-account.php
index 594f822f3..bee5df7b3 100644
--- a/examples/service-account.php
+++ b/examples/service-account.php
@@ -14,18 +14,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-session_start();
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
+echo pageHeader("Service Account Access");
+
/************************************************
Make an API request authenticated with a service
account.
************************************************/
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+
+$client = new Google_Client();
/************************************************
- ATTENTION: Fill in these values! You can get
- them by creating a new Service Account in the
+ ATTENTION: Fill in these values, or make sure you
+ have set the GOOGLE_APPLICATION_CREDENTIALS
+ environment variable. You can get these credentials
+ by creating a new Service Account in the
API console. Be sure to store the key file
somewhere you can get to it - though in real
operations you'd want to make sure it wasn't
@@ -33,36 +39,22 @@
Make sure the Books API is enabled on this
account as well, or the call will fail.
************************************************/
-$key_file_location = ''; //.json credentials
-echo pageHeader("Service Account Access");
-if (!strlen($key_file_location)) {
+if ($credentials_file = checkServiceAccountCredentialsFile()) {
+ // set the location manually
+ $client->setAuthConfig($credentials_file);
+} elseif (getenv('GOOGLE_APPLICATION_CREDENTIALS')) {
+ // use the application default credentials
+ $client->useApplicationDefaultCredentials();
+} else {
echo missingServiceAccountDetailsWarning();
exit;
}
-$client = new Google_Client();
$client->setApplicationName("Client_Library_Examples");
$client->setScopes(['https://www.googleapis.com/auth/books']);
$service = new Google_Service_Books($client);
-/************************************************
- If we have an access token, we can carry on.
- Otherwise, we'll get one with the help of an
- assertion credential. In other examples the list
- of scopes was managed by the Client, but here
- we have to list them manually. We also supply
- the service account
- ************************************************/
-if (isset($_SESSION['service_token'])) {
- $client->setAccessToken($_SESSION['service_token']);
-}
-$client->setAuthConfigFile($key_file_location);
-if ($client->getAuth()->isAccessTokenExpired()) {
- $client->getAuth()->refreshTokenWithAssertion();
-}
-$_SESSION['service_token'] = $client->getAccessToken();
-
/************************************************
We're just going to make the same call as in the
simple query as an example.
diff --git a/examples/simple-file-upload.php b/examples/simple-file-upload.php
new file mode 100644
index 000000000..60fbf3a3d
--- /dev/null
+++ b/examples/simple-file-upload.php
@@ -0,0 +1,135 @@
+setAuthConfig($oauth_credentials);
+$client->setRedirectUri($redirect_uri);
+$client->addScope("https://www.googleapis.com/auth/drive");
+$service = new Google_Service_Drive($client);
+
+// add "?logout" to the URL to remove a token from the session
+if (isset($_REQUEST['logout'])) {
+ unset($_SESSION['upload_token']);
+}
+
+/************************************************
+ * If we have a code back from the OAuth 2.0 flow,
+ * we need to exchange that with the
+ * Google_Client::fetchAccessTokenWithAuthCode()
+ * function. We store the resultant access token
+ * bundle in the session, and redirect to ourself.
+ ************************************************/
+if (isset($_GET['code'])) {
+ $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
+ $client->setAccessToken($token);
+
+ // store in the session also
+ $_SESSION['upload_token'] = $token;
+
+ // redirect back to the example
+ header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
+}
+
+// set the access token as part of the client
+if (!empty($_SESSION['upload_token'])) {
+ $client->setAccessToken($_SESSION['upload_token']);
+ if ($client->isAccessTokenExpired()) {
+ unset($_SESSION['upload_token']);
+ }
+} else {
+ $authUrl = $client->createAuthUrl();
+}
+
+/************************************************
+ * If we're signed in then lets try to upload our
+ * file. For larger files, see fileupload.php.
+ ************************************************/
+if ($_SERVER['REQUEST_METHOD'] == 'POST' && $client->getAccessToken()) {
+ // We'll setup an empty 1MB file to upload.
+ DEFINE("TESTFILE", 'testfile-small.txt');
+ if (!file_exists(TESTFILE)) {
+ $fh = fopen(TESTFILE, 'w');
+ fseek($fh, 1024 * 1024);
+ fwrite($fh, "!", 1);
+ fclose($fh);
+ }
+
+ // This is uploading a file directly, with no metadata associated.
+ $file = new Google_Service_Drive_DriveFile();
+ $result = $service->files->insert(
+ $file,
+ array(
+ 'data' => file_get_contents(TESTFILE),
+ 'mimeType' => 'application/octet-stream',
+ 'uploadType' => 'media'
+ )
+ );
+
+ // Now lets try and send the metadata as well using multipart!
+ $file = new Google_Service_Drive_DriveFile();
+ $file->setTitle("Hello World!");
+ $result2 = $service->files->insert(
+ $file,
+ array(
+ 'data' => file_get_contents(TESTFILE),
+ 'mimeType' => 'application/octet-stream',
+ 'uploadType' => 'multipart'
+ )
+ );
+}
+?>
+
+
+
+
diff --git a/examples/simple-query.php b/examples/simple-query.php
index c0f1149cf..e02c34cf7 100644
--- a/examples/simple-query.php
+++ b/examples/simple-query.php
@@ -14,18 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
-echo pageHeader("Simple API Access");
-/************************************************
- Make a simple API request using a key. In this
- example we're not making a request as a
- specific user, but simply indicating that the
- request comes from our application, and hence
- should use our quota, which is higher than the
- anonymous quota (which is limited per IP).
- ************************************************/
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+echo pageHeader("Simple API Access");
/************************************************
We create the client and set the simple API
@@ -35,9 +28,9 @@
************************************************/
$client = new Google_Client();
$client->setApplicationName("Client_Library_Examples");
-$apiKey = ""; // Change this line.
-// Warn if the API key isn't changed.
-if (strpos($apiKey, "<") !== false) {
+
+// Warn if the API key isn't set.
+if (!$apiKey = getApiKey()) {
echo missingApiKeyWarning();
exit;
}
diff --git a/examples/simplefileupload.php b/examples/simplefileupload.php
deleted file mode 100644
index 452599878..000000000
--- a/examples/simplefileupload.php
+++ /dev/null
@@ -1,123 +0,0 @@
-';
-$client_secret = '';
-$redirect_uri = '';
-
-$client = new Google_Client();
-$client->setClientId($client_id);
-$client->setClientSecret($client_secret);
-$client->setRedirectUri($redirect_uri);
-$client->addScope("https://www.googleapis.com/auth/drive");
-$service = new Google_Service_Drive($client);
-
-if (isset($_REQUEST['logout'])) {
- unset($_SESSION['upload_token']);
-}
-
-if (isset($_GET['code'])) {
- $client->authenticate($_GET['code']);
- $_SESSION['upload_token'] = $client->getAccessToken();
- $redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
- header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
-}
-
-if (isset($_SESSION['upload_token']) && $_SESSION['upload_token']) {
- $client->setAccessToken($_SESSION['upload_token']);
- if ($client->isAccessTokenExpired()) {
- unset($_SESSION['upload_token']);
- }
-} else {
- $authUrl = $client->createAuthUrl();
-}
-
-/************************************************
- If we're signed in then lets try to upload our
- file. For larger files, see fileupload.php.
- ************************************************/
-if ($client->getAccessToken()) {
- // This is uploading a file directly, with no metadata associated.
- $file = new Google_Service_Drive_DriveFile();
- $result = $service->files->insert(
- $file,
- array(
- 'data' => file_get_contents(TESTFILE),
- 'mimeType' => 'application/octet-stream',
- 'uploadType' => 'media'
- )
- );
-
- // Now lets try and send the metadata as well using multipart!
- $file = new Google_Service_Drive_DriveFile();
- $file->setTitle("Hello World!");
- $result2 = $service->files->insert(
- $file,
- array(
- 'data' => file_get_contents(TESTFILE),
- 'mimeType' => 'application/octet-stream',
- 'uploadType' => 'multipart'
- )
- );
-}
-
-echo pageHeader("File Upload - Uploading a small file");
-if (strpos($client_id, "googleusercontent") == false) {
- echo missingClientSecretsWarning();
- exit;
-}
-?>
-
- Warning: You need to set a Simple API Access key from the
- Google API console
-
";
- } else {
- $ret = "Warning: You need to set a Simple API Access key from the Google API console:";
- $ret .= "\nhttp://developers.google.com/console\n";
- }
+ $ret = "
+
+ Warning: You need to set a Simple API Access key from the
+ Google API console
+
- Warning: You need to set Client ID, Client Secret and Redirect URI from the
- Google API console
-
";
- } else {
- $ret = "Warning: You need to set Client ID, Client Secret and Redirect URI from the";
- $ret .= " Google API console:\nhttp://developers.google.com/console\n";
- }
+ $ret = "
+
+ Warning: You need to set Client ID, Client Secret and Redirect URI from the
+ Google API console
+
- Warning: You need to set the location of your Service Account JSON Credentials from the
- Google API console
-
";
- } else {
- $ret = "Warning: You need to set the location of Service Account JSON Credentials from the";
- $ret .= " Google API console:\nhttp://developers.google.com/console\n";
- }
+ $ret = "
+
+ Warning: You need download your Service Account Credentials JSON from the
+ Google API console.
+
+
+ Once downloaded, move them into the root directory of this repository and
+ rename them 'service-account-credentials.json'.
+
+
+ In your application, you should set the GOOGLE_APPLICATION_CREDENTIALS environment variable
+ as the path to this file, but in the context of this example we will do this for you.
+
+ Warning: You need to set the location of your OAuth2 Client Credentials from the
+ Google API console.
+
+
+ Once downloaded, move them into the root directory of this repository and
+ rename them 'oauth-credentials.json'.
+
";
+
return $ret;
}
+
+function checkServiceAccountCredentialsFile()
+{
+ // service account creds
+ $application_creds = __DIR__ . '/../../service-account-credentials.json';
+
+ return file_exists($application_creds) ? $application_creds : false;
+}
+
+function getOAuthCredentialsFile()
+{
+ // oauth2 creds
+ $oauth_creds = __DIR__ . '/../../oauth-credentials.json';
+
+ if (file_exists($oauth_creds)) {
+ return $oauth_creds;
+ }
+
+ return false;
+}
+
+function setClientCredentialsFile($apiKey)
+{
+ $file = __DIR__ . '/../../tests/.apiKey';
+ file_put_contents($file, $apiKey);
+}
+
+
+function getApiKey()
+{
+ $file = __DIR__ . '/../../tests/.apiKey';
+ if (file_exists($file)) {
+ return file_get_contents($file);
+ }
+}
+
+function setApiKey($apiKey)
+{
+ $file = __DIR__ . '/../../tests/.apiKey';
+ file_put_contents($file, $apiKey);
+}
diff --git a/examples/user-example.php b/examples/url-shortener.php
similarity index 60%
rename from examples/user-example.php
rename to examples/url-shortener.php
index df09e456e..17cbd407e 100644
--- a/examples/user-example.php
+++ b/examples/url-shortener.php
@@ -14,19 +14,19 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+include_once __DIR__ . '/../vendor/autoload.php';
include_once "templates/base.php";
-session_start();
-require_once realpath(dirname(__FILE__) . '/../src/Google/autoload.php');
+echo pageHeader('User Query - URL Shortener');
-/************************************************
- ATTENTION: Fill in these values! Make sure
- the redirect URI is to this page, e.g:
- http://localhost:8080/user-example.php
+/*************************************************
+ * Ensure you've downloaded your oauth credentials
************************************************/
- $client_id = '';
- $client_secret = '';
- $redirect_uri = '';
+if (!$oauth_credentials = getOAuthCredentialsFile()) {
+ echo missingOAuth2CredentialsWarning();
+ exit;
+}
/************************************************
Make an API request on behalf of a user. In
@@ -35,39 +35,50 @@
through a login flow. To do this we need some
information from our API console project.
************************************************/
+/************************************************
+ * NOTICE:
+ * The redirect URI is to this page, e.g:
+ * http://localhost:8080/simplefileupload.php
+ ************************************************/
+$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
+
$client = new Google_Client();
-$client->setClientId($client_id);
-$client->setClientSecret($client_secret);
+$client->setAuthConfig($oauth_credentials);
$client->setRedirectUri($redirect_uri);
$client->addScope("https://www.googleapis.com/auth/urlshortener");
/************************************************
- When we create the service here, we pass the
- client to it. The client then queries the service
- for the required scopes, and uses that when
- generating the authentication URL later.
+ * When we create the service here, we pass the
+ * client to it. The client then queries the service
+ * for the required scopes, and uses that when
+ * generating the authentication URL later.
************************************************/
$service = new Google_Service_Urlshortener($client);
/************************************************
- If we're logging out we just need to clear our
- local access token in this case
+ * If we're logging out we just need to clear our
+ * local access token in this case
************************************************/
if (isset($_REQUEST['logout'])) {
unset($_SESSION['access_token']);
}
/************************************************
- If we have a code back from the OAuth 2.0 flow,
- we need to exchange that with the authenticate()
- function. We store the resultant access token
- bundle in the session, and redirect to ourself.
+ * If we have a code back from the OAuth 2.0 flow,
+ * we need to exchange that with the
+ * Google_Client::fetchAccessTokenWithAuthCode()
+ * function. We store the resultant access token
+ * bundle in the session, and redirect to ourself.
************************************************/
if (isset($_GET['code'])) {
- $client->authenticate($_GET['code']);
- $_SESSION['access_token'] = $client->getAccessToken();
- $redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
- header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
+ $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
+ $client->setAccessToken($token);
+
+ // store in the session also
+ $_SESSION['access_token'] = $token;
+
+ // redirect back to the example
+ header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}
/************************************************
@@ -96,37 +107,27 @@ function. We store the resultant access token
$short = $service->url->insert($url);
$_SESSION['access_token'] = $client->getAccessToken();
}
-
-echo pageHeader("User Query - URL Shortener");
-if (strpos($client_id, "googleusercontent") == false) {
- echo missingClientSecretsWarning();
- exit;
-}
?>
+