SMW\Constraint\Constraint Interface Reference

Inheritance diagram for SMW\Constraint\Constraint:

Public Member Functions
	hasViolation ()
	getType ()
	checkConstraint (array $constraint, $value)

Public Attributes
const	CLASS_CONSTRAINT_SCHEMA = 'CLASS_CONSTRAINT_SCHEMA'
const	PROPERTY_CONSTRAINT_SCHEMA = 'PROPERTY_CONSTRAINT_SCHEMA'
const	TYPE_INSTANT = 'type/instant'
const	TYPE_DEFERRED = 'type/deferred'

Detailed Description

GNU GPL v2+

Since

3.1

Author

mwjames

Member Function Documentation

checkConstraint()

SMW\Constraint\Constraint::checkConstraint	(	array	$constraint,
			$value
	)

Checks a constraint against a single value. Any error that occurred during the processing should be attached to an individual value using the ConstraintError class.

Since

3.1

Parameters

array	$constraint
mixed	$value

Implemented in SMW\Constraint\Constraints\UniqueValueConstraint, SMW\Constraint\Constraints\ShapeConstraint, SMW\Constraint\Constraints\MandatoryPropertiesConstraint, SMW\Constraint\Constraints\SingleValueConstraint, SMW\Constraint\Constraints\MustExistsConstraint, SMW\Constraint\Constraints\NamespaceConstraint, SMW\Constraint\Constraints\NonNegativeIntegerConstraint, and SMW\Constraint\Constraints\NullConstraint.

getType()

SMW\Constraint\Constraint::getType

(

)

Since

3.1

Returns

string

Implemented in SMW\Constraint\Constraints\UniqueValueConstraint, SMW\Constraint\Constraints\ShapeConstraint, SMW\Constraint\Constraints\MandatoryPropertiesConstraint, SMW\Constraint\Constraints\SingleValueConstraint, SMW\Constraint\Constraints\MustExistsConstraint, SMW\Constraint\Constraints\NamespaceConstraint, SMW\Constraint\Constraints\NonNegativeIntegerConstraint, SMW\Constraint\Constraints\DeferrableConstraint, and SMW\Constraint\Constraints\NullConstraint.

hasViolation()

SMW\Constraint\Constraint::hasViolation

(

)

Returns true when a violation during the check occurred.

Since

3.1

Returns

boolean

Implemented in SMW\Constraint\Constraints\UniqueValueConstraint, SMW\Constraint\Constraints\ShapeConstraint, SMW\Constraint\Constraints\MandatoryPropertiesConstraint, SMW\Constraint\Constraints\SingleValueConstraint, SMW\Constraint\Constraints\MustExistsConstraint, SMW\Constraint\Constraints\NamespaceConstraint, SMW\Constraint\Constraints\NonNegativeIntegerConstraint, and SMW\Constraint\Constraints\NullConstraint.

Member Data Documentation

CLASS_CONSTRAINT_SCHEMA

const SMW\Constraint\Constraint::CLASS_CONSTRAINT_SCHEMA = 'CLASS_CONSTRAINT_SCHEMA'

Schema types

TYPE_DEFERRED

const SMW\Constraint\Constraint::TYPE_DEFERRED = 'type/deferred'

The constraint check happens after a GET request using the job queue.

TYPE_INSTANT

const SMW\Constraint\Constraint::TYPE_INSTANT = 'type/instant'

The constraint check happens instantaneous on a GET request (aka. online) and should be used for "light" checks that doesn't involve the QueryEngine or a rule resolver given the potential computational requirements that are required to run checks on each individual value.

---

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

• Constraint.php