type = 'invoice';
$this->title = __( 'Invoice', 'woocommerce-pdf-invoices-packing-slips' );
$this->icon = WPO_WCPDF()->plugin_url() . "/assets/images/invoice.svg";
// Call parent constructor
parent::__construct( $order );
}
public function use_historical_settings() {
$document_settings = get_option( 'wpo_wcpdf_documents_settings_'.$this->get_type() );
// this setting is inverted on the frontend so that it needs to be actively/purposely enabled to be used
if (!empty($document_settings) && isset($document_settings['use_latest_settings'])) {
$use_historical_settings = false;
} else {
$use_historical_settings = true;
}
return apply_filters( 'wpo_wcpdf_document_use_historical_settings', $use_historical_settings, $this );
}
public function storing_settings_enabled() {
return apply_filters( 'wpo_wcpdf_document_store_settings', true, $this );
}
public function get_title() {
// override/not using $this->title to allow for language switching!
return apply_filters( "wpo_wcpdf_{$this->slug}_title", __( 'Invoice', 'woocommerce-pdf-invoices-packing-slips' ), $this );
}
public function init() {
// store settings in order
if ( $this->storing_settings_enabled() && !empty( $this->order ) ) {
$common_settings = WPO_WCPDF()->settings->get_common_document_settings();
$document_settings = get_option( 'wpo_wcpdf_documents_settings_'.$this->get_type() );
$settings = (array) $document_settings + (array) $common_settings;
WCX_Order::update_meta_data( $this->order, "_wcpdf_{$this->slug}_settings", $settings );
}
if ( isset( $this->settings['display_date'] ) && $this->settings['display_date'] == 'order_date' && !empty( $this->order ) ) {
$this->set_date( WCX_Order::get_prop( $this->order, 'date_created' ) );
} else {
$this->set_date( current_time( 'timestamp', true ) );
}
$this->init_number();
do_action( 'wpo_wcpdf_init_document', $this );
}
public function exists() {
return !empty( $this->data['number'] );
}
public function init_number() {
global $wpdb;
// If a third-party plugin claims to generate invoice numbers, trigger this instead
if ( apply_filters( 'woocommerce_invoice_number_by_plugin', false ) || apply_filters( 'wpo_wcpdf_external_invoice_number_enabled', false, $this ) ) {
$invoice_number = apply_filters( 'woocommerce_generate_invoice_number', null, $this->order );
$invoice_number = apply_filters( 'wpo_wcpdf_external_invoice_number', $invoice_number, $this );
} elseif ( isset( $this->settings['display_number'] ) && $this->settings['display_number'] == 'order_number' && !empty( $this->order ) ) {
$invoice_number = $this->order->get_order_number();
}
if ( !empty( $invoice_number ) ) { // overriden by plugin or set to order number
if ( is_numeric($invoice_number) || $invoice_number instanceof Document_Number ) {
$this->set_number( $invoice_number );
} else {
// invoice number is not numeric, treat as formatted
// try to extract meaningful number data
$formatted_number = $invoice_number;
$number = (int) preg_replace('/\D/', '', $invoice_number);
$invoice_number = compact( 'number', 'formatted_number' );
$this->set_number( $invoice_number );
}
return $invoice_number;
}
$number_store_method = WPO_WCPDF()->settings->get_sequential_number_store_method();
$number_store_name = apply_filters( 'wpo_wcpdf_document_sequential_number_store', 'invoice_number', $this );
$number_store = new Sequential_Number_Store( $number_store_name, $number_store_method );
// reset invoice number yearly
if ( isset( $this->settings['reset_number_yearly'] ) ) {
$current_year = date("Y");
$last_number_year = $number_store->get_last_date('Y');
// check if we need to reset
if ( $current_year != $last_number_year ) {
$number_store->set_next( apply_filters( 'wpo_wcpdf_reset_number_yearly_start', 1, $this ) );
}
}
$invoice_date = $this->get_date();
$invoice_number = $number_store->increment( $this->order_id, $invoice_date->date_i18n( 'Y-m-d H:i:s' ) );
$this->set_number( $invoice_number );
return $invoice_number;
}
public function get_filename( $context = 'download', $args = array() ) {
$order_count = isset($args['order_ids']) ? count($args['order_ids']) : 1;
$name = _n( 'invoice', 'invoices', $order_count, 'woocommerce-pdf-invoices-packing-slips' );
if ( $order_count == 1 ) {
if ( isset( $this->settings['display_number'] ) && $this->settings['display_number'] == 'invoice_number' ) {
$suffix = (string) $this->get_number();
} else {
if ( empty( $this->order ) ) {
$order = WCX::get_order ( $order_ids[0] );
$suffix = is_callable( array( $order, 'get_order_number' ) ) ? $order->get_order_number() : '';
} else {
$suffix = is_callable( array( $this->order, 'get_order_number' ) ) ? $this->order->get_order_number() : '';
}
}
} else {
$suffix = date('Y-m-d'); // 2020-11-11
}
$filename = $name . '-' . $suffix . '.pdf';
// Filter filename
$order_ids = isset($args['order_ids']) ? $args['order_ids'] : array( $this->order_id );
$filename = apply_filters( 'wpo_wcpdf_filename', $filename, $this->get_type(), $order_ids, $context );
// sanitize filename (after filters to prevent human errors)!
return sanitize_file_name( $filename );
}
/**
* Initialise settings
*/
public function init_settings() {
// Register settings.
$page = $option_group = $option_name = 'wpo_wcpdf_documents_settings_invoice';
$settings_fields = array(
array(
'type' => 'section',
'id' => 'invoice',
'title' => '',
'callback' => 'section',
),
array(
'type' => 'setting',
'id' => 'enabled',
'title' => __( 'Enable', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'enabled',
)
),
array(
'type' => 'setting',
'id' => 'attach_to_email_ids',
'title' => __( 'Attach to:', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'multiple_checkboxes',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'attach_to_email_ids',
'fields' => $this->get_wc_emails(),
'description' => !is_writable( WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ) ? '' . sprintf( __( 'It looks like the temp folder (%s
) is not writable, check the permissions for this folder! Without having write access to this folder, the plugin will not be able to email invoices.', 'woocommerce-pdf-invoices-packing-slips' ), WPO_WCPDF()->main->get_tmp_path( 'attachments' ) ).'':'',
)
),
array(
'type' => 'setting',
'id' => 'disable_for_statuses',
'title' => __( 'Disable for:', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'select',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'disable_for_statuses',
'options' => function_exists('wc_get_order_statuses') ? wc_get_order_statuses() : array(),
'multiple' => true,
'enhanced_select' => true,
'placeholder' => __( 'Select one or more statuses', 'woocommerce-pdf-invoices-packing-slips' ),
)
),
array(
'type' => 'setting',
'id' => 'display_shipping_address',
'title' => __( 'Display shipping address', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'select',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_shipping_address',
'options' => array(
'' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ),
'when_different'=> __( 'Only when different from billing address' , 'woocommerce-pdf-invoices-packing-slips' ),
'always' => __( 'Always' , 'woocommerce-pdf-invoices-packing-slips' ),
),
// 'description' => __( 'Display shipping address (in addition to the default billing address) if different from billing address', 'woocommerce-pdf-invoices-packing-slips' ),
)
),
array(
'type' => 'setting',
'id' => 'display_email',
'title' => __( 'Display email address', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_email',
)
),
array(
'type' => 'setting',
'id' => 'display_phone',
'title' => __( 'Display phone number', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_phone',
)
),
array(
'type' => 'setting',
'id' => 'display_customer_notes',
'title' => __( 'Display customer notes', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_customer_notes',
'store_unchecked' => true,
'default' => 1,
)
),
array(
'type' => 'setting',
'id' => 'display_date',
'title' => __( 'Display invoice date', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'select',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_date',
'options' => array(
'' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ),
'invoice_date' => __( 'Invoice Date' , 'woocommerce-pdf-invoices-packing-slips' ),
'order_date' => __( 'Order Date' , 'woocommerce-pdf-invoices-packing-slips' ),
),
)
),
array(
'type' => 'setting',
'id' => 'display_number',
'title' => __( 'Display invoice number', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'select',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'display_number',
'options' => array(
'' => __( 'No' , 'woocommerce-pdf-invoices-packing-slips' ),
'invoice_number' => __( 'Invoice Number' , 'woocommerce-pdf-invoices-packing-slips' ),
'order_number' => __( 'Order Number' , 'woocommerce-pdf-invoices-packing-slips' ),
),
'description' => sprintf(
'%s %s %s',
__( 'Warning!', 'woocommerce-pdf-invoices-packing-slips' ),
__( 'Using the Order Number as invoice number is not recommended as this may lead to gaps in the invoice number sequence (even when order numbers are sequential).', 'woocommerce-pdf-invoices-packing-slips' ),
__( 'More information', 'woocommerce-pdf-invoices-packing-slips' )
),
)
),
array(
'type' => 'setting',
'id' => 'next_invoice_number',
'title' => __( 'Next invoice number (without prefix/suffix etc.)', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'next_number_edit',
'section' => 'invoice',
'args' => array(
'store' => 'invoice_number',
'size' => '10',
'description' => __( 'This is the number that will be used for the next document. By default, numbering starts from 1 and increases for every new document. Note that if you override this and set it lower than the current/highest number, this could create duplicate numbers!', 'woocommerce-pdf-invoices-packing-slips' ),
)
),
array(
'type' => 'setting',
'id' => 'number_format',
'title' => __( 'Number format', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'multiple_text_input',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'number_format',
'fields' => array(
'prefix' => array(
'placeholder' => __( 'Prefix' , 'woocommerce-pdf-invoices-packing-slips' ),
'size' => 20,
'description' => __( 'to use the invoice year and/or month, use [invoice_year] or [invoice_month] respectively' , 'woocommerce-pdf-invoices-packing-slips' ),
),
'suffix' => array(
'placeholder' => __( 'Suffix' , 'woocommerce-pdf-invoices-packing-slips' ),
'size' => 20,
'description' => '',
),
'padding' => array(
'placeholder' => __( 'Padding' , 'woocommerce-pdf-invoices-packing-slips' ),
'size' => 20,
'type' => 'number',
'description' => __( 'enter the number of digits here - enter "6" to display 42 as 000042' , 'woocommerce-pdf-invoices-packing-slips' ),
),
),
'description' => __( 'note: if you have already created a custom invoice number format with a filter, the above settings will be ignored' , 'woocommerce-pdf-invoices-packing-slips' ),
)
),
array(
'type' => 'setting',
'id' => 'reset_number_yearly',
'title' => __( 'Reset invoice number yearly', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'reset_number_yearly',
)
),
array(
'type' => 'setting',
'id' => 'my_account_buttons',
'title' => __( 'Allow My Account invoice download', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'select',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'my_account_buttons',
'options' => array(
'available' => __( 'Only when an invoice is already created/emailed' , 'woocommerce-pdf-invoices-packing-slips' ),
'custom' => __( 'Only for specific order statuses (define below)' , 'woocommerce-pdf-invoices-packing-slips' ),
'always' => __( 'Always' , 'woocommerce-pdf-invoices-packing-slips' ),
'never' => __( 'Never' , 'woocommerce-pdf-invoices-packing-slips' ),
),
'custom' => array(
'type' => 'multiple_checkboxes',
'args' => array(
'option_name' => $option_name,
'id' => 'my_account_restrict',
'fields' => $this->get_wc_order_status_list(),
),
),
)
),
array(
'type' => 'setting',
'id' => 'invoice_number_column',
'title' => __( 'Enable invoice number column in the orders list', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'invoice_number_column',
)
),
array(
'type' => 'setting',
'id' => 'disable_free',
'title' => __( 'Disable for free orders', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'disable_free',
'description' => sprintf(__( "Disable document when the order total is %s", 'woocommerce-pdf-invoices-packing-slips' ), function_exists('wc_price') ? wc_price( 0 ) : 0 ),
)
),
array(
'type' => 'setting',
'id' => 'use_latest_settings',
'title' => __( 'Always use most current settings', 'woocommerce-pdf-invoices-packing-slips' ),
'callback' => 'checkbox',
'section' => 'invoice',
'args' => array(
'option_name' => $option_name,
'id' => 'use_latest_settings',
'description' => __( "When enabled, the document will always reflect the most current settings (such as footer text, document name, etc.) rather than using historical settings.", 'woocommerce-pdf-invoices-packing-slips' )
. "
"
. __( "Caution: enabling this will also mean that if you change your company name or address in the future, previously generated documents will also be affected.", 'woocommerce-pdf-invoices-packing-slips' ),
)
),
);
// remove/rename some fields when invoice number is controlled externally
if( apply_filters('woocommerce_invoice_number_by_plugin', false) ) {
$remove_settings = array( 'next_invoice_number', 'number_format', 'reset_number_yearly' );
foreach ($settings_fields as $key => $settings_field) {
if (in_array($settings_field['id'], $remove_settings)) {
unset($settings_fields[$key]);
} elseif ( $settings_field['id'] == 'display_number' ) {
// alternate description for invoice number
$invoice_number_desc = __( 'Invoice numbers are created by a third-party extension.', 'woocommerce-pdf-invoices-packing-slips' );
if ( $config_link = apply_filters( 'woocommerce_invoice_number_configuration_link', null ) ) {
$invoice_number_desc .= ' '.sprintf(__( 'Configure it here.', 'woocommerce-pdf-invoices-packing-slips' ), esc_attr( $config_link ) );
}
$settings_fields[$key]['args']['description'] = ''.$invoice_number_desc.'';
}
}
}
// allow plugins to alter settings fields
$settings_fields = apply_filters( 'wpo_wcpdf_settings_fields_documents_invoice', $settings_fields, $page, $option_group, $option_name );
WPO_WCPDF()->settings->add_settings_fields( $settings_fields, $page, $option_group, $option_name );
return;
}
}
endif; // class_exists
return new Invoice();