Saved Successfully.
On this page

FragmentTable Class

The FragmentTable class is the core data container in WebCore CMS for working with fragment data. It holds a collection of FragmentRow objects and exposes methods for filtering, sorting, grouping, and retrieving rows, as well as utilities for reading URI, query string, and form parameters. The class implements ICloneable.

Properties

Property Type Default Description
id int — The unique database identifier for this fragment table instance.
lang string "en" The active language code used when retrieving rows (e.g. "en", "fr").
country string "ww" Country code associated with the table; defaults to worldwide ("ww").
keyCol string — The name of the primary key column used for row lookups and language matching.
Name string — The display name of the fragment table.
type string "CUSTOM" The table type; typically "CUSTOM" unless overridden by the CMS.
status string "draft" Publication status of the table (e.g. "draft", "published").
ownerSite string "" The site identifier that owns this fragment table; used in restricted file path resolution.
version int 1 Schema version of the fragment table definition.
SortCol string "" The column name currently used for sorting rows.
SortDirection string "DESC" Sorting direction — "ASC" or "DESC".
defId int — The definition ID linking this table to its FragmentDefinition schema.
defName string — The name of the fragment definition schema.
PageTitle string "" Optional page title passed through to generated component Razor views.
PageSubTitle string "" Optional page subtitle passed through to generated component Razor views.
rows List<FragmentRow> new list The full unfiltered collection of fragment rows loaded for this table.
filteredRows List<FragmentRow> — Holds the result of the most recent filter or sort operation for convenient re-use.
GroupByRows List<GroupRow> — Populated after calling GroupBy() or GroupByYear(); holds the grouped row collections.
UriParams List<FragmentUriParam> — Parsed URI / query-string parameters populated by loadQueryStringParams().
TableDefintion FragmentDefintion — Reference to the schema definition object describing column types and rules for this table.

getRows

List<FragmentRow> getRows(string lang, bool buildLangRows = false)

Returns all rows matching the specified language code. When buildLangRows is true and a keyCol is set, the method attempts to match non-English rows to their English counterparts using the key column or langParentId. If no translation row exists for a given English row, a new language row is automatically scaffolded and saved to the database. Sorted rows are applied per language via the Sorted collection before the filtered list is returned.

Parameters
  • lang — The language code to filter rows by (e.g. "en", "de").
  • buildLangRows — When true, auto-generates missing translation rows for non-English languages. Defaults to false.

Returns: A filtered List<FragmentRow> for the given language, or null if rows is null.

GetRow

FragmentRow GetRow(int id)

Retrieves a single FragmentRow by its internal integer row ID. Uses a single-or-default match against the rows collection.

Parameters
  • id — The internal row ID to look up.

Returns: The matching FragmentRow, or null if not found.

GetRowByLastUpdate

List<FragmentRow> GetRowByLastUpdate(DateTime update, string lang = "")

Returns all rows whose LastUpdate timestamp is more recent than the supplied update date. An optional lang filter can narrow results to a specific language.

Parameters
  • update — The cutoff DateTime; only rows updated after this value are returned.
  • lang — Optional language code to additionally filter results. Omit or pass an empty string to return all languages.

Returns: A List<FragmentRow> of recently updated rows, or null if rows is null.

FindRow

FragmentRow FindRow(string value, string lang = "en", string keyColName = "")

Searches the rows collection for a row whose key column value matches the supplied value string, filtered by the given language. If keyColName is left empty, the table's keyCol property is used automatically.

Parameters
  • value — The key column value to search for.
  • lang — The language code to filter by. Defaults to "en".
  • keyColName — The column name to match against. Falls back to the table's keyCol if omitted.

Returns: The first matching FragmentRow, or null if no match is found.

SelectRowsByCol

List<FragmentRow> SelectRowsByCol(string colName, string colValue, string lang = "")

Filters the rows collection and returns all rows where the named column's value matches colValue (case-insensitive). An optional lang parameter restricts matches to a specific language. The result is also stored in filteredRows for subsequent access.

Parameters
  • colName — The column name to filter on.
  • colValue — The value the column must match (case-insensitive).
  • lang — Optional language code. Pass an empty string to match all languages.

Returns: A List<FragmentRow> of matching rows. Also populates filteredRows.

SelectRowsRangeByCol

List<FragmentRow> SelectRowsRangeByCol(string colName, int colValue, string Optor = "==")

Filters rows using a numeric comparison against a named column. The comparison operator is specified via the Optor parameter. Results are stored in filteredRows.

Parameters
  • colName — The column name containing the numeric value to compare.
  • colValue — The integer value to compare against.
  • Optor — The comparison operator. Supported values:
    • "==" — Equal to (default)
    • ">=" or "=>" — Greater than or equal to
    • "<=" or "=<" — Less than or equal to

Returns: A List<FragmentRow> of rows satisfying the numeric condition. Also populates filteredRows.

SelectRowsByColDateRange

List<FragmentRow> SelectRowsByColDateRange(string colName, DateTime StartDate, DateTime EndDate)

Filters rows where the value in the specified date column falls within the inclusive range between StartDate and EndDate. The column value is parsed to a DateTime using the ToDateTimeCol() helper on each row. Results are stored in filteredRows.

Parameters
  • colName — The name of the date column to evaluate.

powered by webcore cmx

webcore