Initialize Nymph.
The Nymph configuration.
The Nymph database driver.
Optional tilmeld: TilmeldInterfaceThe Tilmeld user/group manager instance, if you want to use it.
Optional parent: NymphUsed internally by Nymph. Don't set this.
The entity class for this instance of Nymph.
Private afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate afterPrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforePrivate beforeThe Nymph config.
Private connectPrivate disconnectThe Nymph database driver.
Private entityA simple map of names to Entity classes.
Private failedPrivate failedPrivate failedPrivate failedPrivate failedPrivate failedPrivate failedThe Nymph instance that this one was cloned from, or null if it's not a clone.
Private queryOptional tilmeldAn optional Tilmeld user/group manager instance.
Add your class to this instance.
This will create a class that extends your class within this instance of Nymph and return it. You can then use this class's constructor and methods, which will use this instance of Nymph.
Because this creates a subclass, don't use the class
returned from getEntityClass to check with instanceof.
Delete an entity from the database.
The entity.
True on success, false on failure.
Export entities to a local file.
This is the file format:
#nex2
# The above line must be the first thing in the file.
# Comments begin with #
# And can have white space before them.
# This defines a UID.
<name/of/uid>[5]
<another uid>[8000]
# For UIDs, the name is in angle brackets (<>) and the value follows
# in square brackets ([]).
# This starts a new entity.
{1234abcd}<etype>[tag,list,with,commas]
# For entities, the GUID is in curly brackets ({}), then the etype in
# angle brackets, then the comma separated tag list follows in square
# brackets ([]).
# Properties are stored like this:
# propname=JSON.stringify(value)
abilities=["system/admin"]
groups=[]
inheritAbilities=false
name="admin"
# White space before/after "=" and at beginning/end of line is ignored.
username = "admin"
{2}<etype>[tag,list]
another="This is another entity."
newline="\n"
The file to export to.
True on success, false on failure.
Get an array of entities.
options is an object, which contains any of the following settings:
If a class is specified, it must have a factory() static method that returns a new instance.
Selectors are objects. Any amount of selectors can be provided. Empty
selectors will be ignored. The type property of a selector is required
and can be one of the following strings:
The rest of the properties in the selectors are called selector clauses, which can be any of the following (in the form selector.name = value, or selector.name = [value1, value2,...]):
These clauses can all be negated, by prefixing them with an exclamation point, such as "!truthy" to mean falsy (or undefined).
Any clause that accepts an array of name and value can also accept a third element. If value is null and the third element is a string, the third element will be used with Locutus' strtotime function to set value to a relative timestamp. For example, the following selector will look for all entities that were created in the last day:
{
type: '&',
gte: ['cdate', null, '-1 day']
}
Locutus' implementation: https://locutus.io/php/datetime/strtotime/ PHP's documentation: https://www.php.net/manual/en/function.strtotime.php
This example will retrieve the last two entities where:
const entities = Nymph.getEntities(
{ class: Entity, reverse: true, limit: 2 },
{
type: '&', // all must be true
tag: 'person',
defined: 'spouse',
equal: [
['gender', 'male'],
['lname', 'Smith']
],
'!equal': ['warnings', 0]
},
{
type: '|', // at least one of the selectors in this must match
selector: [
{
type: '&',
tag: ['level1', 'level2']
},
{
type: '&',
tag: ['access1', 'access2']
}
]
},
{
type: '|', // at least one must be true
tag: ['employee', 'manager']
},
{
type: '|',
equal: [
['name', 'Clark'],
['name', 'James']
],
match: [
['name', 'Chris(topher)?'],
['name', 'Ja(ke|cob)']
]
},
{
type: '!|', // at least one must be false
gte: ['age', 22],
gt: ['pay', 8]
}
);
An array of entities or guids, or a count.
Use an asterisk to specify any variable.
Get the first entity to match all options/selectors.
options and selectors are the same as in getEntities().
This function is equivalent to setting options.limit to 1 for getEntities(), except that it will return null if no entity is found. getEntities() would return an empty array.
An entity or guid, or null on failure or nothing found, or a number.
Get the class that uses the specified class name.
Increment or create a unique ID and return the new value.
Unique IDs, or UIDs are similar to GUIDs, but numeric and sequential.
A UID can be used to identify an object when the GUID doesn't suffice. On a system where a new entity is created many times per second, referring to something by its GUID may be unintuitive. However, the component designer is responsible for assigning UIDs to the component's entities. Beware that if a UID is incremented for an entity, and the entity cannot be saved, there is no safe, and therefore, no recommended way to decrement the UID back to its previous value.
If newUID() is passed the name of a UID which does not exist yet, one will be created with that name, and assigned the value 1. If the UID already exists, its value will be incremented. The new value will be returned.
The UID's name.
The UID's new value, or null on failure.
Run all the query callbacks on a query.
Save an entity to the database.
If the entity has never been saved (has no GUID), a variable "cdate" is set on it with the current Unix timestamp.
The variable "mdate" is set to the current Unix timestamp.
The entity.
True on success, false on failure.
Start an atomic transaction and returns a new instance of Nymph.
All proceeding changes using this new instance will wait to be written to the database's permanent storage until commit() is called. You can also undo all the changes since this function ran with rollback().
Transactions will nest as long as every name is unique. Internally, Nymph uses names prefixed with "nymph-".
A new instance of Nymph that should be used for the transaction.
Generated using TypeDoc
An object relational mapper for Node.js.
Written by Hunter Perrin for SciActive.
Author
Hunter Perrin [email protected]
Copyright
SciActive Inc
See
http://nymph.io/