PHP Class Horde_Service_Facebook, horde

Copyright 2004-2009 Facebook. All Rights Reserved. Copyright (c) 2007 Facebook, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. For help with this library, contact [email protected]
Exibir arquivo Open project: horde/horde

Public Properties

Property Type Description
$useSslResources boolean Use only ssl resource flag

Protected Properties

Property Type Description
$_http Horde_Http_Client
$_logger Horde_Log_Logger Holds an optional logger object
$_objCache Cache for the various objects we lazy load in __get()
$_secret string The API Secret Key

Public Methods

Method Description
__construct ( string $appId, string $secret, array $context ) Const'r
__get ( string $value ) : mixed Lazy load the facebook classes.
callGraphApi ( string $method = '', array $params = [], array $options = [] ) : mixed Call the Facebook Graph API.
callMethod ( string $method, array $params = [] ) : mixed Calls the specified normal REST API method.
getFacebookUrl ( string $subdomain = 'www' ) : string Helper function to get the appropriate facebook url

Method Details

__construct() public method

Const'r
public __construct ( string $appId, string $secret, array $context )
$appId string Application ID.
$secret string Developer API secret.
$context array Array of context information containing: 
     http_client - required
     logger
     use_ssl

__get() public method

Lazy load the facebook classes.
public __get ( string $value ) : mixed
$value string The lowercase representation of the subclass.
return mixed

callGraphApi() public method

Call the Facebook Graph API.
public callGraphApi ( string $method = '', array $params = [], array $options = [] ) : mixed
$method string The endpoint (method) to call.
$params array An array of parameters to pass along with the call.
$options array Additional request options: - request: (string) 'POST', 'GET', 'DELETE' etc..
return mixed The results of the API call.

callMethod() public method

Calls the specified normal REST API method.
public callMethod ( string $method, array $params = [] ) : mixed
$method string Name of the Facebook method to invoke
$params array A map of param names => param values
return mixed Result of method call

getFacebookUrl() public static method

Helper function to get the appropriate facebook url
public static getFacebookUrl ( string $subdomain = 'www' ) : string
$subdomain string The subdomain to use (www).
return string

Property Details

$_http protected_oe property

protected Horde_Http_Client $_http
return Horde_Http_Client

$_logger protected_oe property

Holds an optional logger object
protected Horde_Log_Logger $_logger
return Horde_Log_Logger

$_objCache protected_oe property

Cache for the various objects we lazy load in __get()
protected $_objCache

$_secret protected_oe property

The API Secret Key
protected string $_secret
return string

$useSslResources public_oe property

Use only ssl resource flag
public bool $useSslResources
return boolean