Class MWebfile

Base class for all webfile class definitions.
On the following link you can find more information about the definition of webfiles.

Direct known subclasses

Indirect known subclasses

Namespace: webfilesframework\core\datasystem\file\format
Author: Sebastian Monzel < mail@sebastianmonzel.de >
Since: 0.1.7
Located at core/datasystem/file/format/MWebfile.php

Methods summary
`public string`	# `marshall( boolean $usePreamble = true )` Converts the current webfile into its xml representation. Converts the current webfile into its xml representation. Parameters `$usePreamble` sets the option of using a preamble in xml - usually used for setting the version of xml an the encoding. Returns string string returns the webfile as a marshalled String. Throws ReflectionException
`public`	# `unmarshall( string $data )` Converts the given xml into a webfile object. Converts the given xml into a webfile object. Parameters `$data` xml which represents a webfile. Throws `webfilesframework\MWebfilesFrameworkException` ReflectionException
`public static webfilesframework\core\datasystem\file\format\MWebfile`	# `staticUnmarshall( string $xmlAsString )` Converts the given xml-String into a new webfile object. Converts the given xml-String into a new webfile object. Parameters `$xmlAsString` Returns `webfilesframework\core\datasystem\file\format\MWebfile` Throws `webfilesframework\MWebfilesFrameworkException` ReflectionException
`public`	# `presetForTemplateSearch( )` In case of using the current webfile object for making a request on a datastore (getByTemplate()) this method helps to set the defaults for making the template request. In case of using the current webfile object for making a request on a datastore (getByTemplate()) this method helps to set the defaults for making the template request. Throws ReflectionException
`public boolean`	# `matchesTemplate( webfilesframework\core\datasystem\file\format\MWebfile $template )` Parameters `$template` Returns boolean Throws ReflectionException
`public static boolean`	# `isSimpleDatatype( string $datatypeName )` returns true if attribute is a simple datatype (for example string, integer or boolean). returns true if attribute is a simple datatype (for example string, integer or boolean). Parameters `$datatypeName` Returns boolean
`public static boolean`	# `isObject( string $attributeName )` returns true if attribute is object in the other case the returnvalue is false returns true if attribute is object in the other case the returnvalue is false Parameters `$attributeName` Returns boolean
`public static ReflectionProperty[]`	# `getAttributes( boolean $simpleDatatypesOnly = false )` eturns the attributes of the actual class which are relevant for the webfile definition. eturns the attributes of the actual class which are relevant for the webfile definition. Parameters `$simpleDatatypesOnly` Returns ReflectionProperty[] Throws ReflectionException
`public static string`	# `getClassInformation( )` Returns a xml defined class information. It contains the classname and the given attributes. Returns a xml defined class information. It contains the classname and the given attributes. Returns string xml with information about the class Throws ReflectionException
`public static null\|string`	# `getDatatypeFromAttributeName( string $attributeName )` Enter description here ... Parameters `$attributeName` Returns null\|string
`public array`	# `getDataset( )` Transforms the actual webfile into an dataset. A dataset is represented by a key value array. The key is the attributes name. The value is the attributes value. Transforms the actual webfile into an dataset. A dataset is represented by a key value array. The key is the attributes name. The value is the attributes value. Returns array Throws ReflectionException
`public static string`	# `getSimplifiedAttributeName( string $p_sFieldName )` Returns database field name to a given attribute Returns database field name to a given attribute Parameters `$p_sFieldName` Returns string
`public`	# `getId( )`
`public`	# `setId( $itemId )`
`public`	# `getTime( )`
`public`	# `setTime( $time )` Parameters `$time` unix timestamp of the context time.
`public`	# `getGeograficPosition( )`
`public static`	# `classname( )`
`public static webfilesframework\core\datasystem\file\format\MWebfile`	# `createWebfileByClassname( $classname )` Parameters `$classname` Returns `webfilesframework\core\datasystem\file\format\MWebfile` Throws `webfilesframework\MWebfilesFrameworkException` ReflectionException

Properties summary
`protected integer`	`$m_iId`	# `0`
`public integer`	`$m_iTime` sets the time of the main context of the given webfile. Example: An event would have the point when it takes place. An news entry would have the creation time as context time. sets the time of the main context of the given webfile. Example: An event would have the point when it takes place. An news entry would have the creation time as context time.	#

Namespaces

Classes

Class MWebfile

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Throws

Parameters

Throws

Parameters

Returns

Throws

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Throws