JGoogleDataPicasaAlbum
Extends \JGoogleDataGoogle Picasa data class for the Joomla Platform.
since |
3.1.4 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null)
since |
3.1.4 |
---|
Arguments
- $options
\Joomla\Registry\Registry
Google options object.- $auth
\JGoogleAuth
Google data http client object.
authenticate
Method to authenticate to Google
authenticate() : boolean
since |
3.1.4 |
---|
Response
boolean
True on success.
delete
Method to delete a Picasa album
delete(mixed $match = '*') : boolean
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $match
mixed
Check for most up to date album
Response
boolean
Success or failure.
getAccess
Method to get the access level of the album
getAccess() : string
since |
3.1.4 |
---|
Response
string
Album access level
getLink
Method to get the album link
getLink(string $type = 'edit') : string
since |
3.1.4 |
---|
Arguments
- $type
string
Type of link to return
Response
string
Link or false on failure
getLocation
Method to get the location of the album
getLocation() : string
since |
3.1.4 |
---|
Response
string
Album location
getMime
Add photo
getMime(string $file) : mixed
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $file
string
Filename
Response
mixed
Data from Google
getOption
Get an option from the JGoogleData instance.
getOption(string $key) : mixed
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
getSummary
Method to get the summary of the album
getSummary() : string
since |
3.1.4 |
---|
Response
string
Album summary
getTime
Method to get the time of the album
getTime() : double
since |
3.1.4 |
---|
Response
double
Album time
getTitle
Method to get the title of the album
getTitle() : string
since |
3.1.4 |
---|
Response
string
Album title
isAuthenticated
Check authentication
isAuthenticated() : boolean
since |
3.1.4 |
---|
Response
boolean
True if authenticated.
listGetData
Method to retrieve a list of data
listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $url
array
URL to GET- $maxpages
integer
Maximum number of pages to return- $token
string
Next page token
Response
mixed
Data from Google
listPhotos
Method to retrieve a list of Picasa Photos
listPhotos() : mixed
since |
3.1.4 |
---|---|
throws |
|
Response
mixed
Data from Google
query
Method to retrieve data from Google
query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
since |
3.1.4 |
---|
Arguments
- $url
string
The URL for the request.- $data
mixed
The data to include in the request.- $headers
array
The headers to send with the request.- $method
string
The type of http request to send.
Response
mixed
Data from Google.
refresh
Refresh Picasa Album
refresh() : mixed
since |
3.1.4 |
---|---|
throws |
|
Response
mixed
Data from Google
safeXml
Method to validate XML
safeXml(string $data) : \SimpleXMLElement
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $data
string
XML data to be parsed
Response
\SimpleXMLElement
XMLElement of parsed data
save
Method to modify a Picasa Album
save(string $match = '*') : mixed
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $match
string
Optional eTag matching parameter
Response
mixed
Data from Google.
setAccess
Method to set the access level of the album
setAccess(string $access) : \JGoogleDataPicasaAlbum
since |
3.1.4 |
---|
Arguments
- $access
string
New album access
Response
\JGoogleDataPicasaAlbum
The object for method chaining
setLocation
Method to set the location of the album
setLocation(string $location) : \JGoogleDataPicasaAlbum
since |
3.1.4 |
---|
Arguments
- $location
string
New album location
Response
\JGoogleDataPicasaAlbum
The object for method chaining
setOption
Set an option for the JGoogleData instance.
setOption(string $key, mixed $value) : \JGoogleData
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JGoogleData
This object for method chaining.
setSummary
Method to set the summary of the album
setSummary(string $summary) : \JGoogleDataPicasaAlbum
since |
3.1.4 |
---|
Arguments
- $summary
string
New album summary
Response
\JGoogleDataPicasaAlbum
The object for method chaining
setTime
Method to set the time of the album
setTime(integer $time) : \JGoogleDataPicasaAlbum
since |
3.1.4 |
---|
Arguments
- $time
integer
New album time
Response
\JGoogleDataPicasaAlbum
The object for method chaining
setTitle
Method to set the title of the album
setTitle(string $title) : \JGoogleDataPicasaAlbum
since |
3.1.4 |
---|
Arguments
- $title
string
New album title
Response
\JGoogleDataPicasaAlbum
The object for method chaining
upload
Add photo
upload(string $file, string $title = '', string $summary = '') : mixed
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $file
string
Path of file to upload- $title
string
Title to give to file (defaults to filename)- $summary
string
Description of the file
Response
mixed
Data from Google
Properties
xml
The album's XML
since |
3.1.4 |
---|
Type(s)
\SimpleXMLElement