Newscoop 3 Cookbook

Action check on form submission

Edit Subscription Action

The edit_subscription_action object is initialized when a subscription form was submitted. It has the following properties:

  • defined: true if a subscription submit action took place
  • is_error: true if a subscription submit action took place and the result was an error
  • error_code: error code of the subscription submit action; null if no subscription submit action took place
  • error_message: error message of the subscription submit action; null if no subscription submit action took place
  • ok: true if a subscription submit action took place and the result was success
  • is_trial: true if the submitted subscription type was trial
  • is_paid: true if the submitted subscription type was paid subscription

Edit User Action

The edit_user_action object is initialized when a user add/edit form was submitted. It has the following properties:

  • defined: true if a user data submit action took place
  • is_error: true if a user data submit action took place and the result was an error
  • error_code: error code of the user data submit action; null if no user data submit action took place
  • error_message: error message of the user data submit action; null if no user data submit action took place
  • ok: true if a user data submit action took place and the result was success
  • type: can take one of the following two values: "add" for user add submit, "edit" for an existing user data edit submit
  • name: the user full name as filled in the form
  • uname: the user login name as filled in the form
  • password: the account password as filled in the form
  • passwordagain: the password confirmation
  • email: the user email as filled in the form
  • city
  • str_address
  • state
  • phone
  • fax
  • contact
  • second_phone
  • postal_code
  • employer
  • position
  • interests
  • how
  • languages
  • improvements
  • field1
  • field2
  • field3
  • field4
  • field5
  • text1
  • text2
  • text3
  • country
  • title
  • gender
  • age
  • employertype
  • pref1
  • pref2
  • pref3
  • pref4

Login Action

The login_action object is defined when a login action takes place. It has the following properties:

  • defined: true if a login action took place
  • is_error: true if a login action took place and the result was an error
  • error_code: error code of the login action; null if no login action took place
  • error_message: error message of the login action; null if no login action took place
  • ok: true if a login action took place and the result was successful
  • user_name: the login name of the user that attempted to log in
  • remember_user: true if the remember user flag was set in the login form

Preview Comment Action

The preview_comment_action object is initialized when the preview button is clicked on a comment form. It has the following properties:

  • defined: true if a comment preview action took place
  • is_error: true if a comment preview action took place and the result was an error
  • error_code: error code of the comment preview action; null if no comment preview action took place
  • error_message: error message of the comment preview action; null if no comment preview action took place
  • ok: true if a comment preview action took place and the result was successful
  • subject: the comment subject as filled in the form
  • content: the comment content as filled in the form
  • reader_email: the comment reader email as filled in the form

Search Articles Action

The seararticles_action object is initialized when a search action takes place. It has the following properties:

  • defined: true if a search action took place
  • is_error: true if a search action took place and the result was an error
  • error_code: error code of the search action; null if no search action took place
  • error_message: error message of the search action; null if no search action took place
  • ok: true if a search action took place and the result was successful
  • searphrase: the phrase for which the search was performed
  • searkeywords: an array of keywords for which the search was performed
  • matall: true if the match all flag was set
  • searlevel: 0 for multiple publication search, 1 for current publication search, 2 for current issue search, 3 for current section search
  • submit_button: the submit button text
  • template: the template used on search form submission

Submit Comment Action

The submit_comment_action object is initialized when a comment form is submitted. It has the following properties:

  • defined: true if a comment submit action took place
  • is_error: true if a comment submit action took place and the result was an error
  • error_code: error code of the comment submit action; null if no comment submit action took place
  • error_message: error message of the comment submit action; null if no comment submit action took place
  • ok: true if a comment submit action took place and the result was successful
  • subject: the comment subject as filled in the form
  • content: the comment content as filled in the form
  • reader_email: the comment reader email as filled in the form