Facebook\GraphNodes\GraphEdge Class Reference

Inheritance diagram for Facebook\GraphNodes\GraphEdge:

Public Member Functions
	__construct (FacebookRequest $request, array $data=[], array $metaData=[], $parentEdgeEndpoint=null, $subclassName=null)
	getParentGraphEdge ()
	getSubClassName ()
	getMetaData ()
	getNextCursor ()
	getPreviousCursor ()
	getCursor ($direction)
	getPaginationUrl ($direction)
	validateForPagination ()
	getPaginationRequest ($direction)
	getNextPageRequest ()
	getPreviousPageRequest ()
	getTotalCount ()
	map (\Closure $callback)
Public Member Functions inherited from Facebook\GraphNodes\Collection
	__construct (array $items=[])
	getField ($name, $default=null)
	getProperty ($name, $default=null)
	getFieldNames ()
	getPropertyNames ()
	all ()
	asArray ()
	asJson ($options=0)
	count ()
	getIterator ()
	offsetExists ($key)
	offsetGet ($key)
	offsetSet ($key, $value)
	offsetUnset ($key)
	__toString ()

Protected Attributes
	$request
	$metaData = []
	$parentEdgeEndpoint
	$subclassName
Protected Attributes inherited from Facebook\GraphNodes\Collection
	$items = []

Detailed Description

Definition at line 35 of file GraphEdge.php.

Constructor & Destructor Documentation

__construct()

Facebook\GraphNodes\GraphEdge::__construct	(	FacebookRequest	$request,
		array	$data = [],
		array	$metaData = [],
			$parentEdgeEndpoint = null,
			$subclassName = null
	)

Init this collection of GraphNode's.

Parameters

FacebookRequest	$request	The original request that generated this data.
array	$data	An array of GraphNode's.
array	$metaData	An array of Graph meta data like pagination, etc.
string | null	$parentEdgeEndpoint	The parent Graph edge endpoint that generated the list.
string | null	$subclassName	The subclass of the child GraphNode's.

Definition at line 66 of file GraphEdge.php.

Member Function Documentation

getCursor()

Facebook\GraphNodes\GraphEdge::getCursor

(

$direction

)

Returns the cursor for a specific direction if it exists.

Parameters

string

$direction

The direction of the page: after|before

Returns

string|null

Definition at line 133 of file GraphEdge.php.

getMetaData()

Facebook\GraphNodes\GraphEdge::getMetaData

(

)

Returns the raw meta data associated with this GraphEdge.

Returns

array

Definition at line 101 of file GraphEdge.php.

getNextCursor()

Facebook\GraphNodes\GraphEdge::getNextCursor

(

)

Returns the next cursor if it exists.

Returns

string|null

Definition at line 111 of file GraphEdge.php.

getNextPageRequest()

Facebook\GraphNodes\GraphEdge::getNextPageRequest

(

)

Gets the request object needed to make a "next" page request.

Returns

FacebookRequest|null

Exceptions

FacebookSDKException

Definition at line 206 of file GraphEdge.php.

getPaginationRequest()

Facebook\GraphNodes\GraphEdge::getPaginationRequest

(

$direction

)

Gets the request object needed to make a next|previous page request.

Parameters

string

$direction

The direction of the page: next|previous

Returns

FacebookRequest|null

Exceptions

FacebookSDKException

Definition at line 186 of file GraphEdge.php.

getPaginationUrl()

Facebook\GraphNodes\GraphEdge::getPaginationUrl

(

$direction

)

Generates a pagination URL based on a cursor.

Parameters

string

$direction

The direction of the page: next|previous

Returns

string|null

Exceptions

FacebookSDKException

Definition at line 151 of file GraphEdge.php.

getParentGraphEdge()

Facebook\GraphNodes\GraphEdge::getParentGraphEdge

(

)

Gets the parent Graph edge endpoint that generated the list.

Returns

string|null

Definition at line 81 of file GraphEdge.php.

getPreviousCursor()

Facebook\GraphNodes\GraphEdge::getPreviousCursor

(

)

Returns the previous cursor if it exists.

Returns

string|null

Definition at line 121 of file GraphEdge.php.

getPreviousPageRequest()

Facebook\GraphNodes\GraphEdge::getPreviousPageRequest

(

)

Gets the request object needed to make a "previous" page request.

Returns

FacebookRequest|null

Exceptions

FacebookSDKException

Definition at line 218 of file GraphEdge.php.

getSubClassName()

Facebook\GraphNodes\GraphEdge::getSubClassName

(

)

Gets the subclass name that the child GraphNode's are cast as.

Returns

string|null

Definition at line 91 of file GraphEdge.php.

getTotalCount()

Facebook\GraphNodes\GraphEdge::getTotalCount

(

)

The total number of results according to Graph if it exists.

This will be returned if the summary=true modifier is present in the request.

Returns

int|null

Definition at line 230 of file GraphEdge.php.

map()

Facebook\GraphNodes\GraphEdge::map

(

\Closure

$callback

)

@inheritDoc

Reimplemented from Facebook\GraphNodes\Collection.

Definition at line 242 of file GraphEdge.php.

validateForPagination()

Facebook\GraphNodes\GraphEdge::validateForPagination

(

)

Validates whether or not we can paginate on this request.

Exceptions

FacebookSDKException

Definition at line 170 of file GraphEdge.php.

Member Data Documentation

$metaData

Facebook\GraphNodes\GraphEdge::$metaData = []

protected

Definition at line 45 of file GraphEdge.php.

$parentEdgeEndpoint

Facebook\GraphNodes\GraphEdge::$parentEdgeEndpoint

protected

Definition at line 50 of file GraphEdge.php.

$request

Facebook\GraphNodes\GraphEdge::$request

protected

Definition at line 40 of file GraphEdge.php.

$subclassName

Facebook\GraphNodes\GraphEdge::$subclassName

protected

Definition at line 55 of file GraphEdge.php.

---

The documentation for this class was generated from the following file:

• plugins/facebook-php-sdk/src/Facebook/GraphNodes/GraphEdge.php