uc_shipping_handler_field_shipment_id.inc in Ubercart 7.3
Shipment ID field handler.
File
shipping/uc_shipping/views/uc_shipping_handler_field_shipment_id.incView source
<?php
/**
* @file
* Shipment ID field handler.
*/
/**
* Field handler: simple renderer that links to the shipment page.
*/
class uc_shipping_handler_field_shipment_id extends views_handler_field {
/**
* Override init function to provide generic option to link to shipment.
*/
function init(&$view, &$data) {
parent::init($view, $data);
if (!empty($this->options['link_to_shipment'])) {
$this->additional_fields['order_id'] = array(
'table' => $this->table_alias,
'field' => 'order_id',
);
}
}
/**
* Overrides views_handler::option_definition().
*/
function option_definition() {
$options = parent::option_definition();
$options['link_to_shipment'] = array(
'default' => FALSE,
);
return $options;
}
/**
* Overrides views_handler::options_form().
*
* Provides link to shipment administration page.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['link_to_shipment'] = array(
'#title' => t('Link this field to the shipment page'),
'#description' => t('This will override any other link you have set.'),
'#type' => 'checkbox',
'#default_value' => !empty($this->options['link_to_shipment']),
);
}
/**
* Renders whatever the data is as a link to the order.
*
* Data should be made XSS safe prior to calling this function.
*/
function render_link($data, $values) {
if (!empty($this->options['link_to_shipment'])) {
$this->options['alter']['make_link'] = FALSE;
if (user_access('fulfill orders')) {
$path = 'admin/store/orders/' . $this
->get_value($values, 'order_id') . '/shipments/' . $values->{$this->field_alias};
}
else {
$path = FALSE;
}
if ($path && $data !== NULL && $data !== '') {
$this->options['alter']['make_link'] = TRUE;
$this->options['alter']['path'] = $path;
}
}
return $data;
}
/**
* Overrides views_handler_field::render().
*/
function render($values) {
return $this
->render_link(check_plain($values->{$this->field_alias}), $values);
}
}
Classes
Name | Description |
---|---|
uc_shipping_handler_field_shipment_id | Field handler: simple renderer that links to the shipment page. |