Overview

Namespaces

  • None
  • PHP
  • XLite
    • Base
    • Controller
      • Admin
        • Base
      • Console
      • Customer
        • Base
    • Core
      • ColumnType
      • Doctrine
      • FileCache
      • HTTP
      • ImageOperator
      • Pack
      • Task
        • Base
      • TranslationDriver
      • Validator
        • Enum
        • Pair
        • String
          • ObjectId
    • DataSet
      • Collection
      • Transport
        • Order
    • Logic
      • Order
        • Modifier
      • Tax
        • Processor
    • Model
      • Base
      • Category
      • Collection
      • Image
        • Category
        • Product
      • ListNode
      • Order
      • OrderItem
      • Payment
        • Base
        • Processor
      • QueryBuilder
        • Base
      • Repo
        • Base
        • Category
        • Image
          • Category
          • Product
        • Order
        • Payment
        • Shipping
      • Shipping
        • Processor
      • WidgetParam
        • ObjectId
    • Module
      • CDev
        • Bestsellers
          • Core
          • Model
            • Repo
          • View
            • FormField
              • Select
            • Pager
        • FeaturedProducts
          • Controller
            • Admin
          • Core
          • Model
            • Repo
          • View
            • Admin
            • Customer
            • Form
            • Pager
        • FileAttachments
          • Controller
            • Admin
          • Model
            • Product
              • Attachment
            • Repo
              • Base
              • Product
                • Attachment
          • View
            • Form
            • Panel
            • Product
              • Details
                • Customer
                  • Page
        • ProductOptions
          • Controller
            • Admin
            • Customer
          • Model
            • Repo
          • View
            • Button
            • Form
              • Item
    • Upgrade
      • Entry
        • Module
    • View
      • Account
      • Address
      • Base
      • Button
        • Addon
      • Checkout
        • Step
      • Console
      • ExternalSDK
      • Form
        • Address
        • Cart
          • Item
          • ShippingEstimator
        • Checkout
        • FileDialog
        • ItemsList
          • Product
        • Login
          • Admin
          • Customer
        • Module
        • Order
          • Modify
        • Product
          • Modify
            • Base
          • Search
            • Admin
            • Customer
        • Profile
        • Profiles
        • Search
          • Product
        • Upgrade
      • FormField
        • Inline
          • Input
            • Checkbox
              • Switcher
            • Text
              • Integer
              • Position
              • Price
              • Product
        • Input
          • Base
          • Checkbox
          • Text
            • Base
        • Label
        • Select
        • Separator
        • Textarea
      • ItemsList
        • Model
          • Product
            • Admin
        • Module
        • Order
          • Admin
        • Product
          • Admin
          • Customer
        • Profile
          • Admin
      • JS
      • LanguagesModify
        • Button
      • Location
        • Node
      • Menu
        • Customer
      • Model
        • Address
        • FileDialog
        • Profile
      • ModulesManager
        • Action
      • Order
        • Details
          • Admin
          • Base
        • Search
        • Statistics
      • OrderList
      • Pager
        • Admin
          • Model
          • Module
          • Order
          • Product
          • Profile
        • Customer
          • Order
          • Product
      • PagerOrig
      • Payment
      • Product
        • Details
          • Admin
          • Customer
            • Page
      • ProductClass
      • RequestHandler
      • Sort
      • StickyPanel
        • Product
          • Admin
      • Tabs
      • Taxes
      • TopMenu
        • Node
      • Upgrade
        • SelectCoreVersion
        • Step
          • Completed
          • Prepare
          • ReadyToInstall

Classes

  • ACustomer
  • Category
  • Search
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class Search

Search

XLite\Base\SuperClass
Extended by XLite\Base\Singleton
Extended by XLite\Base
Extended by XLite\Core\Handler
Extended by XLite\View\AView
Extended by XLite\View\RequestHandler\ARequestHandler
Extended by XLite\View\Container
Extended by XLite\View\ItemsList\AItemsList
Extended by XLite\View\ItemsList\Product\AProduct
Extended by XLite\View\ItemsList\Product\Customer\ACustomer
Extended by XLite\View\ItemsList\Product\Customer\Search
Namespace: XLite\View\ItemsList\Product\Customer
Since: 1.0.0
See: ____class_see____
Located at XLite/View/ItemsList/Product/Customer/Search.php
Methods summary
public static array
# getSearchParams( )

Return search parameters. :TODO: refactor

Return search parameters. :TODO: refactor

Returns

array

Since

1.0.0

See

____func_see____
public static array
# getAllowedTargets( )

Return list of targets allowed for this widget

Return list of targets allowed for this widget

Returns

array

Since

1.0.0

See

____func_see____
protected static string
# getWidgetTarget( )

Return target to retrive this widget from AJAX

Return target to retrive this widget from AJAX

Returns

string

Since

1.0.0

See

____func_see____
public string
# getListCSSClasses( )

Returns CSS classes for the container element

Returns CSS classes for the container element

Returns

string

Since

1.0.0

See

____func_see____
public array
# getCSSFiles( )

Get a list of CSS files required to display the widget properly

Get a list of CSS files required to display the widget properly

Returns

array

Since

1.0.0

See

____func_see____
public array
# getJSFiles( )

Get a list of JavaScript files required to display the widget properly

Get a list of JavaScript files required to display the widget properly

Returns

array

Since

1.0.0

See

____func_see____
protected string
# getHead( )

Return title

Return title

Returns

string

Since

1.0.0

See

____func_see____
protected string
# getListHead( )

Return title

Return title

Returns

string

Since

1.0.0

See

____func_see____
protected boolean
# isHeadVisible( )

Check if head title is visible

Check if head title is visible

Returns

boolean

Since

1.0.0

See

____func_see____
protected boolean
# isHeaderVisible( )

Check if header is visible

Check if header is visible

Returns

boolean

Since

1.0.0

See

____func_see____
protected boolean
# isPagerVisible( )

Check if pager is visible

Check if pager is visible

Returns

boolean

Since

1.0.0

See

____func_see____
protected boolean
# isFooterVisible( )

isFooterVisible

isFooterVisible

Returns

boolean

Since

1.0.0

See

____func_see____
protected boolean
# isVisible( )

Search widget must be visible always.

Search widget must be visible always.

Returns

boolean

Since

1.0.0

See

____func_see____
protected string
# getPagerClass( )

Return class name for the list pager

Return class name for the list pager

Returns

string

Since

1.0.0

See

____func_see____
protected array
# getCommonParams( )

Get URL common parameters

Get URL common parameters

Returns

array

Since

1.0.0

See

____func_see____
protected
# defineWidgetParams( )

Define widget parameters

Define widget parameters

Since

1.0.0

See

____func_see____
protected
# defineRequestParams( )

Define so called "request" parameters

Define so called "request" parameters

Since

1.0.0

See

____func_see____
protected XLite\Core\CommonCell
# getSearchCondition( )

Return params list to use for search TODO refactor

Return params list to use for search TODO refactor

Returns

XLite\Core\CommonCell

Since

1.0.0

See

____func_see____
protected array|integer
# getData( XLite\Core\CommonCell $cnd, boolean $countOnly = false )

Return products list

Return products list

Parameters

$cnd
XLite\Core\CommonCell
Search condition
$countOnly
boolean
Return items list or only its size OPTIONAL

Returns

array|integer

Since

1.0.0

See

____func_see____
protected XLite\Core\CommonCell
# prepareCnd( XLite\Core\CommonCell $cnd )

Prepare search condition before search

Prepare search condition before search

Parameters

$cnd
XLite\Core\CommonCell
Search condition

Returns

XLite\Core\CommonCell

Since

1.0.0

See

____func_see____
Methods inherited from XLite\View\ItemsList\Product\Customer\ACustomer
__construct(), checkSideBarParams(), getAdditionalItemClass(), getCenterDisplayModes(), getCommonFiles(), getDisplayMode(), getDisplayModeLinkClassName(), getDisplayModes(), getGridColumnsRange(), getGridItemWidth(), getIconHeight(), getIconSizes(), getIconWidth(), getLabels(), getListName(), getMoreLinkText(), getMoreLinkURL(), getOrderBy(), getPageBodyDir(), getPageBodyFile(), getPopupCSS(), getPopupJS(), getProductCellClass(), getProductRows(), getSideBarData(), getSidebarDisplayModes(), getSidebarMaxItems(), getSortByModeDefault(), getTableColumnsCount(), isCSSLayout(), isDisplayModeSelected(), isDisplayModeSelectorVisible(), isProductAdded(), isShowMoreLink(), isSidebar(), isSortBySelectorVisible(), setWidgetParams()
Methods inherited from XLite\View\ItemsList\Product\AProduct
getDir(), getJSHandlerClassName()
Methods inherited from XLite\View\ItemsList\AItemsList
getAJAXSpecificParams(), getActionURL(), getBody(), getDefaultTemplate(), getEmptyListFile(), getEmptyListTemplate(), getItemsCount(), getJSArray(), getPageBodyTemplate(), getPageData(), getPager(), getPagerParams(), getSessionCellName(), getSortBy(), getSortOrder(), getSortOrderModeDefault(), getSortOrderToChange(), getSortWidgetId(), getURLAJAXParams(), getURLAJAXParamsJS(), getURLParams(), getURLParamsJS(), hasResults(), isDisplayWithEmptyList(), isEmptyListTemplateVisible(), isSortByModeSelected(), isSortOrderAsc(), preparePagerCSSFiles()
Methods inherited from XLite\View\Container
getBodyTemplate(), getTemplate(), isWrapper(), useBodyTemplate()
Methods inherited from XLite\View\RequestHandler\ARequestHandler
checkRequestParams(), checkSessionCell(), getJSData(), getRequestParams(), getRequestParamsHash(), getSavedRequestParam(), getSessionCell(), getWidgetClass(), getWidgetParameters(), initView(), setWidgetRequestParamValues()
Methods inherited from XLite\View\AView
__call(), __clone(), __constructStatic(), __get(), addSlashes(), addViewListChild(), applyXpathPatches(), buildListItemClass(), checkMode(), checkTarget(), checkVisibility(), closeView(), concat(), defineViewList(), detectCurrentViewZone(), display(), displayCommentedData(), displayInheritedViewListContent(), displayNestedViewListContent(), displayViewListContent(), formatDate(), formatFileSize(), formatPrice(), formatSize(), formatTime(), get(), getArrayField(), getChildWidget(), getContent(), getCurrencySymbol(), getCurrentLanguage(), getDefaultModes(), getInheritedListName(), getInheritedViewList(), getMetaTags(), getNamePostedData(), getNameToDelete(), getNamespaces(), getNestedListName(), getNestedViewList(), getObjectField(), getRegisteredMetas(), getRegisteredNamespaces(), getRegisteredResources(), getRequestParamValue(), getResources(), getResourcesSchema(), getResourcesTypeSchema(), getRowClass(), getTail(), getTemplateFile(), getThemeFiles(), getValidationEngineLanguageFile(), getValidationEngineLanguageResource(), getViewList(), getViewListChildren(), getViewListClass(), getViewListContent(), getViewListContentAsNodes(), getWidget(), getXpathByContent(), inc(), includeCompiledFile(), insertViewListByPattern(), insertViewListByXpath(), isDeveloperMode(), isDisplayRequired(), isDisplayRequiredForMode(), isEmpty(), isSelected(), isViewListVisible(), postprocessContent(), prepareResource(), rand(), registerMetas(), registerNamespaces(), registerResources(), registerResourcesForCurrentWidget(), removeWidgetFromList(), split(), truncate()
Methods inherited from XLite\Core\Handler
buildFullURL(), buildURL(), buildURLArguments(), buildURLPath(), getParam(), getParamsHash(), getPostedData(), getPrefixPostedData(), getPrefixSelected(), getRequestDataByPrefix(), getSelected(), getWidgetParams(), getWidgetSettings(), getWidgetSettingsFilter(), init(), isExported(), validateAttributes()
Methods inherited from XLite\Base
getComplex(), is(), isComplex(), set(), setComplex(), setProperties()
Methods inherited from XLite\Base\Singleton
getInstance(), resetInstance()
Methods inherited from XLite\Base\SuperClass
doDie(), t()
Constants summary
string PARAM_SUBSTRING 'substring'
#

Widget param names

Widget param names

string PARAM_CATEGORY_ID 'categoryId'
#
string PARAM_SEARCH_IN_SUBCATS 'searchInSubcats'
#
string PARAM_INCLUDING 'including'
#
string PARAM_BY_TITLE 'by_title'
#
string PARAM_BY_DESCR 'by_descr'
#
string PARAM_BY_SKU 'by_sku'
#
string WIDGET_TARGET 'search'
#

Widget target

Widget target

Constants inherited from XLite\View\ItemsList\Product\Customer\ACustomer
DISPLAY_GRID_CSS_LAYOUT, DISPLAY_MODE_BTHUMB, DISPLAY_MODE_GRID, DISPLAY_MODE_LIST, DISPLAY_MODE_ROTATOR, DISPLAY_MODE_STHUMB, DISPLAY_MODE_TABLE, DISPLAY_MODE_TEXTS, GRID_COLUMNS_MAX, GRID_COLUMNS_MIN, PARAM_DISPLAY_MODE, PARAM_GRID_COLUMNS, PARAM_ICON_MAX_HEIGHT, PARAM_ICON_MAX_WIDTH, PARAM_SHOW_DISPLAY_MODE_SELECTOR, PARAM_SHOW_SORT_BY_SELECTOR, PARAM_WIDGET_TYPE, SORT_BY_MODE_AMOUNT_ASC, SORT_BY_MODE_AMOUNT_DESC, SORT_BY_MODE_NAME_ASC, SORT_BY_MODE_NAME_DESC, SORT_BY_MODE_PRICE_ASC, SORT_BY_MODE_PRICE_DESC, SORT_BY_MODE_SKU_ASC, SORT_BY_MODE_SKU_DESC, TEMPLATE_SIDEBAR, WIDGET_TYPE_CENTER, WIDGET_TYPE_SIDEBAR
Constants inherited from XLite\View\ItemsList\Product\AProduct
SORT_BY_MODE_AMOUNT, SORT_BY_MODE_NAME, SORT_BY_MODE_PRICE, SORT_BY_MODE_SKU
Constants inherited from XLite\View\ItemsList\AItemsList
PARAM_SORT_BY, PARAM_SORT_ORDER, SORT_ORDER_ASC, SORT_ORDER_DESC
Constants inherited from XLite\View\RequestHandler\ARequestHandler
PARAM_SESSION_CELL, W_CLASS, W_PARAMS, W_TARGET
Constants inherited from XLite\View\AView
INSERT_AFTER, INSERT_BEFORE, PARAM_MODES, PARAM_TEMPLATE, REPLACE, RESOURCE_CSS, RESOURCE_JS
Constants inherited from XLite\Core\Handler
PARAM_AJAX_TARGET, PARAM_AJAX_WIDGET, PARAM_DUMP_STARTED, PARAM_IS_EXPORTED, PARAM_SILENT
Properties inherited from XLite\View\ItemsList\Product\Customer\ACustomer
$widgetTypes
Properties inherited from XLite\View\ItemsList\AItemsList
$commonParams, $defaultTemplate, $itemsCount, $pager, $sortByModes, $sortOrderModes, $sortWidgetIds
Properties inherited from XLite\View\RequestHandler\ARequestHandler
$requestParams, $savedRequestParams
Properties inherited from XLite\View\AView
$countDeep, $countLevel, $isCloned, $metas, $namedWidgets, $namespaces, $resources, $tail, $viewLists
Properties inherited from XLite\Core\Handler
$widgetParams
Properties inherited from XLite\Base
$singletons
Properties inherited from XLite\Base\Singleton
$instances
LiteCommerce API documentation generated by ApiGen 2.5.0