BaseUser

flitter-auth/model/User~ BaseUser

Base class for the flitter-auth User model.


Constructor

new BaseUser()

Extends

Members

(static) schema

Defines the schema for this model.

(static) services

Defines the services required by this model.

(private) __embedded :boolean

True if the model is embedded within a parent.

Type:
  • boolean

(private) __embedded_parent :module:flitter-orm/src/model/Model~Model|boolean

If the model is embedded within a parent, this is the reference to that parent. Otherwise, false.

(private) __relation_cache :module:flitter-orm/src/model/ResultCache~ResultCache

Cache for results of relationship lookups for the instance.

(private) __schema_instance :module:flitter-orm/src/schema/Schema~Schema|boolean

The holding variable for the instantiated schema.

(private) _di_allow_defer :boolean

If true, the injector will defer the class if the class requests any services that the container is missing. These services are filled in later and added to the prototype and any instances. True by default.

Type:
  • boolean

(private) _di_deferred_instances :Array.<module:flitter-di/src/Injectable~Injectable>

Collection of instances of this class that need to have the deferred service instances injected into them when the deferred services are finally provided.

(private) _di_deferred_services :Array.<string>

List of services that were deferred and not provided at the time of injection.

Type:
  • Array.<string>

collection :string|boolean

Optionally, the name of the collection where this model should have its records stored. If none is provided, the collection will be the name of the class.

Type:
  • string | boolean

id

If defined, will return the string-form ID of this model.

scopes :Array.<module:flitter-orm/src/model/Scope~Scope>

Array of instantiated references to Scopes that should be applied to this model.

Methods

(private) __collection() → {Collection}

Get the MongoDB collection instance for this model.

Returns:
Type
Collection

(async, private) __scope_limit_save(db_object) → {Promise.<object>}

Allow all of the model's registerd scopes to modify the schema-cast database object before it is persisted.

Parameters:
Name Type Description
db_object object
Returns:
  • modified db_object
Type
Promise.<object>

(private) __set_values(data, current_objectopt, current_schemaopt)

Shallow copy the values from the specified object to this model.

Parameters:
Name Type Attributes Default Description
data object
current_object object <optional>
false

for recursion. The current object scope.

current_schema object <optional>
false

for recursion. The current schema level.

_array_allow_permission(array_of_permissions, permission) → {boolean}

Checks if an array of permissions contains a permission that permits the passed in permission.

Parameters:
Name Type Description
array_of_permissions Array.<string>
permission string
Returns:
  • true if the permission check passed
Type
boolean
Examples
_array_allow_permission(['foo:bar', 'baz'], 'foo') // false
_array_allow_permission(['foo:bar', 'baz'], 'foo:bar') // true
_array_allow_permission(['foo:bar', 'baz'], 'foo:bar:view') // true

allow(permission, forceopt)

Applies the specified permission to the user if their current permission set doesn't already allow them to access it, or if the force flag is set.

Parameters:
Name Type Attributes Default Description
permission string
force Boolean <optional>
false

if true, add the permission to the user even if it is covered by a generic permission or role

belongs_to_many(OtherModel, local_key, foreign_keyopt) → {Promise.<Array.<module:flitter-orm/src/model/Model~Model>>|Array.<module:flitter-orm/src/model/Model~Model>}

Associates many records of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model

local_key string

local key of the field to match

foreign_key string <optional>
''

foreign key of the field to match (if none provided, assume the same as local_key)

Returns:
  • the matching model instances
Type
Promise.<Array.<module:flitter-orm/src/model/Model~Model>> | Array.<module:flitter-orm/src/model/Model~Model>

belongs_to_one(OtherModel, local_key, foreign_keyopt) → {Promise.<(module:flitter-orm/src/model/Model~Model|undefined)>|module:flitter-orm/src/model/Model~Model}

Associates a single record of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model

local_key string

local key of the field to match

foreign_key string <optional>
''

foreign key of the field to match (if none provided, assume the same as local_key)

Returns:
  • the matching model instance
Type
Promise.<(module:flitter-orm/src/model/Model~Model|undefined)> | module:flitter-orm/src/model/Model~Model

can(permission) → {Boolean}

Checks if a user has the specified permission. Permissions may include an argument specified like so: view_image:3348 If no argument is provided, it is assumed that the user has permission regardless of the argument.

Parameters:
Name Type Description
permission String
Returns:
  • true if the user has permission
Type
Boolean

data_get(key) → {*}

Get's a value from the user's serialized JSON.

Parameters:
Name Type Description
key string
Returns:
Type
*

data_set(key, value)

Stores a value in the user's serialized JSON.

Parameters:
Name Type Description
key string
value

(async) delete() → {Promise.<module:flitter-orm/src/model/Model~Model>}

Delete the current instance of this model from the database. This will remove the model's ID from this instance. Other properties will remain unchanged.

demote(role)

Strips the specified role from the user, if they have it.

Parameters:
Name Type Description
role string

disallow(permission)

Strips the permission from the user, if they have it.

Parameters:
Name Type Description
permission string

has_many(OtherModel, local_key, foreign_keyopt) → {Promise.<Array.<module:flitter-orm/src/model/Model~Model>>|Array.<module:flitter-orm/src/model/Model~Model>}

Associates many records of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model

local_key string

local key of the field to match

foreign_key string <optional>
''

foreign key of the field to match (if none provided, assume the same as local_key)

Returns:
  • the matching model instances
Type
Promise.<Array.<module:flitter-orm/src/model/Model~Model>> | Array.<module:flitter-orm/src/model/Model~Model>

has_one(OtherModel, local_key, foreign_keyopt) → {Promise.<module:flitter-orm/src/model/Model~Model>|module:flitter-orm/src/model/Model~Model}

Associates a single record of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model

local_key string

local key of the field to match

foreign_key string <optional>
''

foreign key of the field to match (if none provided, assume the same as local_key)

Returns:
  • the matching model instance
Type
Promise.<module:flitter-orm/src/model/Model~Model> | module:flitter-orm/src/model/Model~Model

promote(role)

Applies the specified role to the user, if they do not already have it.

Parameters:
Name Type Description
role string

role_has_permission(role, permission) → {boolean}

Checks if the specified role name contains the specified permission. Accounts for permissions with arguments. (e.g. view_image:2234)

Parameters:
Name Type Description
role string

the name of the role

permission string

the name of the permission

Returns:
  • true if the role contains the permission
Type
boolean

(async) save() → {Promise.<module:flitter-orm/src/model/Model~Model>}

Persist this model instance to the database. This will store only values defined in the schema for this model, and, in so doing, will cast those values and fill in the specified defaults. These changes will be added to this instance after the save.

Returns:
  • the current instance with updated properties
Type
Promise.<module:flitter-orm/src/model/Model~Model>

(async) set(field, value) → {Promise.<module:flitter-orm/src/model/Model~Model>}

A convenience method. Set the specified field on this model equal to the specified property and immediately save the record.

Parameters:
Name Type Description
field string
value *