VirtueMart  3.2.14.9808
Public Member Functions | Static Public Member Functions | List of all members
shopFunctionsF Class Reference

Public Member Functions

 sendRatingEmailToVendor ($data)
 

Static Public Member Functions

static getLoginForm ($cart=FALSE, $order=FALSE, $url= '', $layout= 'login')
 
static getLastVisitedCategoryId ($default=0)
 
static setLastVisitedCategoryId ($categoryId)
 
static getLastVisitedItemId ($default=0)
 
static setLastVisitedItemId ($id)
 
static getLastVisitedManuId ()
 
static setLastVisitedManuId ($manuId)
 
static getAddToCartButton ($orderable)
 
static isFEmanager ($task=0)
 
static renderFormField ($type)
 
static getOrderStatusName ($_code)
 
static renderCountryList ($countryId=0, $multiple=FALSE, $_attrib=array(), $_prefix= '', $required=0, $idTag= 'virtuemart_country_id')
 
static renderStateList ($stateId= '0', $_prefix= '', $multiple=FALSE, $required=0, $attribs=array(), $idTag= 'virtuemart_state_id', $suffix='_field')
 
static generateStAddressList ($view, $userModel, $task)
 
static renderVendorAddress ($vendorId, $lineSeparator="<br />", $skips=array('name','username','email','agreed'))
 
static addProductToRecent ($productId)
 
static getRecentProductIds ($nbr=3)
 
static sortLoadProductCustomsStockInd (&$products, $pModel)
 
static calculateProductRowsHeights ($products, $currency, $products_per_row)
 
static renderVmSubLayout ($name, $viewData=0)
 
static renderMail ($viewName, $recipient, $vars=array(), $controllerName=NULL, $noVendorMail=FALSE, $useDefault=true)
 
static prepareViewForMail ($viewName, $vars, $controllerName=false)
 
static loadVmTemplateStyle ()
 
static setVmTemplate ($view, $catTpl=0, $prodTpl=0, $catLayout=0, $prodLayout=0)
 
static loadOrderLanguages ($language=0)
 
static sendVmMail (&$view, $recipient, $noVendorMail=FALSE)
 
static getTaxNameWithValue ($name, $value)
 
static limitStringByWord ($string, $maxlength, $suffix= '')
 
static vmSubstr ($str, $s, $e=null)
 
static buildTabs ($view, $load_template=array())
 
static translateTwoLangKeys ($pkey, $skey)
 
static getMenuItemId ($lang= '*')
 
static triggerContentPlugin (&$article, $context, $field)
 
static mask_string ($cc, $mask_char='X')
 
static getInvoiceFolderName ()
 
static getInvoiceName ($invoice_number, $layout='invoice')
 
static getInvoiceDownloadButton ($orderInfo, $descr= 'COM_VIRTUEMART_PRINT', $icon= 'system/pdf_button.png')
 
static InvoiceNumberReserved ($invoice_number)
 
static renderCaptcha ($config= 'reg_captcha', $id= 'dynamic_recaptcha_1')
 

Member Function Documentation

static shopFunctionsF::addProductToRecent (   $productId)
static
Author
Max Milbers
static shopFunctionsF::buildTabs (   $view,
  $load_template = array() 
)
static
static shopFunctionsF::calculateProductRowsHeights (   $products,
  $currency,
  $products_per_row 
)
static
static shopFunctionsF::generateStAddressList (   $view,
  $userModel,
  $task 
)
static

This generates the list when the user have different ST addresses saved

Author
Max Milbers
static shopFunctionsF::getAddToCartButton (   $orderable)
static
Parameters
$orderable
Returns
string
Deprecated:
static shopFunctionsF::getInvoiceDownloadButton (   $orderInfo,
  $descr = 'COM_VIRTUEMART_PRINT',
  $icon = 'system/pdf_button.png' 
)
static
static shopFunctionsF::getInvoiceFolderName ( )
static
static shopFunctionsF::getInvoiceName (   $invoice_number,
  $layout = 'invoice' 
)
static

Get the file name for the invoice or deliverynote. The layout argument currently is either 'invoice' or 'deliverynote'

Returns
The full filename of the invoice/deliverynote without file extension, sanitized not to contain problematic characters like /
static shopFunctionsF::getLastVisitedCategoryId (   $default = 0)
static
static shopFunctionsF::getLastVisitedItemId (   $default = 0)
static
static shopFunctionsF::getLastVisitedManuId ( )
static
static shopFunctionsF::getLoginForm (   $cart = FALSE,
  $order = FALSE,
  $url = '',
  $layout = 'login' 
)
static
static shopFunctionsF::getMenuItemId (   $lang = '*')
static

Get Virtuemart itemID from joomla menu

Author
Maik K�nnemann
static shopFunctionsF::getOrderStatusName (   $_code)
static

Return the order status name for a given code

Author
Oscar van Eijk public
Parameters
char$_codeOrder status code
Returns
string The name of the order status
static shopFunctionsF::getRecentProductIds (   $nbr = 3)
static

Gives ids the recently by the shopper visited products

Author
Max Milbers
static shopFunctionsF::getTaxNameWithValue (   $name,
  $value 
)
static
static shopFunctionsF::InvoiceNumberReserved (   $invoice_number)
static
static shopFunctionsF::isFEmanager (   $task = 0)
static
static shopFunctionsF::limitStringByWord (   $string,
  $maxlength,
  $suffix = '' 
)
static

Enter description here ...

Author
Max Milbers
Iysov
Parameters
string$string
int$maxlength
string$suffix
static shopFunctionsF::loadOrderLanguages (   $language = 0)
static
static shopFunctionsF::loadVmTemplateStyle ( )
static
Deprecated:
use the class vmTemplate instead
Returns
string
static shopFunctionsF::mask_string (   $cc,
  $mask_char = 'X' 
)
static
static shopFunctionsF::prepareViewForMail (   $viewName,
  $vars,
  $controllerName = false 
)
static
static shopFunctionsF::renderCaptcha (   $config = 'reg_captcha',
  $id = 'dynamic_recaptcha_1' 
)
static
static shopFunctionsF::renderCountryList (   $countryId = 0,
  $multiple = FALSE,
  $_attrib = array(),
  $_prefix = '',
  $required = 0,
  $idTag = 'virtuemart_country_id' 
)
static

Render a simple country list

Author
jseros, Max Milbers, Valérie Isaksen
Parameters
int$countryIdSelected country id
boolean$multipleTrue if multiple selections are allowed (default: false)
mixed$_attribstring or array with additional attributes, e.g. 'onchange=somefunction()' or array('onchange'=>'somefunction()')
string$_prefixOptional prefix for the formtag name attribute
Returns
string HTML containing the <select>
static shopFunctionsF::renderFormField (   $type)
static

Just an idea, still WIP

Parameters
$type
Returns
mixed
static shopFunctionsF::renderMail (   $viewName,
  $recipient,
  $vars = array(),
  $controllerName = NULL,
  $noVendorMail = FALSE,
  $useDefault = true 
)
static

Prepares a view for rendering email, then renders and sends

Parameters
object$controller
string$viewNameView which will render the email
string$recipientshopp.nosp@m.er@w.nosp@m.hatev.nosp@m.er.c.nosp@m.om
array$varsvariables to assign to the view
static shopFunctionsF::renderStateList (   $stateId = '0',
  $_prefix = '',
  $multiple = FALSE,
  $required = 0,
  $attribs = array(),
  $idTag = 'virtuemart_state_id',
  $suffix = '_field' 
)
static

Render a simple state list

Author
Max Milbers, Valerie Isaksen
Parameters
int$stateIDSelected state id
int$countryIDSelected country id
string$dependentFieldParent <select> ID attribute
string$_prefixOptional prefix for the formtag name attribute
Returns
string HTML containing the <select>
static shopFunctionsF::renderVendorAddress (   $vendorId,
  $lineSeparator = "<br />",
  $skips = array('name','username','email','agreed') 
)
static

used mostly in the email, to display the vendor address Attention, this function will be removed from any view.html.php

Parameters
$vendorId
string$lineSeparator
array$skips
Returns
string
static shopFunctionsF::renderVmSubLayout (   $name,
  $viewData = 0 
)
static

Renders sublayouts

Parameters
$name
int$viewDataviewdata for the rendered sublayout, do not remove
Returns
string
shopFunctionsF::sendRatingEmailToVendor (   $data)
static shopFunctionsF::sendVmMail ( $view,
  $recipient,
  $noVendorMail = FALSE 
)
static

With this function you can use a view to sent it by email. Just use a task in a controller

Parameters
string$viewfor example user, cart
string$recipientshopp.nosp@m.er@w.nosp@m.hatev.nosp@m.er.c.nosp@m.om
bool$vendortrue for notifying vendor of user action (e.g. registration)
static shopFunctionsF::setLastVisitedCategoryId (   $categoryId)
static
static shopFunctionsF::setLastVisitedItemId (   $id)
static
static shopFunctionsF::setLastVisitedManuId (   $manuId)
static
static shopFunctionsF::setVmTemplate (   $view,
  $catTpl = 0,
  $prodTpl = 0,
  $catLayout = 0,
  $prodLayout = 0 
)
static

This function sets the right template on the view

Author
Max Milbers
Deprecated:
use class VmTemplates instead
static shopFunctionsF::sortLoadProductCustomsStockInd ( $products,
  $pModel 
)
static
static shopFunctionsF::translateTwoLangKeys (   $pkey,
  $skey 
)
static

Checks if Joomla language keys exist and combines it according to existing keys. $pkey : primary string to search for Language key (must have s in the string to work) $skey : secondary string to search for Language key

Returns
string
Author
Max Milbers
Patrick Kohl
static shopFunctionsF::triggerContentPlugin ( $article,
  $context,
  $field 
)
static
static shopFunctionsF::vmSubstr (   $str,
  $s,
  $e = null 
)
static

The documentation for this class was generated from the following file: