ResourcePropertyDefinition Class Reference

Inheritance diagram for ResourcePropertyDefinition:

Public Member Functions
	getOptionsArray ()
	setOptionsFromArray ($array=[])
	toHtmlInput ( $value='', $special_name='', $with_label=false, $allow_boolean_false=true, $disabled=false)
	validateState ($state='')
	createResourceProperty (Resource $resource, $state='')
	__toString ()
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)
	isRelation ($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	findByPropertyGroup ($group_id)
static	getDefinedTypes ()
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
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 (string $name, array $arguments)

Data Fields
const	CRSWGS84_REGEX = '/[+-]\d{1,3}\.\d{1,10}[+-]\d{1,3}\.\d{1,10}[+-]\d{1,5}\.\d{1,10}CRSWGS_84\/$/'
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	db_table ()
static	db_fields ()
static	pk ()
static	default_values ()
static	serialized_fields ()
static	alias_fields ()
static	i18n_fields ()
static	additional_fields ()
static	has_many ()
static	has_one ()
static	belongs_to ()
static	has_and_belongs_to_many ()
static	registered_callbacks ()
static	known_slots ()
static	notification_map ()
static	getter_setter_map ()
static	configure ($config=[])
static	config ($key)
static	registerCallback ($types, $cb)
static	unregisterCallback ($types, $cb)

Additional Inherited Members
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
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)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
static	$performs_batch_operation = false

Member Function Documentation

__toString()

__toString

(

)

configure()

static configure (   $config = [] )

staticprotected

createResourceProperty()

createResourceProperty	(	Resource	$resource,
			$state = ''
	)

Creates a ResourceProperty object that is automatically linked to the property definition. The ResourceProperty object is only created but not stored in the database.

Parameters

Resource	$resource	The resource object which shall be extended by a property.
string	$state	The value of the property that shall be created.

Exceptions

ResourcePropertyException

If $state is invalid for this property.

Returns

ResourceProperty A ResourceProperty object which can be modified.

findByPropertyGroup()

static findByPropertyGroup (   $group_id )

static

getDefinedTypes()

static getDefinedTypes ( )

static

Returns a list of all defined data types.

Returns

string[] An array containing the names of all defined resource property types.

getOptionsArray()

getOptionsArray

(

)

Returns all available options for this property as an array.

setOptionsFromArray()

setOptionsFromArray

(

$array = []

)

toHtmlInput()

toHtmlInput	(		$value = '',
			$special_name = '',
			$with_label = false,
			$allow_boolean_false = true,
			$disabled = false
	)

Generates appropriate HTML input elements for this property.

Parameters

string	$value	The value of the HTML input element.
string	$special_name	A special name for the HTML input(s).
bool	$with_label	Whether a label shall be placed around the HTML input element(s) or not.
bool	$allow_boolean_false	Wheter boolean attributes shall also include a hidden input field that sets the value to zero if the checkbox for the boolean attribute is not checked. Defaults to true.

Returns

string A string containing HTML code.

validateState()

validateState

(

$state = ''

)

Verifies that a property value (state) is valid for the given resource property definition.

Parameters

string

$state

A state for this property which shall be checked.

Exceptions

ResourcePropertyStateException

If the state has an invalid value a ResourcePropertyStateException is thrown.

Returns

bool True, if the state value is valid.

Field Documentation

CRSWGS84_REGEX

const CRSWGS84_REGEX = '/[+-]\d{1,3}\.\d{1,10}[+-]\d{1,3}\.\d{1,10}[+-]\d{1,5}\.\d{1,10}CRSWGS_84\/$/'

This regular expression is used to ensure that position properties are always in a format as specified by the ISO-6709 string representation.

---

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

• lib/models/resources/ResourcePropertyDefinition.php