ARK2/View - Revision history

John Layt: /* Tables */

2018-03-22T14:22:14Z

‎Tables

John Layt: /* Tables */

2018-03-22T14:14:58Z

‎Tables

John Layt: /* Tables */

2018-03-19T17:00:13Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:59:54Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:56:31Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:44:42Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:42:56Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:40:32Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:37:21Z

‎Tables

John Layt: /* Tables */

2018-03-19T16:35:37Z

‎Tables

@@ Line 72: / Line 72: @@
 | showCaption()
 | boolean
-| Whether to show the HTML5 <caption> element
+| Whether to show the HTML5 table caption element
 |-
 | header
 | showHeader()
 | boolean
-| Whether to show the HTML5 <thead> element
+| Whether to show the HTML5 table header element
 |-
 | footer
 | showFooter()
 | boolean
-| Whether to show the HTML5 <tfoot> element
+| Whether to show the HTML5 table footer element
 |-
 | sortable
 | isSortable()
 | boolean
+| Whether the table rows can be sorted
 |-
 | searchable
 | isSearchable()
 | boolean
+| Whether the table data is searchable
 |-
 | list
 | enableListView()
 | boolean
+| Whether the table list view is enabled
 |-
 | detail
 | enableDetailView()
 | boolean
+| Whether the table detail view is enabled
 |-
 | expand
 | enableExpandListView()
 | boolean
-| only if list and detail
+| Whether the table expand view is enabled (only if list and detail views are enabled)
 |-
 | card
 | enableCardView()
 | boolean
+| Whether the table card view is enabled
 |-
 | thumb
 | enableThumbnailView()
 | boolean
+| Whether the table thumbnail view is enabled
 |-
 | view
 | defaultView()
 | string
-| defaults to list, [list, card, thumb]
+| Which table view is the default view, choice of list, card, or thumb
 |-
 | image
 | image()
 | string
+| The data field to use for images, i.e. thumbnails
 |-
 | export
 | canExportData()
 | boolean
+| Whether the table data can be exported
 |-
 | columns
 | canChooseColumns()
 | boolean
+| Whether the table columns displayed can be selected
 |-
 | pagination
 | pagination(), pageSize()
 | boolean, integer
-| defaults to 10
+| The number of rows per page, defaults to 10
 |-
 | selection
 | selection()
 | string
+| Whether data rows can be selected
 |-
 | keyword
 | keyword()
 | string, ARK\Translation\Keyword
+| The translation keyword used for the table
 |-
 | classes
 | classes()
 | string
+| Any extra CSS classes to add to the table
 |-
 | template
 | template()
 | string
+| The TWIG template to use instead of the default table template
 |-
 | url
 | dataUrl()
 | string
+| The server-side pagination URL
 |-
 |}

@@ Line 72: / Line 72: @@
 | showCaption()
 | boolean
+| Whether to show the HTML5 <caption> element
 |-
 | header
 | showHeader()
 | boolean
+| Whether to show the HTML5 <thead> element
 |-
 | footer
 | showFooter()
 | boolean
+| Whether to show the HTML5 <tfoot> element
 |-
 | sortable

@@ Line 52: / Line 52: @@
 | id()
 | string
-| The ID of the Table element
+| The unique ID of the Table element
 |-
 | name

@@ Line 56: / Line 56: @@
 | name
 | name()
+| string
+|
 |-

@@ Line 66: / Line 66: @@
 | mode
 | mode()
+| boolean
+|
 |-
 | caption
+| showCaption()
+| boolean
+|
 |-
 | header
+| showHeader()
+| boolean
+|
 |-
 | footer
+| showFooter()
+| boolean
+|
 |-
 | sortable
+| isSortable()
+| boolean
+|
 |-
 | searchable
+| isSearchable()
+| boolean
+|
 |-
 | list
+| enableListView()
+| boolean
+|
 |-
 | detail
+| enableDetailView()
+| boolean
+|
 |-
 | expand
+| enableExpandListView()
+| boolean
+| only if list and detail
 |-
 | card
+| enableCardView()
+| boolean
+|
 |-
 | thumb
+| enableThumbnailView()
+| boolean
+|
 |-
 | view
+| defaultView()
+| string
+| defaults to list, [list, card, thumb]
 |-
 | image
+| image()
+| string
+|
 |-
 | export
+| canExportData()
+| boolean
+|
 |-
 | columns
+| canChooseColumns()
+| boolean
+|
 |-
 | pagination
+| pagination(), pageSize()
+| boolean, integer
+| defaults to 10
 |-
 | selection
+| selection()
+| string
+|
 |-
 | keyword
+| keyword()
+| string, ARK\Translation\Keyword
+|
 |-
 | classes
+| classes()
+| string
+|
 |-
 | template
+| template()
+| string
+|
 |-
 | url
+| dataUrl()
+| string
+|
 |-
 |}

@@ Line 37: / Line 37: @@
 Tables are a Compound Element defined by the ARK\View\Table class, and can only embed ARK\View\Field or ARK\View\Widget Basic Elements. They cannot embed other Compound Elements. When a Table embeds Field Elements, then all Fields must belong to a single Schema, i.e. a Table embeds a Schema, with each row embedding an Item that is an instance of that Schema.
-The Table Element is defined in the ark_view_table table, which is mapped by Doctrine to the ARK\View\Table class.
+The Table Element is defined in the ark_view_table table, which is mapped by Doctrine to the ARK\View\Table class. The definition seeks to abstract the HTML5 Table definition and the currently chosen JavaScript Table widget in a generic way to avoid implementation specifics. The Twig or JavaScript frontends are expected to translate this generic definition into the specific implementation being used.
 {| class="wikitable"

@@ Line 45: / Line 45: @@
 ! Database Field
 ! Class Method
 ! Description
 |-
 | element
+|
+|
+|
+|
 |-
+|
+|