CheckProp Class Reference

Check PROP import lines. More...

Inheritance diagram for CheckProp:

Collaboration diagram for CheckProp:

Public Member Functions
	check (array $data, &$docfam=null)
Public Member Functions inherited from CheckData
	getErrors ()
	hasErrors ()
	addError ($msg)
	check (array $data, &$extra=null)

Static Public Member Functions
static	checkValueSyntax ($value)
static	checkParameterClassKey ($pName)
static	getParameterClassMap ($key=null)

Data Fields
	$propName = ''
	$parameters = array()

Additional Inherited Members
Protected Attributes inherited from CheckData
	$errors = array()

Detailed Description

Check PROP import lines.

Checking family properties parameters

See Also

ErrorCodePRFL

Definition at line 12 of file CheckProp.php.

Member Function Documentation

check	(	array	$data,
		&	$docfam = null
	)

Check validity of a PROP import line

Parameters

array	$data
\DocFam	$docfam

Returns

CheckProp

Definition at line 38 of file CheckProp.php.

Here is the call graph for this function:

static checkParameterClassKey (   $pName )

static

Check that the parameter's name has a valid and known class name

Parameters

string

$pName

The parameter's name

Returns

bool boolean false if not valid, or boolean true if valid

Definition at line 99 of file CheckProp.php.

static checkValueSyntax (   $value )

static

Check validity of a parameter's tuple string value ("<pName>=<pValue>")

Parameters

string

$value

The parameter's tuple value

Returns

array|bool boolean false on error, or the parsed parameter tuple on success

Definition at line 82 of file CheckProp.php.

static getParameterClassMap (   $key = null )

static

Helper method to get the class name for a given parameter's name

Parameters

null

$key

Returns

array

Definition at line 109 of file CheckProp.php.

Field Documentation

$parameters = array()

Definition at line 23 of file CheckProp.php.

$propName = ''

Definition at line 18 of file CheckProp.php.

---

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

• CheckProp.php