platformx 0.0.7 → 0.0.8

data/lib/platformx/form.rb

@@ -1,15 +1,18 @@
 module Platformx
 	module FormHelpers
-########################################################
-# 
-# Start Helpers
-#
-########################################################
-########################################################
-#
-# Checkbox helper
-#
-########################################################
+
+# View helper to generate check box
+# @param id [String] the checkbox id attribute
+# @param name [String] the checkbox name attribute
+# @param value [String] the checkbox value
+# @param label [String] the checkbox label
+# @param checked [Boolean] if the checkbox is checked
+# @param switch [Boolean] if the checkbox is a switch
+# @param align [String] if the alignment should be left or right
+# @param inline [Boolean] if the element is inline
+# @param form_group [Boolean] if a form group
+# @param required [Boolean] if required or not
+# @return [String] Compiled html checkbox
 def x_checkbox(id: "", name: "", value: "", label: "", checked: false, switch: false, align: false, inline: false, form_group: true, required: false)
 
 checked_output = ""
@@ -44,11 +47,18 @@ EOS
     return cb
 end
 
-########################################################
-#
-# Checkbox helper
-#
-########################################################
+# Check box helper
+# @param id [String] the checkbox id
+# @param name [String] the name attribute of the checkbox
+# @param value [String] the checkbox value
+# @param label [String] the label text of the checkbox
+# @param checked [Boolean] if the checkbox is checked
+# @param switch [Boolean] if the checkbox is a switchery input
+# @param align [String] if the check box aligned 'left' or 'right'
+# @param inline [Boolean] if the checkbox is inline or not
+# @param form_group [Boolean] if the checkbox is of form group
+# @param required [Boolean] if checkbox is required
+# @return [String] the compiled checkbox
 def x_checkbox_string(id: "", name: "", value: "", label: "", checked: false, switch: false, align: false, inline: false, form_group: true, required: false)
 
 checked_output = ""
@@ -83,11 +93,16 @@ EOS
 end
 
 
-########################################################
-#
-# Radio helper
-#
-########################################################
+# Radio button view helper
+# @param id [String] the radio id
+# @param name [String] the name attribute of the radio
+# @param value [String] the radio value
+# @param label [String] the label text of the radio
+# @param checked [Boolean] if the radio is checked
+# @param align [String] if the check box aligned 'left' or 'right'
+# @param inline [Boolean] if the radio is inline or not
+# @param form_group [Boolean] if the radio is of form group
+# @return [String] the compiled radio
 def x_radio(id: "", name: "", value: "", label: "", checked: false,  align: false, inline: false, form_group: true)
 
 checked_output = ""
@@ -116,11 +131,11 @@ EOS
     return cb
 end
 
-########################################################
-#
 # Hidden input helper
-#
-########################################################
+# @param id [String] hidden input id
+# @param name [String] hidden input name
+# @param value [String] hidden input value
+# @return [String] compiled hidden input html
 def x_hidden(id: "", name: "", value: "")
 
 hi = <<EOS
@@ -130,11 +145,16 @@ EOS
 end
 
 
-########################################################
-#
 # Text input helper
-#
-########################################################
+# @param id [String] input element id
+# @param name [String] input element name
+# @param value [String] input element value
+# @param label [String] input element label
+# @param required [Boolean] if input element is required
+# @param placeholder [String] input element placeholder
+# @param mask [String] input element mask
+# @param maxlength [String] input element max length
+# @return [String] compiled input element
 def x_input(id: "", name: "", value: "", label: "", required: false, placeholder: "", mask: "", maxlength: "")
 
     id = name unless id != ""
@@ -172,11 +192,15 @@ EOS
 end
 
 
-########################################################
-#
 # Money input helper
-#
-########################################################
+# @param id [String] the money input id
+# @param name [String] the money input name
+# @param label [String] the money input label
+# @param required [Boolean] if money input is required or not
+# @param placeholder [String] the moeny input placeholder
+# @param mask [String] the money input mask
+# @param maxlength [String] max length of the input
+# @return [String] compiled money input html
 def x_money(id: "", name: "", value: "", label: "", required: false, placeholder: "", mask: "", maxlength: "")
 
     id = name unless id != ""
@@ -216,11 +240,15 @@ EOS
     return tb
 end
 
-########################################################
-#
 # Percentage input helper
-#
-########################################################
+# @param id [String] percentage input id
+# @param name [String] percentage input name
+# @param value [String] percentage input value
+# @param label [String] percentage input label
+# @param required [Boolean] if percentage input is required
+# @param placeholder [String] percentage input placeholder
+# @param mask [String] percentage input mask
+# @param maxlength [String] percentage input maxlength
 def x_percentage(id: "", name: "", value: "", label: "", required: false, placeholder: "", mask: "", maxlength: "")
 
     id = name unless id != ""
@@ -260,11 +288,16 @@ EOS
     return tb
 end
 
-########################################################
-#
-# Number input helper
-#
-########################################################
+  # Number input helper
+  # @param id [String] number input id
+  # @param name [String] number input name
+  # @param value [String] number input value
+  # @param label [String] number input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] number input placeholder text
+  # @param mask [String] number input mask
+  # @param maxlength [String] nuber input max length
+  # @return [String] compiled html of number input
   def x_number(id: "", name: "", value: "", label: "", required: false, placeholder: "", mask: "", maxlength: "")
 
     if required 
@@ -302,11 +335,16 @@ EOS
 
 
 
-########################################################
-#
-# Phone input helper
-#
-########################################################
+  # Phone input helper
+  # @param id [String] phone input id
+  # @param name [String] phone input name
+  # @param value [String] phone input value
+  # @param label [String] phone input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] phone input placeholder text
+  # @param mask [String] phone input mask
+  # @param maxlength [String] nuber input max length
+  # @return [String] compiled html of phone input
   def x_phone(id: "", name: "", value: "", label: "", required: false, placeholder: "", mask: "(999) 999-9999", maxlength: "12")
 
     if required 
@@ -343,11 +381,16 @@ EOS
   end
 
 
-########################################################
-#
-# Number input helper
-#
-########################################################
+  # Credit card input helper
+  # @param id [String] credit card input id
+  # @param name [String] credit card input name
+  # @param value [String] credit card input value
+  # @param label [String] credit card label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] credit card input placeholder text
+  # @param mask [String] credit card input mask
+  # @param maxlength [String] nuber input max length
+  # @return [String] compiled html of credit card input
   def x_credit_card(id: "", name: "", value: "", label: "", required: false, placeholder: "", maxlength: "16", mask:"")
 
     if required 
@@ -383,11 +426,16 @@ EOS
     return tb
   end
 
-########################################################
-#
-# Number input helper
-#
-########################################################
+  # CVC input helper
+  # @param id [String] cvc input id
+  # @param name [String] cvc input name
+  # @param value [String] cvc input value
+  # @param lable [String] cvc label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] cvc input placeholder text
+  # @param mask [String] cvc input mask
+  # @param maxlength [String] nuber input max length
+  # @return [String] compiled html of cvc input
   def x_cvc(id: "", name: "", value: "", label: "", required: false, placeholder: "", maxlength: "4", mask:"999999999999999999")
 
     if required 
@@ -421,11 +469,15 @@ tb = <<EOS
 EOS
     return tb
   end
-########################################################
-#
-# Email input helper
-#
-########################################################
+
+  # Email input helper
+  # @param id [String] email input id
+  # @param name [String] email input name
+  # @param value [String] email input value
+  # @param label [String] email input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] email input placeholder text
+  # @return [String] compiled html of email input
   def x_email(id: "", name: "", value: "", label: "", required: false, placeholder: "")
 
     if required 
@@ -453,12 +505,14 @@ EOS
   end
 
 
-
-########################################################
-#
-# URL input helper
-#
-########################################################
+  # URL input helper
+  # @param id [String] url input id
+  # @param name [String] url input name
+  # @param value [String] url input value
+  # @param label [String] url input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] url input placeholder text
+  # @return [String] compiled html of url input
   def x_url(id:"", name:"", value:"", label:"", required: false, placeholder: "")
 
     if required 
@@ -485,11 +539,15 @@ EOS
     return tb
   end
 
-########################################################
-#
-# File input helper
-#
-########################################################
+  # File input helper
+  # @param id [String] file input id
+  # @param name [String] file input name
+  # @param value [String] file input value
+  # @param label [String] file input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] file input placeholder text
+  # @param css [String] file input css
+  # @return [String] compiled html of file input
   def x_file(id:"", name:"", value:"", label:"", required: false, placeholder: "", css: "")
 
     if required 
@@ -515,11 +573,15 @@ EOS
     return tb
   end
 
-########################################################
-#
 # Image Upload
-#
-########################################################
+# @param id [String] file input id
+# @param name [String] file input name
+# @param value [String] file input value
+# @param label [String] file input label
+# @param required [Boolean] if required or not
+# @param placeholder [String] file input placeholder text
+# @param css [String] file input css
+# @return [String] compiled html of file input
 def x_image_upload(id: "input1",name: "input1",value: "",label: "Input1",required: false, size: "1M",height: "",default: "")
 
 if required && label != ""
@@ -546,11 +608,14 @@ EOS
 return tb
 end
 
-########################################################
-#
-# Date input helper
-#
-########################################################
+  # Date input helper
+  # @param id [String] date input id
+  # @param name [String] date input name
+  # @param value [String] date input value
+  # @param label [String] date input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] date input placeholder text
+  # @return [String] compiled html of date input
   def x_date(id: "", name: "", value: "", label: "", required: false, placeholder: "")
 
     if required 
@@ -580,11 +645,14 @@ EOS
     return tb
   end
 
-########################################################
-#
-# Datetime input helper
-#
-########################################################
+  # Date-time input helper
+  # @param id [String] date-time input id
+  # @param name [String] date-time input name
+  # @param value [String] date-time input value
+  # @param label [String] date-time input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] date-time input placeholder text
+  # @return [String] compiled html of date-time input
   def x_datetime(id: "", name: "", value: "", label: "", required: false, placeholder: "")
 
     if required 
@@ -614,11 +682,14 @@ EOS
     return tb
   end
 
-########################################################
-#
-# Time input helper
-#
-########################################################
+  # Time input helper
+  # @param id [String] time input id
+  # @param name [String] time input name
+  # @param value [String] time input value
+  # @param label [String] time input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] time input placeholder text
+  # @return [String] compiled html of time input
   def x_time(id: "", name: "", value: "", label: "", required: false, placeholder: "")
 
     if required 
@@ -649,11 +720,14 @@ EOS
   end
 
 
-########################################################
-#
-# Password input helper
-#
-########################################################
+  # Password input helper
+  # @param id [String] password input id
+  # @param name [String] password input name
+  # @param value [String] password input value
+  # @param label [String] password input label
+  # @param required [Boolean] if required or not
+  # @param placeholder [String] password input placeholder text
+  # @return [String] compiled html of password input
   def x_password(id: "",name: "", value: "", label: "", required: false, placeholder: "")
 
     if required 
@@ -680,11 +754,13 @@ EOS
     return tb
   end
 
-########################################################
-#
 # Submit Helper
-#
-########################################################
+# @param label [String] submit button label
+# @param css [String] submit button css
+# @param icon [String] submit button icon
+# @param size [String] submit button size
+# @param wrapper_css [String] submit button wrapper css
+# @return [String] compiled html of submit button
 def x_submit(label: "Submit", css: "btn-primary", icon: "", size: "", wrapper_css: "pull-right")
 
  if icon != ""
@@ -703,11 +779,15 @@ end
 
 
 
-########################################################
-#
-# Text Area Helper
-#
-########################################################
+  # Text Area Helper
+  # @param id [String] textarea id
+  # @param name [String] textarea name
+  # @param value [String] textarea value
+  # @param placeholder [String] textarea placeholder text
+  # @param label [String] textarea label
+  # @param required [Boolean] if required or not
+  # @param maxlength [String] textarea max length
+  # @return [String] compiled html of textarea
   def x_textarea(id: "", name: "", value: "",label: "",placeholder: "",required: false, maxlength:"")
 
     if required 
@@ -743,11 +823,13 @@ EOS
     return ta
   end
 
-########################################################
-#
-# Summernote
-#
-########################################################
+  # Summernote
+  # @param id [String] summernote id
+  # @param name [String] summernote name
+  # @param value [String] summernote value
+  # @param label [String] summernote label
+  # @param required [Boolean] if required or not
+  # @return [String] compiled html of summernote
   def x_html(id: "", name: "", value: "", label: "", help: "", required: false)
 
     if required 
@@ -775,12 +857,7 @@ EOS
 
 
 
-########################################################
-#
 # Year Drop down
-#
-########################################################
-
 def x_year
   current_year = Time.now.year
   
@@ -799,12 +876,7 @@ EOS
 end
 
 
-########################################################
-#
-# Year Drop down
-#
-########################################################
-
+# Year Drop down (expiry)
 def x_exp_year
   current_year = Time.now.year
   begining_year = Time.now.year + 6
@@ -828,12 +900,7 @@ year_dd = <<EOS
 EOS
 end
 
-########################################################
-#
 # Month Drop down
-#
-########################################################
-
 def x_exp_month
   current_year = Time.now.year
   begining_year = Time.now.year - 6
@@ -861,11 +928,13 @@ year_dd = <<EOS
 EOS
 end
 
-########################################################
-#
 # Switch
-#
-########################################################
+# @param id [String] summernote id
+# @param name [String] summernote name
+# @param value [String] summernote value
+# @param label [String] summernote label
+# @param checked [Boolen] if checked or not
+# @return [String] compiled html of summernote
 def x_switch(id: "", name: "", value: "", label: "", checked: false)
 
 checked_output = ""
@@ -886,11 +955,14 @@ EOS
   return cb
 end
 
-########################################################
-#
 # Tags
-#
-########################################################
+# @param id [String] tags id
+# @param name [String] tags name
+# @param value [String] tags value
+# @param label [String] tags label
+# @param required [Boolean] if required or not
+# @param placeholder [String] tags placeholder text
+# @return [String] compiled html of tags
 def x_tags(id: "", name: "", value: "", label: "", required: false, placeholder: "")
 
     id = name unless id != ""
@@ -919,11 +991,15 @@ EOS
 end
 
 
-########################################################
-#
 # Typeahead
-#
-########################################################
+# @param id [String] typeahead id
+# @param name [String] typeahead name
+# @param value [String] typeahead value
+# @param label [String] typeahead label
+# @param required [Boolean] if required or not
+# @param placeholder [String] typeahead placeholder text
+# @param css [String] typeahead css
+# @return [String] compiled html of typeahead
 def x_typeahead(id: "", name: "", value: "", label: "", required: false, placeholder: "", css: "")
 
     id = name unless id != ""
@@ -952,11 +1028,10 @@ EOS
 end
 
 
-########################################################
-#
 # Rating Radios
-#
-########################################################
+# @param id [String] id of the survey radio
+# @param name [String] name of the survey radio
+# @return [String] compiled html of the survey radio
 def x_survey_radio(id: "", name: "")
 tb = <<EOS
   <label class="radio radio-inline">
@@ -985,11 +1060,23 @@ EOS
 end
 
 
-########################################################
-#
 # Select Dropdown
-#
-########################################################
+# @param id [String] id of the select
+# @param name [String] name of the select
+# @param value [String] value of the select
+# @param name_col [String] name col of the select
+# @param value_col [String] vale col of the select
+# @param label [String] label of the select
+# @param css [String] css of the select
+# @param menu_style [String] menu syle of the select
+# @param style [String] style classes of the select
+# @param option_data [String] option data
+# @param option_name [String] option name
+# @param option_value [String] option value
+# @param selected_value [String] selected value of the select
+# @param title [String] title of the select
+# @param multple [Boolean] if multiple selection is enabled
+# @return [String] compiled select drop down
 def x_select(id: "", name: "", value: "",name_col: "name", value_col: "id", label: "", css: "", menu_style: "dropdown-blue", style: "btn-default btn-block", option_data: "", option_name: "name", option_value: "id", selected_value: "", title: "", multiple: false)
 
 options_html = ""
@@ -1041,10 +1128,5 @@ EOS
   return select
 
 end
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end