You are here

Home » API reference » Scheduler 7 » scheduler_handler_field_scheduler_countdown.inc » SchedulerHandlerFieldSchedulerCountdown

public function SchedulerHandlerFieldSchedulerCountdown::option_definition in Scheduler 7

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_handler_field::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

./scheduler_handler_field_scheduler_countdown.inc, line 53
Display scheduled dates in 'countdown' format for use in Views.

Class

SchedulerHandlerFieldSchedulerCountdown
Field handler to display a countdown until a scheduled action.

Code

public function option_definition() {

  // @codingStandardsIgnoreEnd
  $options = parent::option_definition();
  $options['countdown_display'] = array(
    'default' => 'smart',
  );
  $options['units_display'] = array(
    'default' => 'long',
  );
  return $options;
}