You are here

Home » API reference » FullCalendar 7 » views_plugin_style_fullcalendar.inc

class views_plugin_style_fullcalendar in FullCalendar 7

Same name and namespace in other branches
  1. 6 views_plugin_style_fullcalendar.inc \views_plugin_style_fullcalendar

@file Contains the fullcalendar style plugin.

Hierarchy

Expanded class hierarchy of views_plugin_style_fullcalendar

1 string reference to 'views_plugin_style_fullcalendar'
fullcalendar_views_plugins in ./fullcalendar.views.inc
Implements hook_views_plugins().

File

./views_plugin_style_fullcalendar.inc, line 8
Contains the fullcalendar style plugin.

View source 
class views_plugin_style_fullcalendar extends views_plugin_style {
  function option_definition() {
    $options = parent::option_definition();
    $options['display'] = array(
      'contains' => array(
        'fc_view' => array(
          'default' => 'month',
        ),
        'fc_firstday' => array(
          'default' => '0',
        ),
        'fc_weekmode' => array(
          'default' => 'fixed',
        ),
      ),
    );
    $options['modules'] = array(
      'contains' => array(
        'fc_theme' => array(
          'default' => FALSE,
        ),
        'fc_url_colorbox' => array(
          'default' => FALSE,
        ),
      ),
    );
    $options['header'] = array(
      'contains' => array(
        'fc_left' => array(
          'default' => 'today prev,next',
        ),
        'fc_center' => array(
          'default' => 'title',
        ),
        'fc_right' => array(
          'default' => 'month agendaWeek agendaDay',
        ),
      ),
    );
    $options['defaults'] = array(
      'contains' => array(
        'fc_year' => array(
          'default' => '',
        ),
        'fc_month' => array(
          'default' => '',
        ),
        'fc_day' => array(
          'default' => '',
        ),
      ),
    );
    $options['times'] = array(
      'contains' => array(
        'fc_timeformat' => array(
          'default' => 'h:mm{ - h:mm}',
        ),
        'fc_clock' => array(
          'default' => FALSE,
        ),
      ),
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    $form['display'] = array(
      '#type' => 'fieldset',
      '#title' => t('Display settings'),
      '#description' => 'Blank values will use the current day, month, or year.',
      '#attributes' => array(
        'class' => 'clear-block',
      ),
    );
    $form['display']['fc_view'] = array(
      '#type' => 'select',
      '#title' => t('Initial display'),
      '#options' => array(
        'month' => 'Month',
        'agendaWeek' => 'Week (Agenda)',
        'basicWeek' => 'Week (Basic)',
        'agendaDay' => 'Day (Agenda)',
        'basicDay' => 'Day (Basic)',
      ),
      '#default_value' => $this->options['display']['fc_view'],
      '#description' => l(t('Default timespan displayed.'), 'http://arshaw.com/fullcalendar/docs/views/Available_Views', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
    );
    $form['display']['fc_firstday'] = array(
      '#type' => 'select',
      '#title' => t('First day'),
      '#options' => array(
        '0' => 'Sunday',
        '1' => 'Monday',
      ),
      '#default_value' => $this->options['display']['fc_firstday'],
      '#description' => l(t('The day each week begins.'), 'http://arshaw.com/fullcalendar/docs/display/firstDay', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
    );
    $form['display']['fc_weekmode'] = array(
      '#type' => 'select',
      '#title' => t('Week mode'),
      '#options' => array(
        'fixed' => 'Fixed',
        'liquid' => 'Liquid',
        'variable' => 'Variable',
      ),
      '#default_value' => $this->options['display']['fc_weekmode'],
      '#description' => l(t('Number of weeks displayed.'), 'http://arshaw.com/fullcalendar/docs/display/weekMode', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
    );
    $form['header'] = array(
      '#type' => 'fieldset',
      '#title' => t('Header elements'),
      '#description' => l(t('Buttons and title to be shown in header.'), 'http://arshaw.com/fullcalendar/docs/display/header', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#attributes' => array(
        'class' => 'clear-block',
      ),
    );
    $form['header']['fc_left'] = array(
      '#type' => 'textfield',
      '#title' => t('Left header'),
      '#default_value' => $this->options['header']['fc_left'],
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
      '#size' => '20',
    );
    $form['header']['fc_center'] = array(
      '#type' => 'textfield',
      '#title' => t('Center header'),
      '#default_value' => $this->options['header']['fc_center'],
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
      '#size' => '20',
    );
    $form['header']['fc_right'] = array(
      '#type' => 'textfield',
      '#title' => t('Right header'),
      '#default_value' => $this->options['header']['fc_right'],
      '#prefix' => '<div class="views-left-40">',
      '#suffix' => '</div>',
      '#size' => '30',
    );
    $form['defaults'] = array(
      '#type' => 'fieldset',
      '#title' => t('Default values'),
      '#description' => 'Blank values will use the current day, month, or year.',
      '#attributes' => array(
        'class' => 'clear-block',
      ),
    );
    $form['defaults']['fc_year'] = array(
      '#type' => 'textfield',
      '#title' => t('Year'),
      '#default_value' => $this->options['defaults']['fc_year'],
      '#description' => t('Full 4 digits.'),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
      '#size' => '20',
    );
    $form['defaults']['fc_month'] = array(
      '#type' => 'textfield',
      '#title' => t('Month'),
      '#default_value' => $this->options['defaults']['fc_month'],
      '#description' => t('No leading zeros.'),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
      '#size' => '20',
    );
    $form['defaults']['fc_day'] = array(
      '#type' => 'textfield',
      '#title' => t('Day'),
      '#default_value' => $this->options['defaults']['fc_day'],
      '#description' => t('No leading zeros.'),
      '#prefix' => '<div class="views-left-30">',
      '#suffix' => '</div>',
      '#size' => '20',
    );
    $form['times'] = array(
      '#type' => 'fieldset',
      '#title' => t('Time display'),
      '#description' => l(t('Formatting options for time.'), 'http://arshaw.com/fullcalendar/docs/utilities/formatDate', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#attributes' => array(
        'class' => 'clear-block',
      ),
    );
    $form['times']['fc_timeformat'] = array(
      '#type' => 'textfield',
      '#title' => t('Time format'),
      '#default_value' => $this->options['times']['fc_timeformat'],
      '#description' => 'Format of time display on each event.',
    );
    $form['times']['fc_clock'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use 24 hour display'),
      '#default_value' => $this->options['times']['fc_clock'],
      '#description' => 'Use 24 display (ignores custom time format).',
    );
    $form['modules'] = array(
      '#type' => 'fieldset',
      '#title' => t('Module integration'),
      '#description' => 'Settings for integration with other modules.',
      '#attributes' => array(
        'class' => 'clear-block',
      ),
    );
    $form['modules']['fc_theme'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use jQuery UI Theme'),
      '#default_value' => $this->options['modules']['fc_theme'],
      '#description' => t('If checked, the calendar will use any loaded jQuery UI themes.'),
    );
    $form['modules']['fc_url_colorbox'] = array(
      '#type' => 'checkbox',
      '#title' => t('Open events in colorbox'),
      '#default_value' => $this->options['modules']['fc_url_colorbox'],
      '#description' => t('If checked, each event will open in colorbox (if it is installed).'),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_fullcalendar::options_form function Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
views_plugin_style_fullcalendar::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition