OpenGraphURL Class Reference

Inheritance diagram for OpenGraphURL:

Collaboration diagram for OpenGraphURL:

Public Member Functions
	__construct ($id=null)
	setValue ($field, $value)
	store ()
	fetch ()
	render ()
	getAudioFiles ()
	getVideoFiles ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()

Static Public Member Functions
static	fromURL ($url)
static	findOneByURL ($url)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Data Fields
const	EXPIRES_DURATION = 86400
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Protected Member Functions
	getMediaFiles ($type)
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])
static	config ($key)

Additional Inherited Members
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = []
	$serialized_fields = []
	$alias_fields = []
	$i18n_fields = []
	$additional_fields = []
	$relations = []
	$has_many = []
	$has_one = []
	$belongs_to = []
	$has_and_belongs_to_many = []
	$registered_callbacks = []
	$known_slots = []
	$notification_map = []
	$additional_data = []
	$getter_setter_map = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Constructor of the object. Provides a fallback if a url is passed instead of the usually expected numeric id in order to not break backward compatibility. But this constructor will fail miserably if a url is passed that is not in the database. This was chosen by design to encourage the correct use of an id.

Parameters

mixed

$id

Numeric id, existing url or null

Reimplemented from SimpleORMap.

Member Function Documentation

configure()

static configure (   $config = [] )

staticprotected

Configures this model.

Parameters

Array

$config

Configuration array

Reimplemented from SimpleORMap.

fetch()

fetch

(

)

Fetches information from the url by getting the contents of the webpage, parse the webpage and extract the information from the opengraph meta-tags. If the site doesn't have any opengraph-metatags it is in fact no opengraph node and thus no data will be stored in the database. Only $url['is_opengraph'] === '0' indicates that the site is no opengraph node at all.

Todo:

The combination of FileManager::fetchURLMetadata() and the following request leads to two requests for the open graph data. This should be fixed due to performance reasons.

Here is the call graph for this function:

Here is the caller graph for this function:

findOneByURL()

static findOneByURL (   $url )

static

Specialized findOneByURL function that uses the hash to find the appropriate record instead.

Parameters

string

$url

URL to find record for

Returns

mixed instance of OpenGraphURL if available, null otherwise

fromURL()

static fromURL (   $url )

static

Create an instance of this model given url. Differs from findOneByURL insofar that it will return a new object with the given url set instead of null.

Parameters

String

$url

URL to find

Returns

OpenGraphURL Either existing instance or a new instance for the given url

getAudioFiles()

getAudioFiles

(

)

Returns an array with all audiofiles that are provided by the opengraph-node. Each array-entry is an array itself with the url as first parameter and the content-type (important for <audio> tags) as the second.

Returns

array(array($url, $content_type), ...)

Here is the call graph for this function:

getMediaFiles()

getMediaFiles (   $type )

protected

Returns an array with all mediafiles that are provided by the opengraph-node. Each array-entry is an array itself with the url as first parameter and the content-type (important for <audio> or <video> tags) as the second.

Parameters

string

$type

"audio" or "video"

Returns

array(array($url, $content_type), ...)

Here is the call graph for this function:

Here is the caller graph for this function:

getVideoFiles()

getVideoFiles

(

)

Returns an array with all videofiles that are provided by the opengraph-node. Each array-entry is an array itself with the url as first parameter and the content-type (important for <video> tags) as the second.

Returns

array(array($url, $content_type), ...)

Here is the call graph for this function:

render()

render

(

)

Renders a small box with the information of the opengraph url. Used in blubber and in the forum.

Returns

string html output of the box.

Here is the call graph for this function:

setValue()

setValue	(		$field,
			$value
	)

Sets value of a column. Overwritten so that the hash is also set when the url is set.

Parameters

string	$field
string	$value

Returns

string

See also

SimpleORMap::setValue

Reimplemented from SimpleORMap.

store()

store

(

)

Stores the object and fetches the opengraph information when either the object is new or outdated.

Returns

int Number of updated records

Reimplemented from SimpleORMap.

Here is the call graph for this function:

Field Documentation

EXPIRES_DURATION

const EXPIRES_DURATION = 86400

---

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

• lib/models/OpenGraphURL.class.php