PHPXRef 0.7.1 : moodle-2.8 : Detail view of Config.php

A class to contain the library configuration for the Google API client.

__construct($ini_file_location = null) X-Ref

Create a new Google_Config. Can accept an ini file location with the
local configuration. For example:
application_name: "My App";

param: [$ini_file_location] - optional - The location of the ini file to load

setClassConfig($class, $config, $value = null) X-Ref

Set configuration specific to a given class.
$config->setClassConfig('Google_Cache_File',
array('directory' => '/tmp/cache'));

param: $class The class name for the configuration
param: $config string key or an array of configuration values
param: $value optional - if $config is a key, the value

getClassConfig($class, $key = null) X-Ref

No description

getCacheClass() X-Ref

Return the configured cache class.

return: string

getAuthClass() X-Ref

Return the configured Auth class.

return: string

setAuthClass($class) X-Ref

Set the auth class.

param: $class the class name to set

setIoClass($class) X-Ref

Set the IO class.

param: $class the class name to set

setCacheClass($class) X-Ref

Set the cache class.

param: $class the class name to set

getIoClass() X-Ref

Return the configured IO class.

return: string

setApplicationName($name) X-Ref

Set the application name, this is included in the User-Agent HTTP header.

param: string $name

getApplicationName() X-Ref

return: string the name of the application

setClientId($clientId) X-Ref

Set the client ID for the auth class.

param: $key string - the API console client ID

setClientSecret($secret) X-Ref

Set the client secret for the auth class.

param: $key string - the API console client secret

setRedirectUri($uri) X-Ref

Set the redirect uri for the auth class. Note that if using the
Javascript based sign in flow, this should be the string 'postmessage'.

param: $key string - the URI that users should be redirected to

setRequestVisibleActions($rva) X-Ref

Set the app activities for the auth class.

param: $rva string a space separated list of app activity types

setAccessType($access) X-Ref

Set the the access type requested (offline or online.)

param: $access string - the access type

setApprovalPrompt($approval) X-Ref

Set when to show the approval prompt (auto or force)

param: $approval string - the approval request

setLoginHint($hint) X-Ref

Set the login hint (email address or sub identifier)

param: $hint string

setDeveloperKey($key) X-Ref

Set the developer key for the auth class. Note that this is separate value
from the client ID - if it looks like a URL, its a client ID!

param: $key string - the API console developer key

getBasePath() X-Ref

return: string the base URL to use for API calls

setAuthConfig($key, $value) X-Ref

Set the auth configuration for the current auth class.

param: $key - the key to set
param: $value - the parameter value

File Size:	325 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

/lib/google/Google/ -> Config.php (summary)

Defines 1 class