eZ.Notification Class
The Notification Model
Constructor
eZ.Notification
()
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _aggregateAttrs
- _attrCfgHash
- _baseDestroy
- _baseInit
- _cloneDefaultValue
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyHierarchy
- _filterAdHocAttrs
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getFullType
- _getInstanceAttrCfgs
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _monitor
- _normAttrVals
- _parse
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- _validate
- addAttr
- addAttrs
- addTarget
- after
- attrAdded
- before
- bubble
- destroy
- detach
- detachAll
- ez-notification
- fire
- generateClientId
- get
- getAsHTML
- getAsURL
- getAttrs
- getEvent
- getTargets
- init
- isModified
- isNew
- load
- modifyAttr
- on
- once
- onceAfter
- parse
- parseType
- publish
- removeAttr
- removeTarget
- reset
- save
- set
- setAttrs
- subscribe deprecated
- sync
- toJSON
- toString
- undo
- unsubscribe deprecated
- unsubscribeAll deprecated
- validate
Properties
- _allowAdHocAttrs
- _isYUIModel
- changed
- idAttribute
- lastChange
- lists
- name deprecated
Attributes
Methods
_addAttrs
-
cfgs
-
values
-
lazy
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttr
-
name
-
[lazyCfg]
Parameters:
-
name
ObjectThe name of the attribute -
[lazyCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.
_addOutOfOrder
-
name
-
cfg
Parameters:
-
name
Stringattribute name -
cfg
Objectattribute configuration
_aggregateAttrs
-
allAttrs
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_cloneDefaultValue
-
cfg
Parameters:
-
cfg
Object
_defAttrChangeFn
-
e
-
eventFastPath
Parameters:
-
e
EventFacadeThe event object for attribute change events. -
eventFastPath
BooleanWhether or not we're using this as a fast path in the case of no listeners or not
_defInitFn
-
e
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty. -
userVals
ObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Parameters:
-
attrName
StringThe name of the attribute -
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null. -
currVal
AnyThe current value of the attribute -
newVal
AnyThe new value of the attribute -
opts
ObjectAny additional event data to mix into the attribute change event's event facade. -
[cfg]
Object optionalThe attribute config stored in State, if already available.
_getAttr
-
name
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Parameters:
-
attr
StringThe name of the attribute -
cfg
ObjectThe attribute configuration object -
initValues
ObjectThe object with simple and complex attribute name/value pairs returned from _normAttrVals
Returns:
_getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function
protected
Returns:
_getFullType
-
type
Parameters:
-
type
StringThe short type to prefix
Returns:
_getInstanceAttrCfgs
-
allCfgs
addAttrs
,
from the static cached ATTRS for the class.
Parameters:
-
allCfgs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
Returns:
addAttrs
.
_getStateVal
-
name
-
[cfg]
Parameters:
-
name
StringThe name of the attribute -
[cfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_getType
()
private
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
StringThe fully prefixed type name
Returns:
_initAttrHost
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
_initAttrs
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Parameters:
-
config
ObjectThe constructor configuration object
_initHierarchy
-
userVals
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
_isLazyAttr
-
name
Parameters:
-
name
StringThe name of the attribute
Returns:
_monitor
-
what
-
eventType
-
o
Parameters:
-
what
String'attach', 'detach', 'fire', or 'publish' -
eventType
String | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object. -
o
ObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Parameters:
-
valueHash
ObjectAn object with attribute name/value pairs
Returns:
_parse
-
response
parse()
method and returns the result.
Override this method to provide a custom pre-parsing implementation. This
provides a hook for custom persistence implementations to "prep" a response
before calling the parse()
method.
Parameters:
-
response
AnyServer response.
Returns:
_parseType
()
private
_preInitEventCfg
-
config
Parameters:
-
config
ObjectThe user configuration object
_protectAttrs
-
attrs
Parameters:
-
attrs
ObjectA hash of attribute to configuration object pairs.
Returns:
_publish
-
fullType
-
etOpts
-
ceOpts
type
to fullType
conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
-
fullType
StringThe prefixed type of the event to publish. -
etOpts
ObjectThe EventTarget specific configuration to mix into the published event. -
ceOpts
ObjectThe publish specific configuration to mix into the published event.
Returns:
etOpts
or ceOpts
, this will
be the default CustomEvent
instance, and can be configured independently.
_set
-
name
-
val
-
[opts]
Parameters:
-
name
StringThe name of the attribute. -
val
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
_setAttr
-
name
-
value
-
[opts]
-
force
Parameters:
-
name
StringThe name of the attribute. -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
force
BooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change
Returns:
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
-
[opts]
-
[attrCfg]
_setAttrVal
, to register the changed value if it's part
of a Model setAttrs
transaction.
NOTE: AttributeCore's _setAttrVal
is currently private, but until we support coalesced
change events in attribute, we need this override.
Parameters:
-
attrName
StringThe attribute name. -
subAttrName
StringThe sub-attribute name, if setting a sub-attribute property ("x.y.z"). -
prevVal
AnyThe currently stored value of the attribute. -
newVal
AnyThe value which is going to be stored. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
[attrCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
_validate
-
attributes
-
callback
validate()
method and fires an error
event
if validation fails.
Parameters:
-
attributes
ObjectAttribute hash. -
callback
FunctionValidation callback.-
[err]
Any optionalValue on failure, non-value on success.
-
addAttr
-
name
-
config
-
lazy
addAttr
method provided by Y.Attribute
to keep the
id
attribute’s value and a custom id attribute’s (if provided) value
in sync when adding the attributes to the model instance object.
Marked as protected to hide it from Model's public API docs, even though
this is a public method in Attribute.
Parameters:
-
name
StringThe name of the attribute. -
config
ObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute. -
lazy
Boolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs
-
values
-
lazy
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
addTarget
-
o
Parameters:
-
o
EventTargetthe target to add
after
-
type
-
fn
-
[context]
-
[arg*]
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
destroy
-
[options]
-
[callback]
options.remove
is true
, then this method delegates to the sync()
method to delete the model from the persistence layer, which is an
asynchronous action. In this case, the _callback_ (if provided) will be
called after the sync layer indicates success or failure of the delete
operation.
Parameters:
-
[options]
Object optionalSync options. It's up to the custom sync implementation to determine what options it supports or requires, if any.-
[remove=false]
Boolean optionalIf
true
, the model will be deleted via the sync layer in addition to the instance being destroyed.
-
-
[callback]
Function optionalCalled after the model has been destroyed (and deleted via the sync layer ifoptions.remove
istrue
).-
err
Error | NullIf an error occurred, this parameter will contain the error. Otherwise err will be
null
.
-
detach
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectEither the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events. -
fn
FunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed. -
context
ObjectThe custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
Returns:
detachAll
-
type
Parameters:
-
type
StringThe type, or name of the event
ez-notification
()
Provides the notification model
fire
-
type
-
arguments
Parameters:
-
type
String | ObjectThe type of the event, or an object that contains a 'type' property. -
arguments
Objectan arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
Returns:
generateClientId
()
String
Returns:
get
-
name
Parameters:
-
name
StringAttribute name or object property path.
Returns:
undefined
if the attribute doesn't
exist.
Example:
// Set the 'foo' attribute to an object.
myModel.set('foo', {
bar: {
baz: 'quux'
}
});
// Get the value of 'foo'.
myModel.get('foo');
// => {bar: {baz: 'quux'}}
// Get the value of 'foo.bar.baz'.
myModel.get('foo.bar.baz');
// => 'quux'
getAsHTML
-
name
Y.Escape.html()
.
Parameters:
-
name
StringAttribute name or object property path.
Returns:
getAsURL
-
name
encodeURIComponent()
function.
Parameters:
-
name
StringAttribute name or object property path.
Returns:
getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getTargets
()
Returns:
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
isModified
()
Boolean
true
if any attribute of this model has been changed since the
model was last saved.
New models (models for which isNew()
returns true
) are implicitly
considered to be "modified" until the first time they're saved.
Returns:
true
if this model has changed since it was last saved,
false
otherwise.
isNew
()
Boolean
true
if this model is "new", meaning it hasn't been saved since it
was created.
Newness is determined by checking whether the model's id
attribute has
been set. An empty id is assumed to indicate a new model, whereas a
non-empty id indicates a model that was either loaded or has been saved
since it was created.
Returns:
true
if this model is new, false
otherwise.
load
-
[options]
-
[callback]
sync()
method to perform the actual load
operation, which is an asynchronous action. Specify a _callback_ function to
be notified of success or failure.
A successful load operation will fire a load
event, while an unsuccessful
load operation will fire an error
event with the src
value "load".
If the load operation succeeds and one or more of the loaded attributes
differ from this model's current attributes, a change
event will be fired.
Parameters:
-
[options]
Object optionalOptions to be passed tosync()
and toset()
when setting the loaded attributes. It's up to the custom sync implementation to determine what options it supports or requires, if any. -
[callback]
Function optionalCalled when the sync operation finishes.-
err
Error | NullIf an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be
null
. -
response
AnyThe server's response. This value will be passed to the
parse()
method, which is expected to parse it and return an attribute hash.
-
modifyAttr
-
name
-
config
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute:
- readOnly;
- writeOnce;
- broadcast; and
- getter.
Note: New attributes cannot be added using this interface. New attributes must be added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the {{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in {{#crossLink "Base"}}Base{{/crossLink}}).
Parameters:
-
name
StringThe name of the attribute whose configuration is to be updated. -
config
ObjectAn object with configuration property/value pairs, specifying the configuration properties to modify.
on
-
type
-
fn
-
[context]
-
[arg*]
emitFacade = true
will
receive an EventFacade
as the first argument (typically named "e").
These callbacks can then call e.preventDefault()
to disable the
behavior published to that event's defaultFn
. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade
events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first
argument, where the key:value pairs correspond to the eventName:callback.
this.on({
"attrChange" : this._onAttrChange,
"change" : this._onChange
});
You can also pass an array of event names as the first argument to
subscribe to all listed events with the same callback.
this.on([ "change", "attrChange" ], this._onChange);
Returning false
from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();
. However, it is
recommended to use the event methods whenever possible.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
once
-
type
-
fn
-
[context]
-
[arg*]
on
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
onceAfter
-
type
-
fn
-
[context]
-
[arg*]
after
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
parse
-
response
Y.JSON
or the native JSON
object
are available, it will be parsed automatically. If a parse error occurs, an
error
event will be fired and the model will not be updated.
You may override this method to implement custom parsing logic if necessary.
Parameters:
-
response
AnyServer response.
Returns:
parseType
-
type
-
[pre]
Parameters:
-
type
Stringthe type -
[pre]
String optionalThe prefix. Defaults to this._yuievt.config.prefix
Returns:
publish
-
type
-
opts
Parameters:
-
type
Stringthe type, or name of the event -
opts
Objectoptional config params. Valid properties are:-
[broadcast=false]
Boolean optionalwhether or not the YUI instance and YUI global are notified when the event is fired.
-
[bubbles=true]
Boolean optionalWhether or not this event bubbles. Events can only bubble if
emitFacade
is true. -
[context=this]
Object optionalthe default execution context for the listeners.
-
[defaultFn]
Function optionalthe default function to execute when this event fires if preventDefault was not called.
-
[emitFacade=false]
Boolean optionalwhether or not this event emits a facade.
-
[prefix]
String optionalthe prefix for this targets events, e.g., 'menu' in 'menu:click'.
-
[fireOnce=false]
Boolean optionalif an event is configured to fire once, new subscribers after the fire will be notified immediately.
-
[async=false]
Boolean optionalfireOnce event listeners will fire synchronously if the event has already fired unless
async
istrue
. -
[preventable=true]
Boolean optionalwhether or not
preventDefault()
has an effect. -
[preventedFn]
Function optionala function that is executed when
preventDefault()
is called. -
[queuable=false]
Boolean optionalwhether or not this event can be queued during bubbling.
-
[silent]
Boolean optionalif silent is true, debug messages are not provided for this event.
-
[stoppedFn]
Function optionala function that is executed when stopPropagation is called.
-
[monitored]
Boolean optionalspecifies whether or not this event should send notifications about when the event has been attached, detached, or published.
-
[type]
String optionalthe event type (valid option if not provided as the first parameter to publish).
-
Returns:
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
reset
-
name
Parameters:
-
name
StringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
A reference to the host object.
save
-
[options]
-
[callback]
sync()
method to perform the actual save
operation, which is an asynchronous action. Specify a _callback_ function to
be notified of success or failure.
A successful save operation will fire a save
event, while an unsuccessful
save operation will fire an error
event with the src
value "save".
If the save operation succeeds and one or more of the attributes returned in
the server's response differ from this model's current attributes, a
change
event will be fired.
Parameters:
-
[options]
Object optionalOptions to be passed tosync()
and toset()
when setting synced attributes. It's up to the custom sync implementation to determine what options it supports or requires, if any. -
[callback]
Function optionalCalled when the sync operation finishes.-
err
Error | NullIf an error occurred or validation failed, this parameter will contain the error. If the sync operation succeeded, err will be
null
. -
response
AnyThe server's response. This value will be passed to the
parse()
method, which is expected to parse it and return an attribute hash.
-
set
-
name
-
value
-
[options]
error
event will be fired.
Use setAttrs()
to set multiple attributes at once.
Parameters:
-
name
StringAttribute name or object property path. -
value
AnyValue to set. -
[options]
Object optionalData to be mixed into the event facade of thechange
event(s) for these attributes.-
[silent=false]
Boolean optionalIf
true
, nochange
event will be fired.
-
Example:
model.set('foo', 'bar');
setAttrs
-
attributes
-
[options]
error
event will be fired.
Parameters:
-
attributes
ObjectHash of attribute names and values to set. -
[options]
Object optionalData to be mixed into the event facade of thechange
event(s) for these attributes.-
[silent=false]
Boolean optionalIf
true
, nochange
event will be fired.
-
Example:
model.setAttrs({
foo: 'bar',
baz: 'quux'
});
subscribe
()
deprecated
sync
-
action
-
[options]
-
[callback]
load()
, save()
, and destroy()
, and
their implementations rely on the callback being called. This effectively
means that when a callback is provided, it must be called at some point for
the class to operate correctly.
Parameters:
-
action
StringSync action to perform. May be one of the following: *create
: Store a newly-created model for the first time. *delete
: Delete an existing model. *read
: Load an existing model. *update
: Update an existing model. -
[options]
Object optionalSync options. It's up to the custom sync implementation to determine what options it supports or requires, if any. -
[callback]
Function optionalCalled when the sync operation finishes.-
err
Error | NullIf an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
-
[response]
Any optionalThe server's response.
-
toJSON
()
Object
Y.JSON.stringify()
or used for other nefarious purposes.
The clientId
attribute is not included in the returned object.
If you've specified a custom attribute name in the idAttribute
property,
the default id
attribute will not be included in the returned object.
Note: The ECMAScript 5 specification states that objects may implement a
toJSON
method to provide an alternate object representation to serialize
when passed to JSON.stringify(obj)
. This allows class instances to be
serialized as if they were plain objects. This is why Model's toJSON
returns an object, not a JSON string.
See Returns:
toString
()
String
Returns:
undo
-
[attrNames]
-
[options]
undo()
is called when no previous state is available,
it will simply do nothing.
Parameters:
-
[attrNames]
String optionalArray of specific attribute names to revert. If not specified, all attributes modified in the last change will be reverted. -
[options]
Object optionalData to be mixed into the event facade of the change event(s) for these attributes.-
[silent=false]
Boolean optionalIf
true
, nochange
event will be fired.
-
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
validate
-
attrs
-
callback
save()
takes any action. If validation fails, the save()
call
will be aborted.
In your validation method, call the provided callback
function with no
arguments to indicate success. To indicate failure, pass a single argument,
which may contain an error message, an array of error messages, or any other
value. This value will be passed along to the error
event.
Parameters:
-
attrs
ObjectAttribute hash containing all model attributes to be validated. -
callback
FunctionValidation callback. Call this function when your validation logic finishes. To trigger a validation failure, pass any value as the first argument to the callback (ideally a meaningful validation error of some kind).-
[err]
Any optionalValidation error. Don't provide this argument if validation succeeds. If validation fails, set this to an error message or some other meaningful value. It will be passed along to the resulting
error
event.
-
Example:
model.validate = function (attrs, callback) {
if (attrs.pie !== true) {
// No pie?! Invalid!
callback('Must provide pie.');
return;
}
// Success!
callback();
};
Properties
_allowAdHocAttrs
Boolean
protected
Y.Base
that it should create ad-hoc attributes for config
properties passed to Model's constructor. This makes it possible to
instantiate a model and set a bunch of attributes without having to subclass
Y.Model
and declare all those attributes first.
Default: true
_isYUIModel
Boolean
protected
instanceof
, which won't work when the instance was created in another
window or YUI sandbox.
Default: true
changed
Object
Default: {}
idAttribute
String
id
, but if your persistence layer uses a different name for
the primary key (such as _id
or uid
), you can specify that here.
The built-in id
attribute will always be an alias for whatever attribute
name you specify here, so getting and setting id
will always behave the
same as getting and setting your custom id attribute.
Default: `'id'`
lastChange
Object
change
event. Each item
in this hash is an object with the following properties:
* newVal
: The new value of the attribute after it changed.
* prevVal
: The old value of the attribute before it changed.
* src
: The source of the change, or null
if no source was specified.
Default: {}
lists
ModelList[]
ModelList
instances that contain this model.
When a model is in one or more lists, the model's events will bubble up to
those lists. You can subscribe to a model event on a list to be notified
when any model in the list fires that event.
This property is updated automatically when this model is added to or
removed from a ModelList
instance. You shouldn't alter it manually. When
working with models in a list, you should always add and remove models using
the list's add()
and remove()
methods.
Default: `[]`
Example:
Subscribing to model events on a list:
// Assuming list
is an existing Y.ModelList instance.
list.on('*:change', function (e) {
// This function will be called whenever any model in the list
// fires a change
event.
//
// e.target
will refer to the model instance that fired the
// event.
});
name
String
deprecated
Attributes
clientId
String
readonly
id
attribute, clientId
may be used to retrieve model
instances from lists. Unlike the id
attribute, clientId
is
automatically generated, and is only intended to be used on the client
during the current pageview.
destroyed
Boolean
readonly
Default: false
id
String | Number | Null
id
attribute (for example, maybe you'd rather use _id
or uid
as the primary id), you may set the idAttribute
property to
the name of your custom id attribute. The id
attribute will then
act as an alias for your custom attribute.
Default: `null`
identifier
required
The identifier of the notification. It is used as the id
of the
notification so that it's possible to change the attributes of
the notification.
initialized
Boolean
readonly
Default: false
state
String | Null
The state of the notification. This state is used to generate and set a state class on the container of the eZ.NotifcationView.
Default: null
timeout
Number
The duration in second after which the notification should disappear. Zero means the notification should not automatically disappear.
Default: 0
Events
change
Event Payload:
-
changed
ObjectHash of change information for each attribute that changed. Each item in the hash has the following properties:-
newVal
AnyNew value of the attribute.
-
prevVal
AnyPrevious value of the attribute.
-
src
String | NullSource of the change event, if any.
-
destroy
Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
Event Payload:
-
e
EventFacadeEvent object
error
Event Payload:
-
error
AnyError message, object, or exception generated by the error. CallingtoString()
on this should result in a meaningful error message. -
src
StringSource of the error. May be one of the following (or any custom error source defined by a Model subclass): *load
: An error loading the model from a sync layer. The sync layer's response (if any) will be provided as theresponse
property on the event facade. *parse
: An error parsing a JSON response. The response in question will be provided as theresponse
property on the event facade. *save
: An error saving the model to a sync layer. The sync layer's response (if any) will be provided as theresponse
property on the event facade. *validate
: The model failed to validate. The attributes being validated will be provided as theattributes
property on the event facade.
init
Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
Event Payload:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
load
Event Payload:
-
parsed
ObjectThe parsed version of the sync layer's response to the load request. -
response
AnyThe sync layer's raw, unparsed response to the load request.
save
Event Payload:
-
[parsed]
Object optionalThe parsed version of the sync layer's response to the save request, if there was a response. -
[response]
Any optionalThe sync layer's raw, unparsed response to the save request, if there was one.