saschabach
/
gplx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gplx/mediawiki/extensions/SemanticMediaWiki/docs/architecture/extending.constraint.md

1.7 KiB
Raw Blame History

src/Constraint

Property constraint

To add a new constraint (let's say represented by foo_contraint) it is expected that:

  • The foo_contraint property is registered with the validation schema (property-constraint-schema.v1.json) hereby defines its characteristics (array, boolean, pattern etc.)
  • A new class is added that implements the Constraint interface and interprets the foo_contraint property together with the constraint boundaries
  • The foo_contraint property and the newly created class are registered with the ConstraintRegistry
  • The newly created Constraint class is added to the ConstraintFactory to define the object graph

When adding new constraints, please ensure that:

  • Unit tests carefully test the expected behaviour
  • The ConstraintRegistryTest and ConstraintFactoryTest are extended

TYPE_DEFERRED

When a constraint is expected to be expensive (in terms of performance, runtime) it should be postponed and be derived from the DeferrableConstraint class to ensure that those checks are run using the DeferredConstraintCheckUpdateJob hereby avoiding unnecessary resource hogging during a page view/GET process.

See also