Class vProperty

A Class for representing properties within a myComponent (VCALENDAR or VCARD)

vObject

Extended by

vProperty

Package: awl
Located at vProperty.php

Methods summary
`public`	# `__construct( $name = null, & $master = null, & $refData = null, $seek = null )` Parsing of the incoming string is now performed lazily, in ParseFromIterator. You should use getter methods such as Value() and getParameterValue() instead of direct access to $content, $parameters etc, to ensure that parsing has occurred. Parsing of the incoming string is now performed lazily, in ParseFromIterator. You should use getter methods such as Value() and getParameterValue() instead of direct access to $content, $parameters etc, to ensure that parsing has occurred. Overrides `vObject::__construct()`
`public`	# `ParseFromIterator( )` Parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue However we allow ourselves to assume that the RFC2445 content unescaping has already happened when myComponent::ParseFrom() called myComponent::UnwrapComponent(). Parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue However we allow ourselves to assume that the RFC2445 content unescaping has already happened when myComponent::ParseFrom() called myComponent::UnwrapComponent(). Note this function is called lazily, from the individual getter methods. This avoids the cost of parsing at the point of object instantiation.
`public`	# `ParseFrom( & $unescaped )`
`public string`	# `Name( string $newname = null )` Get/Set name property Get/Set name property Parameters `$newname` [optional] A new name for the property Returns string The name for the property.
`public string`	# `Value( string $newvalue = null )` Get/Set the content of the property Get/Set the content of the property Parameters `$newvalue` [optional] A new value for the property Returns string The value of the property.
`public array`	# `Parameters( array $newparams = null )` Get/Set parameters in their entirety Get/Set parameters in their entirety Parameters `$newparams` An array of new parameter key/value pairs. The 'value' may be an array of values. Returns array The current array of parameters for the property.
`public string`	# `TextMatch( string $search )` Test if our value contains a string Test if our value contains a string Parameters `$search` The needle which we shall search the haystack for. Returns string The name for the property.
`public string`	# `GetParameterValue( string $name )` Get the value of a parameter Get the value of a parameter Parameters `$name` The name of the parameter to retrieve the value for Returns string The value of the parameter
`public`	# `SetParameterValue( string $name, string $value )` Set the value of a parameter Set the value of a parameter Parameters `$name` The name of the parameter to set the value for `$value` The value of the parameter
`public`	# `ClearParameters( string\|array $type = null )` Clear all parameters, or the parameters matching a particular type Clear all parameters, or the parameters matching a particular type Parameters `$type` The type of parameters or an array associating parameter names with true values: array( 'PARAMETER' => true, 'PARAMETER2' => true )
`public`	# `RenderParameters( )` Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped. Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.
`public`	# `Render( $force = false )` Render a suitably escaped RFC2445 content string. Render a suitably escaped RFC2445 content string.
`public`	# `__toString( )`
`public boolean`	# `TestFilter( array $filters )` Test a PROP-FILTER or PARAM-FILTER and return a true/false PROP-FILTER (is-defined \| is-not-defined \| ((time-range \| text-match)?, param-filter)) PARAM-FILTER (is-defined \| is-not-defined \| ((time-range \| text-match)?, param-filter)) Test a PROP-FILTER or PARAM-FILTER and return a true/false PROP-FILTER (is-defined \| is-not-defined \| ((time-range \| text-match)?, param-filter)) PARAM-FILTER (is-defined \| is-not-defined \| ((time-range \| text-match)?, param-filter)) Changed by GitLab user moosemark 2015-09-18 to fix initialisation of $content property (AWL issue 10) Parameters `$filters` $filter An array of XMLElement defining the filter Returns boolean Whether or not this vProperty passes the test
`public`	# `fill( $sp, $en, $pe )`
`public`	# `TestParamFilter( $filters, $parameter_value )`

Methods inherited from vObject
`getMaster(), invalidate(), isValid(), setMaster()`

Properties summary
`protected string`	`$name` The name of this property The name of this property	#
`protected array`	`$parameters` An array of parameters to this property, represented as key/value pairs. An array of parameters to this property, represented as key/value pairs.	#
`protected string`	`$content` The value of this property. The value of this property.	#
`protected ArrayIterator`	`$iterator` The original value that this was parsed from, if that's the way it happened. The original value that this was parsed from, if that's the way it happened.	#
`protected integer`	`$seek` The original seek of iterator The original seek of iterator	#
`protected`	`$line`	#

Properties inherited from vObject
`$lineHeap, $master, $valid`