www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/config/schema/views.data_types.schema.yml

   1 # Basic data types for views.
   2
   3 views_display:
   4   type: mapping
   5   label: 'Display options'
   6   mapping:
   7     enabled:
   8       type: boolean
   9       label: 'Status'
  10     title:
  11       type: text
  12       label: 'Display title'
  13     format:
  14       type: string
  15       label: 'Format'
  16     fields:
  17       type: sequence
  18       label: 'Fields'
  19       sequence:
  20         type: views.field.[plugin_id]
  21     pager:
  22       type: mapping
  23       label: 'Pager'
  24       mapping:
  25         type:
  26           type: string
  27           label: 'Pager type'
  28         options:
  29           type: views.pager.[%parent.type]
  30     exposed_form:
  31       type: mapping
  32       label: 'Exposed form'
  33       mapping:
  34         type:
  35           type: string
  36           label: 'Exposed form type'
  37         options:
  38           label: 'Options'
  39           type: views.exposed_form.[%parent.type]
  40     access:
  41       type: mapping
  42       label: 'Access'
  43       mapping:
  44         type:
  45           type: string
  46           label: 'Access type'
  47         options:
  48           type: views.access.[%parent.type]
  49     cache:
  50       type: views.cache.[type]
  51     empty:
  52       type: sequence
  53       label: 'No results behavior'
  54       sequence:
  55         type: views.area.[plugin_id]
  56     sorts:
  57       type: sequence
  58       label: 'Sorts'
  59       sequence:
  60         type: views.sort.[plugin_id]
  61     arguments:
  62       type: sequence
  63       label: 'Arguments'
  64       sequence:
  65         type: views.argument.[plugin_id]
  66     filters:
  67       type: sequence
  68       label: 'Filters'
  69       sequence:
  70         type: views.filter.[plugin_id]
  71     filter_groups:
  72       type: mapping
  73       label: 'Groups'
  74       mapping:
  75         operator:
  76           type: string
  77           label: 'Operator'
  78         groups:
  79           type: sequence
  80           label: 'Groups'
  81           sequence:
  82             type: string
  83             label: 'Operator'
  84     style:
  85       type: mapping
  86       label: 'Format'
  87       mapping:
  88         type:
  89           type: string
  90           label: 'Type'
  91         options:
  92           type: views.style.[%parent.type]
  93     row:
  94       type: mapping
  95       label: 'Row'
  96       mapping:
  97         type:
  98           type: string
  99           label: 'Row type'
 100         options:
 101           type: views.row.[%parent.type]
 102     query:
 103       type: mapping
 104       label: 'Query'
 105       mapping:
 106         type:
 107           type: string
 108           label: 'Query type'
 109         options:
 110           type: views.query.[%parent.type]
 111     defaults:
 112       type: mapping
 113       label: 'Defaults'
 114       mapping:
 115         empty:
 116           type: boolean
 117           label: 'Empty'
 118         access:
 119           type: boolean
 120           label: 'Access restrictions'
 121         cache:
 122           type: boolean
 123           label: 'Caching'
 124         query:
 125           type: boolean
 126           label: 'Query options'
 127         title:
 128           type: boolean
 129           label: 'Title'
 130         css_class:
 131           type: boolean
 132           label: 'CSS class'
 133         display_description:
 134           type: boolean
 135           label: 'Administrative description'
 136         use_ajax:
 137           type: boolean
 138           label: 'Use AJAX'
 139         hide_attachment_summary:
 140           type: boolean
 141           label: 'Hide attachments when displaying a contextual filter summary'
 142         show_admin_links:
 143           type: boolean
 144           label: 'Show contextual links'
 145         pager:
 146           type: boolean
 147           label: 'Use pager'
 148         use_more:
 149           type: boolean
 150           label: 'Create more link'
 151         use_more_always:
 152           type: boolean
 153           label: 'Display ''more'' link only if there is more content'
 154         use_more_text:
 155           type: boolean
 156           label: 'The text to display for the more link.'
 157         exposed_form:
 158           type: boolean
 159           label: 'Exposed form style'
 160         link_display:
 161           type: boolean
 162           label: 'Link display'
 163         link_url:
 164           type: boolean
 165           label: 'Link URL'
 166         group_by:
 167           type: boolean
 168           label: 'Aggregate'
 169         style:
 170           type: boolean
 171           label: 'Style'
 172         row:
 173           type: boolean
 174           label: 'Row'
 175         relationships:
 176           type: boolean
 177           label: 'Relationships'
 178         fields:
 179           type: boolean
 180           label: 'Fields'
 181         sorts:
 182           type: boolean
 183           label: 'Sorts'
 184         arguments:
 185           type: boolean
 186           label: 'Arguments'
 187         filters:
 188           type: boolean
 189           label: 'Filters'
 190         filter_groups:
 191           type: boolean
 192           label: 'Filter groups'
 193         header:
 194           type: boolean
 195           label: 'Header'
 196         footer:
 197           type: boolean
 198           label: 'Footer'
 199     relationships:
 200       type: sequence
 201       label: 'Relationships'
 202       sequence:
 203         type: views.relationship.[plugin_id]
 204     css_class:
 205       type: string
 206       label: 'CSS class'
 207     use_ajax:
 208       type: boolean
 209       label: 'Use AJAX'
 210     group_by:
 211       type: boolean
 212       label: 'Aggregate'
 213     display_description:
 214       type: label
 215       label: 'Administrative description'
 216     show_admin_links:
 217       type: boolean
 218       label: 'Show contextual links'
 219     use_more:
 220       type: boolean
 221       label: 'Create more link'
 222     use_more_always:
 223       type: boolean
 224       label: 'Display ''more'' link only if there is more content'
 225     use_more_text:
 226       type: label
 227       label: 'The text to display for the more link.'
 228     link_display:
 229       type: string
 230       label: 'Link display'
 231     link_url:
 232       type: string
 233       label: 'Link URL'
 234     header:
 235       type: sequence
 236       label: 'Header'
 237       sequence:
 238         type: views.area.[plugin_id]
 239     footer:
 240       type: sequence
 241       label: 'Footer'
 242       sequence:
 243         type: views.area.[plugin_id]
 244     display_comment:
 245       type: label
 246       label: 'Display comment'
 247     hide_attachment_summary:
 248       type: boolean
 249       label: 'Hide attachments in summary'
 250     rendering_language:
 251       type: string
 252       label: 'Entity language'
 253     exposed_block:
 254       type: boolean
 255       label: 'Put the exposed form in a block'
 256     display_extenders:
 257       type: sequence
 258       label: 'Display extenders'
 259       sequence:
 260         type: views.display_extender.[%key]
 261
 262 views_sort:
 263   type: views_handler
 264   label: 'Sort criteria'
 265   mapping:
 266     order:
 267       type: string
 268       label: 'Sort order'
 269     expose:
 270       type: views.sort_expose.[%parent.plugin_id]
 271     exposed:
 272       type: boolean
 273       label: 'Expose this sort to visitors, to allow them to change it'
 274     plugin_id:
 275       type: string
 276       label: 'Plugin ID'
 277
 278 views_sort_expose:
 279   type: mapping
 280   mapping:
 281     label:
 282       type: label
 283       label: 'Label'
 284
 285 views_area:
 286   type: views_handler
 287   label: 'Area'
 288   mapping:
 289     label:
 290       type: label
 291       label: 'A string to identify the area instance in the admin UI.'
 292     empty:
 293       type: boolean
 294       label: 'Should the area be displayed on empty results.'
 295     plugin_id:
 296       type: string
 297       label: 'Plugin ID'
 298
 299 views_handler:
 300   type: mapping
 301   mapping:
 302     id:
 303       type: string
 304       label: 'A unique ID per handler type'
 305     table:
 306       type: string
 307       label: 'The views_data table for this handler'
 308     field:
 309       type: string
 310       label: 'The views_data field for this handler'
 311     relationship:
 312       type: string
 313       label: 'The ID of the relationship instance used by this handler'
 314     group_type:
 315       type: string
 316       label: 'A sql aggregation type'
 317     admin_label:
 318       type: label
 319       label: 'A string to identify the handler instance in the admin UI.'
 320     entity_type:
 321       type: string
 322       label: 'The entity type'
 323     entity_field:
 324       type: string
 325       label: 'The corresponding entity field'
 326     plugin_id:
 327       type: string
 328       label: 'The plugin ID'
 329
 330 views_argument:
 331   type: views_handler
 332   label: 'Argument'
 333   mapping:
 334     default_action:
 335       type: string
 336       label: 'When the filter value is NOT available'
 337     exception:
 338       type: mapping
 339       label: 'Exception value'
 340       mapping:
 341         value:
 342           type: string
 343           label: 'Value'
 344         title_enable:
 345           type: boolean
 346           label: 'Override title'
 347         title:
 348           type: label
 349           label: 'Title'
 350     title_enable:
 351       type: boolean
 352       label: 'Override title'
 353     title:
 354       type: label
 355       label: 'Overridden title'
 356     default_argument_type:
 357       type: string
 358       label: 'Type'
 359     default_argument_options:
 360       type: views.argument_default.[%parent.default_argument_type]
 361       label: 'Default argument options'
 362     default_argument_skip_url:
 363       type: boolean
 364       label: 'Skip default argument for view URL'
 365     summary_options:
 366       type: views.style.[%parent.summary.format]
 367       label: 'Summary options'
 368     summary:
 369       type: mapping
 370       label: 'Display a summary'
 371       mapping:
 372         sort_order:
 373           type: string
 374           label: 'Sort order'
 375         number_of_records:
 376           type: integer
 377           label: 'Sort by'
 378         format:
 379           type: string
 380           label: 'Format'
 381     specify_validation:
 382       type: boolean
 383       label: 'Specify validation criteria'
 384     validate:
 385       type: mapping
 386       label: 'Validation settings'
 387       mapping:
 388         type:
 389           type: string
 390           label: 'Validator'
 391         fail:
 392           type: string
 393           label: 'Action to take if filter value does not validate'
 394     validate_options:
 395       type: views.argument_validator.[%parent.validate.type]
 396       label: 'Validate options'
 397     glossary:
 398       type: boolean
 399       label: 'Glossary mode'
 400     limit:
 401       type: integer
 402       label: 'Character limit'
 403     case:
 404       type: string
 405       label: 'Case'
 406     path_case:
 407       type: string
 408       label: 'Case in path'
 409     transform_dash:
 410       type: boolean
 411       label: 'Transform spaces to dashes in URL'
 412     break_phrase:
 413       type: boolean
 414       label: 'Allow multiple values'
 415     plugin_id:
 416       type: string
 417       label: 'Plugin ID'
 418
 419 views_exposed_form:
 420   type: mapping
 421   mapping:
 422     submit_button:
 423       type: label
 424       label: 'Submit button text'
 425     reset_button:
 426       type: boolean
 427       label: 'Include reset button'
 428     reset_button_label:
 429       type: label
 430       label: 'Reset button label'
 431     exposed_sorts_label:
 432       type: label
 433       label: 'Exposed sorts label'
 434     expose_sort_order:
 435       type: boolean
 436       label: 'Expose sort order'
 437     sort_asc_label:
 438       type: label
 439       label: 'Ascending'
 440     sort_desc_label:
 441       type: label
 442       label: 'Descending'
 443
 444 views_field:
 445   type: views_handler
 446   mapping:
 447     label:
 448       type: label
 449       label: 'Create a label'
 450     exclude:
 451       type: boolean
 452       label: 'Exclude from display'
 453     alter:
 454       type: mapping
 455       label: 'Rewrite results'
 456       mapping:
 457         alter_text:
 458           type: boolean
 459           label: 'Override the output of this field with custom text'
 460         text:
 461           type: text
 462           label: 'Text'
 463         make_link:
 464           type: boolean
 465           label: 'Output this field as a custom link'
 466         path:
 467           type: string
 468           label: 'Link path'
 469         absolute:
 470           type: boolean
 471           label: 'Use absolute path'
 472         external:
 473           type: boolean
 474           label: 'External server URL'
 475         replace_spaces:
 476           type: boolean
 477           label: 'Replace spaces with dashes'
 478         path_case:
 479           type: string
 480           label: 'Transform the case'
 481         trim_whitespace:
 482           type: boolean
 483           label: 'Remove whitespace'
 484         alt:
 485           type: label
 486           label: 'Title text'
 487         rel:
 488           type: string
 489           label: 'Rel Text'
 490         link_class:
 491           type: string
 492           label: 'Link class'
 493         prefix:
 494           type: label
 495           label: 'Prefix text'
 496         suffix:
 497           type: label
 498           label: 'Suffix text'
 499         target:
 500           type: string
 501           label: 'Target'
 502         nl2br:
 503           type: boolean
 504           label: 'Convert newlines to HTML <br> tags'
 505         max_length:
 506           type: integer
 507           label: 'Maximum number of characters'
 508         word_boundary:
 509           type: boolean
 510           label: 'Trim only on a word boundary'
 511         ellipsis:
 512           type: boolean
 513           label: 'Add "…" at the end of trimmed text'
 514         more_link:
 515           type: boolean
 516           label: 'Add a read-more link if output is trimmed'
 517         more_link_text:
 518           type: label
 519           label: 'More link label'
 520         more_link_path:
 521           type: string
 522           label: 'More link path'
 523         strip_tags:
 524           type: boolean
 525           label: 'Strip HTML tags'
 526         trim:
 527           type: boolean
 528           label: 'Trim this field to a maximum number of characters'
 529         preserve_tags:
 530           type: string
 531           label: 'Preserve certain tags'
 532         html:
 533           type: boolean
 534           label: 'Field can contain HTML'
 535     element_type:
 536       type: string
 537       label: 'HTML element'
 538     element_class:
 539       type: string
 540       label: 'CSS class'
 541     element_label_type:
 542       type: string
 543       label: 'Label HTML element'
 544     element_label_class:
 545       type: string
 546       label: 'CSS class'
 547     element_label_colon:
 548       type: boolean
 549       label: 'Place a colon after the label'
 550     element_wrapper_type:
 551       type: string
 552       label: 'Wrapper HTML element'
 553     element_wrapper_class:
 554       type: string
 555       label: 'CSS class'
 556     element_default_classes:
 557       type: boolean
 558       label: 'Add default classes'
 559     empty:
 560       type: string
 561       label: 'No results text'
 562     hide_empty:
 563       type: boolean
 564       label: 'Hide if empty'
 565     empty_zero:
 566       type: boolean
 567       label: 'Count the number 0 as empty'
 568     hide_alter_empty:
 569       type: boolean
 570       label: 'Hide rewriting if empty'
 571     destination:
 572       type: boolean
 573       label: 'Append a destination query string to operation links.'
 574     plugin_id:
 575       type: string
 576       label: 'Plugin ID'
 577
 578 views_pager:
 579   type: mapping
 580   label: 'Pager'
 581   mapping:
 582     offset:
 583       type: integer
 584       label: 'Offset'
 585     items_per_page:
 586       type: integer
 587       label: 'Items per page'
 588
 589 views_pager_sql:
 590   type: views_pager
 591   label: 'SQL pager'
 592   mapping:
 593     items_per_page:
 594       type: integer
 595       label: 'Items per page'
 596     total_pages:
 597       type: integer
 598       label: 'Number of pages'
 599     id:
 600       type: integer
 601       label: 'Pager ID'
 602     tags:
 603       type: mapping
 604       label: 'Pager link labels'
 605       mapping:
 606         next:
 607           type: label
 608           label: 'Next page link text'
 609         previous:
 610           type: label
 611           label: 'Previous page link text'
 612         quantity:
 613           type: integer
 614           label: 'Number of pager links visible'
 615     expose:
 616       type: mapping
 617       label: 'Exposed options'
 618       mapping:
 619         items_per_page:
 620           type: boolean
 621           label: 'Items per page'
 622         items_per_page_label:
 623           type: label
 624           label: 'Items per page label'
 625         items_per_page_options:
 626           type: string
 627           label: 'Exposed items per page options'
 628         items_per_page_options_all:
 629           type: boolean
 630           label: 'Include all items option'
 631         items_per_page_options_all_label:
 632           type: label
 633           label: 'All items label'
 634         offset:
 635           type: boolean
 636           label: 'Expose Offset'
 637         offset_label:
 638           type: label
 639           label: 'Offset label'
 640
 641 views_style:
 642   type: mapping
 643   mapping:
 644     grouping:
 645       type: sequence
 646       label: 'Grouping field number %i'
 647       sequence:
 648         type: mapping
 649         label: 'Field'
 650         mapping:
 651           field:
 652             type: string
 653             label: 'Field'
 654           rendered:
 655             type: boolean
 656             label: 'Use rendered output to group rows'
 657           rendered_strip:
 658             type: boolean
 659             label: 'Remove tags from rendered output'
 660     row_class:
 661       type: string
 662       label: 'Row class'
 663     default_row_class:
 664       type: boolean
 665       label: 'Add views row classes'
 666     uses_fields:
 667       type: boolean
 668       label: 'Force using fields'
 669
 670 views_filter:
 671   type: views_handler
 672   mapping:
 673     operator:
 674       type: string
 675       label: 'Operator'
 676     value:
 677       type: views.filter_value.[%parent.plugin_id]
 678       label: 'Value'
 679     group:
 680       type: integer
 681       label: 'Group'
 682     exposed:
 683       type: boolean
 684       label: 'Expose this filter to visitors, to allow them to change it'
 685     expose:
 686       type: mapping
 687       label: 'Expose'
 688       mapping:
 689         operator_id:
 690           type: string
 691           label: 'Operator identifier'
 692         label:
 693           type: label
 694           label: 'Label'
 695         description:
 696           type: label
 697           label: 'Description'
 698         use_operator:
 699           type: boolean
 700           label: 'Expose operator'
 701         operator:
 702           type: string
 703           label: 'Operator'
 704         identifier:
 705           type: string
 706           label: 'Filter identifier'
 707         required:
 708           type: boolean
 709           label: 'Required'
 710         remember:
 711           type: boolean
 712           label: 'Remember the last selection'
 713         multiple:
 714           type: boolean
 715           label: 'Allow multiple selections'
 716         remember_roles:
 717           type: sequence
 718           label: 'User roles'
 719           sequence:
 720             type: string
 721             label: 'Role'
 722     is_grouped:
 723       type: boolean
 724       label: 'Grouped filters'
 725     group_info:
 726       type: mapping
 727       label: 'Group'
 728       mapping:
 729         label:
 730           type: label
 731           label: 'Label'
 732         description:
 733           type: label
 734           label: 'Description'
 735         identifier:
 736           type: string
 737           label: 'Identifier'
 738         optional:
 739           type: boolean
 740           label: 'Optional'
 741         widget:
 742           type: string
 743           label: 'Widget type'
 744         multiple:
 745           type: boolean
 746           label: 'Allow multiple selections'
 747         remember:
 748           type: boolean
 749           label: 'Remember'
 750         default_group:
 751           type: string
 752           label: 'Default'
 753         default_group_multiple:
 754           type: sequence
 755           label: 'Defaults'
 756           sequence:
 757             type: integer
 758             label: 'Default'
 759         group_items:
 760           type: sequence
 761           label: 'Group items'
 762           sequence:
 763             type: views.filter.group_item.[%parent.%parent.%parent.plugin_id]
 764             label: 'Group item'
 765     plugin_id:
 766       type: string
 767       label: 'Plugin ID'
 768
 769 views_filter_group_item:
 770   type: mapping
 771   label: 'Group item'
 772   mapping:
 773     title:
 774       type: label
 775       label: 'Label'
 776     operator:
 777       type: string
 778       label: 'Operator'
 779     value:
 780       type: views.filter_value.[%parent.%parent.%parent.%parent.plugin_id]
 781       label: 'Value'
 782
 783 views_relationship:
 784   type: views_handler
 785   mapping:
 786     admin_label:
 787       type: string
 788       label: 'Administrative title'
 789     required:
 790       type: boolean
 791       label: 'Require this relationship'
 792
 793 views_query:
 794   type: mapping
 795   label: 'Query options'
 796
 797 views_row:
 798   type: mapping
 799   label: 'Row options'
 800   mapping:
 801     relationship:
 802       type: string
 803       label: 'Relationship'
 804
 805 views_entity_row:
 806   type: views_row
 807   mapping:
 808     view_mode:
 809       type: string
 810       label: 'View mode'
 811
 812 views_cache:
 813   type: mapping
 814   label: 'Cache configuration'
 815   mapping:
 816     type:
 817       type: string
 818       label: 'Cache type'
 819
 820 views_display_extender:
 821   type: mapping
 822   label: 'Display extender settings'