You are here

Home » API reference » Ubercart 8.4

uc_store.schema.yml in Ubercart 8.4

uc_store/config/schema/uc_store.schema.yml

File

uc_store/config/schema/uc_store.schema.yml
View source 
  1. # Schema for the configuration files of the Store module.

  2. 

  3. uc_store.settings:

  4.   type: config_object

  5.   label: 'Store settings'

  6.   mapping:

  7.     name:

  8.       type: string

  9.       label: 'The store name'

  10.     mail:

  11.       type: email

  12.       label: 'The store e-mail address'

  13.     mail_include_name:

  14.       type: boolean

  15.       label: 'Whether to include the store name as part of the From: e-mail address'

  16.     phone:

  17.       type: string

  18.       label: 'The store telephone number'

  19.     fax:

  20.       type: string

  21.       label: 'The store fax number'

  22.     help_page:

  23.       type: uri

  24.       label: ''

  25.     address:

  26.       type: mapping

  27.       label: 'The store mailing address'

  28.       mapping:

  29.         first_name:

  30.           type: string

  31.           label: 'The mailing address first name'

  32.         last_name:

  33.           type: string

  34.           label: 'The mailing address last name'

  35.         company:

  36.           type: string

  37.           label: 'The mailing address company'

  38.         street1:

  39.           type: string

  40.           label: 'The mailing address street, line 1'

  41.         street2:

  42.           type: string

  43.           label: 'The mailing address street, line 2'

  44.         city:

  45.           type: string

  46.           label: 'The mailing address city'

  47.         zone:

  48.           type: string

  49.           label: 'The mailing address zone'

  50.         country:

  51.           type: string

  52.           label: 'The mailing address country'

  53.         postal_code:

  54.           type: string

  55.           label: 'The mailing address postal code'

  56.         phone:

  57.           type: string

  58.           label: 'Telephone number'

  59.         email:

  60.           type: email

  61.           label: 'Email address'

  62.     address_fields:

  63.       type: mapping

  64.       label: 'Fields to collect for customer addresses'

  65.       mapping:

  66.         first_name:

  67.           type: mapping

  68.           label: 'First name'

  69.           mapping:

  70.             required:

  71.               type: boolean

  72.               label: 'Required'

  73.             status:

  74.               type: boolean

  75.               label: 'Enabled'

  76.             weight:

  77.               type: integer

  78.               label: 'Listing weight'

  79.         last_name:

  80.           type: mapping

  81.           label: 'Last name'

  82.           mapping:

  83.             required:

  84.               type: boolean

  85.               label: 'Required'

  86.             status:

  87.               type: boolean

  88.               label: 'Enabled'

  89.             weight:

  90.               type: integer

  91.               label: 'Listing weight'

  92.         company:

  93.           type: mapping

  94.           label: 'Company'

  95.           mapping:

  96.             required:

  97.               type: boolean

  98.               label: 'Required'

  99.             status:

  100.               type: boolean

  101.               label: 'Enabled'

  102.             weight:

  103.               type: integer

  104.               label: 'Listing weight'

  105.         street1:

  106.           type: mapping

  107.           label: 'Street address, line 1'

  108.           mapping:

  109.             required:

  110.               type: boolean

  111.               label: 'Required'

  112.             status:

  113.               type: boolean

  114.               label: 'Enabled'

  115.             weight:

  116.               type: integer

  117.               label: 'Listing weight'

  118.         street2:

  119.           type: mapping

  120.           label: 'Street address, line 2'

  121.           mapping:

  122.             required:

  123.               type: boolean

  124.               label: 'Required'

  125.             status:

  126.               type: boolean

  127.               label: 'Enabled'

  128.             weight:

  129.               type: integer

  130.               label: 'Listing weight'

  131.         city:

  132.           type: mapping

  133.           label: 'City'

  134.           mapping:

  135.             required:

  136.               type: boolean

  137.               label: 'Required'

  138.             status:

  139.               type: boolean

  140.               label: 'Enabled'

  141.             weight:

  142.               type: integer

  143.               label: 'Listing weight'

  144.         zone:

  145.           type: mapping

  146.           label: 'State/Province/Zone'

  147.           mapping:

  148.             required:

  149.               type: boolean

  150.               label: 'Required'

  151.             status:

  152.               type: boolean

  153.               label: 'Enabled'

  154.             weight:

  155.               type: integer

  156.               label: 'Listing weight'

  157.         country:

  158.           type: mapping

  159.           label: 'Country'

  160.           mapping:

  161.             required:

  162.               type: boolean

  163.               label: 'Required'

  164.             status:

  165.               type: boolean

  166.               label: 'Enabled'

  167.             weight:

  168.               type: integer

  169.               label: 'Listing weight'

  170.         postal_code:

  171.           type: mapping

  172.           label: 'Postal code'

  173.           mapping:

  174.             required:

  175.               type: boolean

  176.               label: 'Required'

  177.             status:

  178.               type: boolean

  179.               label: 'Enabled'

  180.             weight:

  181.               type: integer

  182.               label: 'Listing weight'

  183.         phone:

  184.           type: mapping

  185.           label: 'Telephone number'

  186.           mapping:

  187.             required:

  188.               type: boolean

  189.               label: 'Required'

  190.             status:

  191.               type: boolean

  192.               label: 'Enabled'

  193.             weight:

  194.               type: integer

  195.               label: 'Listing weight'

  196.     currency:

  197.       type: mapping

  198.       label: 'Currency display settings'

  199.       mapping:

  200.         code:

  201.           type: string

  202.           label: '3-character currency code'

  203.         symbol:

  204.           type: string

  205.           label: 'Currency symbol'

  206.         symbol_after:

  207.           type: boolean

  208.           label: 'Currency symbol position'

  209.         thousands_marker:

  210.           type: string

  211.           label: 'Currency thousands marker'

  212.         decimal_marker:

  213.           type: string

  214.           label: 'Currency decimal marker'

  215.         precision:

  216.           type: integer

  217.           label: 'Currency decimal places'

  218.     weight:

  219.       type: mapping

  220.       label: 'Weight display settings'

  221.       mapping:

  222.         units:

  223.           type: string

  224.           label: 'Default weight units'

  225.         thousands_marker:

  226.           type: string

  227.           label: 'Weight thousands marker'

  228.         decimal_marker:

  229.           type: string

  230.           label: 'Weight decimal marker'

  231.         precision:

  232.           type: integer

  233.           label: 'Weight decimal places'

  234.     length:

  235.       type: mapping

  236.       label: 'Length display settings'

  237.       mapping:

  238.         units:

  239.           type: string

  240.           label: 'Default length units'

  241.         thousands_marker:

  242.           type: string

  243.           label: 'Length thousands marker'

  244.         decimal_marker:

  245.           type: string

  246.           label: 'Length decimal marker'

  247.         precision:

  248.           type: integer

  249.           label: 'Length decimal places'

  250.     customer_address:

  251.       type: string

  252.       label: 'Address type to use'

  253.     capitalize_address:

  254.       type: boolean

  255.       label: 'Display address in all capital letters'

  256.     footer_message:

  257.       type: boolean

  258.       label: 'Display footer message'

  259. 

  260. block.settings.powered_by_ubercart:

  261.   type: block_settings

  262.   label: 'Branding block'

  263.   mapping:

  264.     message:

  265.       type: integer

  266.       label: 'Message to use'