CheckDoc Class Reference

Inheritance diagram for CheckDoc:

Collaboration diagram for CheckDoc:

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

Static Public Member Functions
static	isWellformedLogicalName ($name)

Data Fields
const	LOGICALNAME_RE = '/^[a-z][a-z0-9_-]*$/i'

Protected Member Functions
	CheckDocFrom ()
	CheckDocName ()

Protected Attributes
	$famName
	$specName
	$folderId
	$doc
Protected Attributes inherited from CheckData
	$errors = array()

Detailed Description

Definition at line 7 of file CheckDoc.php.

Member Function Documentation

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

Parameters

array	$data
Doc	$doc

Returns

CheckDoc

Definition at line 31 of file CheckDoc.php.

Here is the call graph for this function:

CheckDocFrom ( )

protected

check check

Returns

void

Definition at line 57 of file CheckDoc.php.

Here is the call graph for this function:

CheckDocName ( )

protected

check logical name

Returns

void

Definition at line 90 of file CheckDoc.php.

Here is the call graph for this function:

getParsedFamName

(

)

Get the parsed family name or bool(false) if family could not be parsed.

Returns

bool|string

Definition at line 48 of file CheckDoc.php.

static isWellformedLogicalName (   $name )

static

Check the given logical name is well-formed.

Parameters

$name

string

Returns

bool true when well-formed or false when mal-formed

Definition at line 111 of file CheckDoc.php.

Field Documentation

$doc

protected

Definition at line 25 of file CheckDoc.php.

$famName

protected

Definition at line 13 of file CheckDoc.php.

$folderId

protected

Definition at line 21 of file CheckDoc.php.

$specName

protected

Definition at line 17 of file CheckDoc.php.

const LOGICALNAME_RE = '/^[a-z][a-z0-9_-]*$/i'

Definition at line 9 of file CheckDoc.php.

---

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

• CheckDoc.php