Php/docs/mongodbref.isref

From Get docs

MongoDBRef::isRef

(PECL mongo >= 0.9.0)

MongoDBRef::isRefChecks if an array is a database reference


This extension that defines this class

is deprecated. Instead, the MongoDB extension should be used. There is no equivalent for this class in the new extension.

The concept of database references, and hence this class, has been deprecated.

Description

public static MongoDBRef::isRef ( mixed $ref ) : bool

This method does not actually follow the reference, so it does not determine if it is broken or not. It merely checks that ref is in valid database reference format (in that it is an object or array with $ref and $id fields).


Parameters

ref
Array or object to check.


Return Values

Returns TRUE on success or FALSE on failure.