What's a field pointer for the underlying CRUDify
What's a field pointer for the underlying CRUDify
Bridges from TheUserType to methods used in this class
The underlying record for the User
The underlying record for the User
Bridges from TheUserType to methods used in this class
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Insert this LocParam into your menu if you want the User's menu items to be inserted at the same level and after the item
replace the menu that has this LocParam with the User's menu items
Insert this LocParam into your menu if you want the User's menu items to be children of that menu
Override this method to do something else after the user signs up
Override this method to do something else after the user signs up
Append a DispatchPF function to LiftRules.
Append a DispatchPF function to LiftRules.dispatch. If the partial function id defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.
- a PartialFunction for associating a request with a user provided function and the proper Record
This method is used to cast the receiver object to be of type T0.
This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.
the receiver object.
Returns the JSON representation of inst record
Encode a record instance into a JValue
Encode a record instance into a JValue
Retuns the JSON representation of inst record, converts asJValue to JsObj
Retuns the JSON representation of inst record, converts asJValue to JsObj
a JsObj
This function is given a chance to log in a user programmatically when needed
This function is given a chance to log in a user programmatically when needed
Based on a FieldPointer, build a FieldPointerBridge
Based on a FieldPointer, build a FieldPointerBridge
If there's any state that you want to capture pre-login to be set post-login (the session is destroyed), then set the state here.
If there's any state that you want to capture pre-login to be set post-login (the session is destroyed), then set the state here. Just make a function that captures the state... that function will be applied post login.
The menu item for changing password (make this "Empty" to disable)
The menu item for changing password (make this "Empty" to disable)
The LocParams for the menu item for changing password.
The LocParams for the menu item for changing password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
Given a field pointer and an instance, get the field on that instance
Given a field pointer and an instance, get the field on that instance
Create a new instance of the User
Create a new instance of the User
Creates a new record
Creates a new record
The menu item for creating the user/sign up (make this "Empty" to disable)
The menu item for creating the user/sign up (make this "Empty" to disable)
The LocParams for the menu item for creating the user/sign up.
The LocParams for the menu item for creating the user/sign up. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Creates a new record setting the value of the fields from the original object but apply the new value for the specific field
Creates a new record setting the value of the fields from the original object but apply the new value for the specific field
By default, destroy the session on login.
By default, destroy the session on login. Change this is some of the session information needs to be preserved.
The list of fields presented to the user for editing
The list of fields presented to the user for editing
The menu item for editing the user (make this "Empty" to disable)
The menu item for editing the user (make this "Empty" to disable)
The LocParams for the menu item for editing the user.
The LocParams for the menu item for editing the user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x of type Any, x.equals(x) should return true.
* It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and
only if y.equals(x) returns true.
* It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and
y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects
that are "equal" (o1.equals(o2) returns true) hash to the same
scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Get a field by the field name
Get a field by the field name
-- the name of the field to get
Box[The Field] (Empty if the field is not found)
Defined the order of the fields in this record
Defined the order of the fields in this record
a List of Field
Obtain the fields for a particlar Record or subclass instance by passing the instance itself.
Obtain the fields for a particlar Record or subclass instance by passing the instance itself. (added 14th August 2009, Tim Perrett)
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
Given a unique id, find the user
Given a unique id, find the user
Given an username (probably email address), find the user
Given an username (probably email address), find the user
Set this to use your own form template when rendering a Record to a form.
Set this to use your own form template when rendering a Record to a form.
This template is any given XHtml that contains three nodes acting as placeholders such as:
<lift:field_label name="firstName"/> - the label for firstName field will be rendered here <lift:field name="firstName"/> - the firstName field will be rendered here (typically an input field) <lift:field_msg name="firstName"/> - the <lift:msg> will be rendered here hafing the id given by uniqueFieldId of the firstName field.
Example.
Having:
class MyRecord extends Record[MyRecord] {
def meta = MyRecordMeta
object firstName extends StringField(this, "John")
}
object MyRecordMeta extends MyRecord with MetaRecord[MyRecord] { override def mutable_? = false }
...
val rec = MyRecordMeta.createRecord.firstName("McLoud")
val template = <div> <div> <div><lift:field_label name="firstName"/></div> <div><lift:field name="firstName"/></div> <div><lift:field_msg name="firstName"/></div> </div> </div>
MyRecordMeta.formTemplate = Full(template) rec.toForm((r:MyRecord) => println(r));
Create a record with fields populated with values from the JSON construct
Create a record with fields populated with values from the JSON construct
- The stringified JSON object
Box[BaseRecord]
Create a record by decoding a JValue which must be a JObject
Create a record by decoding a JValue which must be a JObject
Create a record with fields populated with values from the JSON construct
Create a record with fields populated with values from the JSON construct
- The stringified JSON object
Box[BaseRecord]
Create a record with fields populated with values from the request
Create a record with fields populated with values from the request
the created record
Generate the mail bodies to send with the password reset link.
Generate the mail bodies to send with the password reset link. By default, just an HTML mail body is generated by calling passwordResetMailBody but you can send additional or alternative mail by overriding this method.
Generate the mail bodies to send with the valdiation link.
Generate the mail bodies to send with the valdiation link. By default, just an HTML mail body is generated by calling signupMailBody but you can send additional or alternative mail by override this method.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
Make a new record instance.
Make a new record instance. This method can be overridden to provide caching behavior or what have you.
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will
return true. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.
true if the receiver object is an instance of erasure of type T0; false otherwise.
The menu item for login (make this "Empty" to disable)
The menu item for login (make this "Empty" to disable)
The LocParams for the menu item for login.
The LocParams for the menu item for login. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Return the URL of the "login" page
Return the URL of the "login" page
The menu item for logout (make this "Empty" to disable)
The menu item for logout (make this "Empty" to disable)
The LocParams for the menu item for logout.
The LocParams for the menu item for logout. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
The menu item for lost password (make this "Empty" to disable)
The menu item for lost password (make this "Empty" to disable)
The LocParams for the menu item for lost password.
The LocParams for the menu item for lost password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
An alias for the sitemap property
An alias for the sitemap property
Renamed from fields() due to a clash with fields() in Record.
Renamed from fields() due to a clash with fields() in Record. Use this method to obtain a list of fields defined in the meta companion objects. Possibly a breaking change? (added 14th August 2009, Tim Perrett)
Record
Specifies if this Record is mutable or not
Specifies if this Record is mutable or not
If there's any mutation to do to the user on retrieval for editting, override this method and mutate the user.
If there's any mutation to do to the user on retrieval for editting, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. Issue #722
the user to mutate
the mutated user
If there's any mutation to do to the user on creation for signup, override this method and mutate the user.
If there's any mutation to do to the user on creation for signup, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. . Issue #722
the user to mutate
the mutated user
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
Get a nice name for the user
Get a nice name for the user
Get an email link for the user
Get an email link for the user
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Prepend a DispatchPF function to LiftRules.
Prepend a DispatchPF function to LiftRules.dispatch. If the partial function id defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.
- a PartialFunction for associating a request with a user provided function and the proper Record
The menu item for resetting the password (make this "Empty" to disable)
The menu item for resetting the password (make this "Empty" to disable)
The LocParams for the menu item for resetting the password.
The LocParams for the menu item for resetting the password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
What template are you going to wrap the various nodes in
What template are you going to wrap the various nodes in
Send password reset email to the user.
Send password reset email to the user. The XHTML version of the mail body is generated by calling passwordResetMailBody. You can customize the mail sent to users by overriding generateResetEmailBodies to send non-HTML mail or alternative mail bodies.
Send validation email to the user.
Send validation email to the user. The XHTML version of the mail body is generated by calling signupMailBody. You can customize the mail sent to users by override generateValidationEmailBodies to send non-HTML mail or alternative mail bodies.
Populate the fields of the record instance with values from the JSON construct
Populate the fields of the record instance with values from the JSON construct
- The record to populate
- The stringified JSON object
- Full(()) on success, other on failure
Attempt to decode a JValue, which must be a JObject, into a record instance
Attempt to decode a JValue, which must be a JObject, into a record instance
Set from a Json String using the lift-json parser *
Set from a Json String using the lift-json parser *
Populate the fields of the record with values from the request
Populate the fields of the record with values from the request
- The record to populate
- The Req to read from
Get a nice name for the user
Get a nice name for the user
The list of fields presented to the user at sign-up
The list of fields presented to the user at sign-up
The SiteMap mutator function
The SiteMap mutator function
Is there a user logged in and are they a superUser?
Is there a user logged in and are they a superUser?
Returns the XHTML representation of inst Record.
Returns the XHTML representation of inst Record. You must provide the Node template to represent this record in the proprietary layout.
- the record to be rendered
- The markup template forthe form. See also the formTemplate variable
the XHTML content as a NodeSeq
Returns the XHTML representation of inst Record.
Returns the XHTML representation of inst Record. If formTemplate is set, this template will be used otherwise a default template is considered.
- the record to be rendered
the XHTML content as a NodeSeq
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
Returns the HTML representation of inst Record.
Returns the HTML representation of inst Record.
- th designated Record
a NodeSeq
Convert an instance of TheUserType to the Bridge trait
Convert an instance of TheUserType to the Bridge trait
Given a String representing the User ID, find the user
Given a String representing the User ID, find the user
How do we prompt the user for the username.
How do we prompt the user for the username. By default, it's S.??("email.address"), you can can change it to something else
The string that's generated when the user name is not found.
The string that's generated when the user name is not found. By default: S.??("email.address.not.found")
Validates the inst Record by calling validators for each field
Validates the inst Record by calling validators for each field
a List of FieldError. If this list is empty you can assume that record was validated successfully
Override this method to validate the user signup (eg by adding captcha verification)
Override this method to validate the user signup (eg by adding captcha verification)
The menu item for validating a user (make this "Empty" to disable)
The menu item for validating a user (make this "Empty" to disable)
The LocParams for the menu item for validating a user.
The LocParams for the menu item for validating a user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Mix this trait into the the Mapper singleton for User and you get a bunch of user functionality including password reset, etc.