component_date

Overview

{
    "could_be_translatable" : false,
    "is_literal": true,
    "is_related": false,
    "is_media": false,
    "modes": ["edit","list","tm","search"],
    "default_tools" : [
        "tool_time_machine",
        "tool_replace_component_data",
        "tool_add_component_data"
    ],
    "render_views" :[
        {
            "view"    : "mini | default",
            "mode"    : "edit | list"
        },
        {
            "view"    : "line | print",
            "mode"    : "edit"
        },
        {
            "view"    : "text",
            "mode"    : "list"
        }
    ],
    "data": "object",
    "sample_data": {
        "lg-nolan": [
            {
                "mode":"range",
                "start" : {
                    "year": 2012,
                    "month": 11,
                    "day": 7,
                    "hour": 17,
                    "minute": 33,
                    "second": 49
                },
                "end" : {
                    "year": 2012,
                    "month": 12,
                    "day": 8,
                    "hour": 22,
                    "minute": 15,
                    "second": 35
                }
            },
            {
                "mode":"range",
                "start":
                    {
                        "time":10349337600,
                        "year":322
                    }
            }
        ]
    },
    "value": "array of numbers",
    "sample_value": [{
        "start" : {
            "year": -350
        }
    }]
}

Definition

Component date manages any kind of dates in different modes. Data is non translatable and use lg-nolan to define his language.

The component has 4 different modes:

• date: with start date only
• range: with start date and end date
• period: with year, moth, day, hour, minute, second, millisecond
• time: with hour, minute, second, millisecond

Data model

Data: object with lg-nolan as property.

Value: array of objects, or null

Storage: In database, component date saves his data as object with lg-nolan as property and values as array of objects.

Modes supported: date | range | period | time

Default mode: date

Definition:

object has the possibility to use:

• start (optional object): indicates the initial date
• end (optional object): indicates the termination date
• period (optional object): indicates a period or range of time

properties of the dd_date:

• year (number): A year.
• month (optional number): A month, ranging between 1 and 12 inclusive.
• day ( optional number): A day of the month, ranging between 1 and 31 inclusive, 1 - 30 in moths with 30 days, 1 - 28 in February or 1 - 29 in leap years.
• hour (optional number): An hour of the day, ranging between 0 and 23 inclusive.
• minute (optional number): A minute, ranging between 0 and 59 inclusive.
• second (optional number): A second, ranging between 0 and 59 inclusive.
• millisecond (optional number): A number of milliseconds, ranging between 0 and 999 inclusive.
• time (number): A unique time representation of the date. It's calculated when the date is created or modifier.

Example of date: A punctual date 2012-11-07

[{
   "start" : {
        "year": 2012,
        "month": 11,
        "day": 7
    }
}]

Example of range. A time lapse form 2012-11-07 17:33:49 to 2012-12-08

[{
    "start" : {
        "year": 2012,
        "month": 11,
        "day": 7,
        "hour": 17,
        "minute": 33,
        "second": 49
    },
    "end" : {
        "year": 2012,
        "month": 12,
        "day": 8,
    }
}]

Example of date: Year -238

[{
   "start" : {
        "year": -238
    }
}]

Example of date: month 10 of the year 1238

[{
   "start" : {
        "year": 1238,
        "month": 10
    }
}]

Example of period. A lapse time of 3 years and 10 moths

[{
    "mode": "period",
    "period": {
        "year": 3,
        "month": 10,
    }
}]

Example of time. A punctual time 17:33:49

[{
   "start" : {
        "hour": 17,
        "minute": 33,
        "second": 49
    }
}]

Component date uses a dd_date object definition to create time base objects. Component data can handle objects with only one property assigned.

When the component is instantiated, the component get his data from his section and only get the value without lang.

Import model

By default, import model uses the JSON format of his value, since the component do not use languages, the main format to import is the array of dd_date objects.

[{
   "start" : {
        "year": 1238,
        "month": 10,
        "day": 9
    }
}]

See the full date import definition here.

Properties

date_mode

options: date | range | period | time

Defines the type of date to be use. By default, component_date set date mode.

Example to set a range:

{
    "date_mode" : "range"
}

fields_separator

Used to define the character/s to be used between date ranges. Used to export, and display data inside other components.

Example:

{
    "fields_separator": " <> "
}

Will join text version of the date: -200 <> 50/11

records_separator

Used to define the character to be used between multiple component values.

Example:

{
    "fields_separator": " | "
}

Will join locators (records) as text in this way: 26/10/2023 | 18/11/2000

mandatory

options: true | false

Informs users that this component requires a data value (user must to introduce any value, it's mandatory).