Standard Class Reference

Public Member Functions
	event ($path)
	entity ($name)

Data Fields
	$entities = []
	$type = ""
	$version = ""
	$short = ""
	$standardVersion = "1.0"
	$standardsVerison = "1.0"
	$level = 1
	$enabled = false
	$className

Protected Member Functions
	init ()

Detailed Description

This is the template class for creating Standards.

See the tutorials for info on how to create one.

Member Function Documentation

entity

(

$name

)

This will return a new empty entity based on the $name.

Parameters

string

$name

The name of the standard entity.

Returns

This will return a new entity instance or false if not found.

event

(

$path

)

This will get an event based on its path.

Parameters

string

$path

The path to find the event at.

Returns

Standard_Event_Interface instance if found or false if not.

Field Documentation

$className

The class name of this standard.

$enabled = false

This is whether or not this standard instance is enabled and in use.

Note: Do not change this. It is automatically set by Standards.

$entities = []

This is an array of entities with the key as the short and value as the class name. Note: This is automatically filled in.

$level = 1

The detail level of the this standard.

$short = ""

The short link for paths.

$standardsVerison = "1.0"

The latest version of standards this is compatible with.

$standardVersion = "1.0"

The standard(type) version this is compatiple with.

$type = ""

The is the type of Standard this is.

$version = ""

The current version of the standard this is. Do not change this.

---

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

• Standards/Standards.php