[PHP-REST] element index

All elements
a b c d e f g i k l m o p r s t u w _
_
top
$_smarty
SmartyView::$_smarty in SmartyView.php
_run
SmartyView::_run() in SmartyView.php
Call parent run method
__construct
SmartyView::__construct() in SmartyView.php
__construct
SmartyViewLoader::__construct() in SmartyViewLoader.php
__construct
WSException::__construct() in WSException.php
Constructs an instance of WSException with the specified detail message.
__construct
InQuireWebUtil::__construct() in InQuireWebUtil.php
__construct
DoubleBarLayout::__construct() in DoubleBarLayout.php
__construct
Paginated::__construct() in Paginated.php
__construct
SearchTrail::__construct() in SearchTrail.php
SearchTrail object contructor.
__construct
Product::__construct() in Product.php
__construct
SearchFilterListModel::__construct() in SearchFilterListModel.php
__construct
Paginator::__construct() in Paginator.php
Initiates Pagiantor class object
__isset
SmartyView::__isset() in SmartyView.php
Enter description here...
__set
SmartyView::__set() in SmartyView.php
Sets the key value inside smarty assign variables those are used in templates where required.
__unset
SmartyView::__unset() in SmartyView.php
Remove specified key from assigned variable
a
top
$ABSOLUTE_ATTRIBUTE_DISPLAY_FILTER
$AJAX_REQUEST
WSConstants::$AJAX_REQUEST in WSConstants.php
$ATTRIBUTE_FILTER
$AUTHORIZATION_ERROR
addAbsoluteAttribute
Add absolute attribute in SearchTrail. Absolute attributes computes by there value and operator.
addAttribute
SearchTrail::addAttribute() in SearchTrail.php
Add attribute id and value in SearchTrail those are use in search. Multiple attributes are added in the SearchTrail by adding $ATTRIBUTE_FILTER in AND fashion.
addCategory
SearchTrail::addCategory() in SearchTrail.php
Add category id in the SearchTrail those are used in search. Multiple categores are added in the SearchTrail by adding $CATEGORY_FILTER_ID in AND fashion.
addChildCategory
Add child category id in SearchTrail those are used in search. Child Category are just a collection of category ids those are replaced by category ids when trial is append to WebService request. Its only used to distingush between filters those of normal category criteria or child category criteria.
addDisplayCategory
Add display category id in SearchTrail those are used in search. DiplayCategory are just a collection of category ids those are replaced by category ids when trial is append to WebService request. Its only used to distingush between filters those of normal category criteria or display category criteria.
addKeyword
SearchTrail::addKeyword() in SearchTrail.php
This method update the SearchTrail with the keyword passed and fitler the result base on that keyword.
addManufacturer
Add manufacturer id in SearchTrail those are used in search. Multiple manufactures are added in the SearchTrail by adding $MANUFACTURER_FILTER_ID in AND fashion.
addParentCategory
Add parent category id in SearchTrail those are used in searchParentCategory are just a collection of category ids those are replaced by category ids when trial is append to WebService request. Its only used to distingush between filters those of normal category criteria or parent category criteria.
appendUrlParameters
This method is used to append paramters passed from outside WSRequest from any source to destination parameters array.
assign
SmartyView::assign() in SmartyView.php
Assign key or value
assignPageNumber
attributeAction
FilterController::attributeAction() in FilterController.php
attributeAction is used to filter search based on the attribute selected.
b
top
$BAD_GATEWAY_ERROR
BaseController
BaseController in BaseController.php
This calss extends the functionality of Zend_Controller_Action
BaseController.php
BaseController.php in BaseController.php
c
top
$CATALOG_NOT_AVAILABLE
$CATEGORY_FAMILY
$CATEGORY_FILTER_ID
$CHILD_CATEGORY_FILTER_ID
$COMPARISON_REQUEST
$config
ConfigFileManagerModel::$config in ConfigFileManagerModel.php
CacheModel
CacheModel in CacheModel.php
categoryAction
FilterController::categoryAction() in FilterController.php
categoryAction is used to filter search based on the category selected.
categorySearchAction
Display categories are kind of saved searches which has different criterias, such as category, manufacturer, attribute and keywords.
clear
SearchTrail::clear() in SearchTrail.php
Clear the SearchTrail. All the filter added in the trail are clear and resets the whole search.
clearVars
SmartyView::clearVars() in SmartyView.php
Clear all smarty assgined variables
CompareController
CompareController in CompareController.php
Enter description here...
comparisonAction
CompareController::comparisonAction() in CompareController.php
ConfigFileManagerModel
ConfigFileManagerModel in ConfigFileManagerModel.php
contains
SearchTrail::contains() in SearchTrail.php
Check that supplied keyword is available in the particular array.
containsOperator
Check that operator is avalable in the gives value.
CompareController.php
CompareController.php in CompareController.php
createCategoryFamilyRequest
This method will create request to fetch all categories , there parent and child categories tree.
createCompareProductRequest
This method will create product comparison request. This method will return WSException::$REQUEST_VALIDATION_ERROR if the created WSRequest is not valdated properly.
createHttpResponse
Create Simple String WSResponse Object. It contains the data comming from the web service response. It will not contians response headers.
createProductDetailRequest
This method will create product details sheet request. This method will return WSException::$REQUEST_VALIDATION_ERROR if the created WSRequest is not valdated properly.
createRequestString
Enter description here...
createSearchRequest
This method will create keyword search and dicplay category search request depending onthe paramters pass to it. This method will return WSException::$REQUEST_VALIDATION_ERROR if the created WSRequest is not valdated properly.
createWSAjaxRequest
This methid is used to set every ajax call to web service. Parameters are passed to make it flexible of every ajax call.
createWSException
Factory method for creating WSException object.
createWSRequest
Factory method for creating web service request. It will create WSRequest depending on the type of request passed.
createWSResponse
Factory method for creating WSResponse. The method created specified type of response depending on the type parameter passed.
createZendHttpResponse
Create Zend Http WSResponse Object
CacheModel.php
CacheModel.php in CacheModel.php
ConfigFileManagerModel.php
ConfigFileManagerModel.php in ConfigFileManagerModel.php
d
top
$dcConfig
DCConfigManagerModel::$dcConfig in DCConfigManagerModel.php
$DISPLAY_CATEGORY_FILTER_ID
DCConfigManagerModel
DCConfigManagerModel in DCConfigManagerModel.php
dispatch
SmartyDispatcher::dispatch() in SmartyDispatcher.php
dispatchToActionMappedPath
Dispatch the path where target template file exist.
dispatchToTemplatePath
Dispatch the script path to inlcuding template file dir.
doRest
SpexLiveServiceClient::doRest() in SpexLiveServiceClient.php
Call the target service through Zend_Rest_Client Api.
doSimpleGet
SpexLiveServiceClient::doSimpleGet() in SpexLiveServiceClient.php
Call the target service through file_get_contents.
DoubleBarLayout
DoubleBarLayout in DoubleBarLayout.php
DCConfigManagerModel.php
DCConfigManagerModel.php in DCConfigManagerModel.php
DoubleBarLayout.php
DoubleBarLayout.php in DoubleBarLayout.php
e
top
$endtime
BaseController::$endtime in BaseController.php
$EQUALTO
SearchTrail::$EQUALTO in SearchTrail.php
Operator contants for absolute attributes.
$ERROR_RESPONSE
WSConstants::$ERROR_RESPONSE in WSConstants.php
ErrorController.php
ErrorController.php in ErrorController.php
error
Logger::error() in Logger.php
errorAction
ErrorController::errorAction() in ErrorController.php
errorAction is used to handle the following errors
ErrorController
ErrorController in ErrorController.php
ErrorController is the default controller to handle different errors, such as, invalid actions, database connectivity errors, and other application errors.
execute
WSGateway::execute() in WSGateway.php
This method will contain the code that would be executed using the retry logic.
execute
RetryCode::execute() in RetryCode.php
Execute method will be implemened by class that's inherit RetryCode and add retry logic.
f
top
$FEATURED_PRODUCTS
FilterController.php
FilterController.php in FilterController.php
fetchNumberPages
fetchPagedLinks
fetchPagedLinks
DoubleBarLayout::fetchPagedLinks() in DoubleBarLayout.php
fetchPagedNavigation
fetchPagedRow
FilterController
FilterController in FilterController.php
FilterController is used for filtering search results. it is not responsible for filtering following actions.
finalizeINSTANCE
Destroy instance of WSGateway class if not needed.
formatFiltersList
SearchFilterListModel::formatFiltersList() in SearchFilterListModel.php
formatOptAndAccTab
formatOverviewTab
ProductDetailModel::formatOverviewTab() in ProductDetailModel.php
formatSimilarProductsTab
formatTechnicalSpecsTab
g
top
$GET_PRODUCT_DETAIL
$GREATERTHAN_OR_EQUAL_TO
getAllCategories
Method to get all Categories and cache them
getAllManufactures
Method to get all Manufaturer and cache them
getappId
WSRequest::getappId() in WSRequest.php
Return App ID
getCache
CacheModel::getCache() in CacheModel.php
getCategory
Product::getCategory() in Product.php
getCategoryMap
DCConfigManagerModel::getCategoryMap() in DCConfigManagerModel.php
getChildCategories
Method to Get all the Child Categoris of a category
getConfig
ConfigFileManagerModel::getConfig() in ConfigFileManagerModel.php
Returns Zend_Config_Ini instance of configuration file
getDisplayTrial
Return List of Filters/Criteria available in SearchTrail to display.
getEncodedReponse
Returns encoded response body.
getEndpoint
WSRequest::getEndpoint() in WSRequest.php
Return the target service endpoint.
getEngine
SmartyView::getEngine() in SmartyView.php
Get the Smarty Engine for smarty related activities.
getEtilizeCategotyMap
getId
Product::getId() in Product.php
getInstance
CacheModel::getInstance() in CacheModel.php
factory method to return the singleton instance
getInstance
SmartyDispatcher::getInstance() in SmartyDispatcher.php
factory method to return the singleton instance
getInstance
ConfigFileManagerModel::getInstance() in ConfigFileManagerModel.php
factory method to return the singleton instance
getInstance
DCConfigManagerModel::getInstance() in DCConfigManagerModel.php
factory method to return the singleton instance
getInstance
WSGateway::getInstance() in WSGateway.php
factory method to return the singleton instance
getInstance
SpexLiveServiceClient::getInstance() in SpexLiveServiceClient.php
factory method to return the singleton instance
getInstance
ProductDetailModel::getInstance() in ProductDetailModel.php
factory method to return the singleton instance
getLayout
Paginated::getLayout() in Paginated.php
<description>
getLongDescription
getLongDescription
getMethod
WSRequest::getMethod() in WSRequest.php
getMfgNumber
getNavigation
Set the layout of the pagination bar.
getOffSet
Paginated::getOffSet() in Paginated.php
getOperator
SearchTrail::getOperator() in SearchTrail.php
Return the specific operator present in the given value.
getPageNumber
getPageSize
Paginated::getPageSize() in Paginated.php
getParameters
Get default parameters array of WSRequest object
getParametersString
Use to prepare paramter string from paramters array.
getPrice
Product::getPrice() in Product.php
getproductAction
ProductController::getproductAction() in ProductController.php
getproductAction is used to get the information of a single product
getQueryString
Return string containing the parameters passed to the Web Service.
getReponseBody
Retrieve response body. It contians xml data.
getRequestURL
Return request url
getResponseForXSLT
This method return well formed XML data that is used by any XSLT based style sheet to furhter process and display it.
getRestClient
SpexLiveServiceClient::getRestClient() in SpexLiveServiceClient.php
Returns a reference to the REST client, instantiating it if necessary
getRestResponse
Returns the XML Response by using Zend_Rest api.
getRowNumber
Paginated::getRowNumber() in Paginated.php
getRs
Paginated::getRs() in Paginated.php
getShortDescription
getShortDescription
getSimpleXMLResponse
This method return XML data in the form of SimpleXMLElement object. Creates light weight response object easy process by php and smarty collections functions.
getSkus
Product::getSkus() in Product.php
getSmarty
SmartyViewLoader::getSmarty() in SmartyViewLoader.php
getStatus
WSResponse::getStatus() in WSResponse.php
Return the Status code for the Webservice response.
getStatusMessage
Return the Status Message for the Webservice response.
gettechnicalAction
gettechnicalAction is used to get the Technical inormation of selected Project
getTrialString
Return url string representation of trail that is use in filtering requests. Its will return all the paramters present in trail irrespective of their types those are meaningful for web service request.
getUri_Base
WSRequest::getUri_Base() in WSRequest.php
Return URI for webservice.
i
top
IndexController.php
IndexController.php in IndexController.php
indexAction
SearchController::indexAction() in SearchController.php
The default action - show the home page
indexAction
IndexController::indexAction() in IndexController.php
The default action - show the home page
IndexController
IndexController in IndexController.php
This is the default controller, which is required to handle all the root level actions. It typically works with the urls such as http://inquiredemo.etilize.com/REST/. It forwards this root request to home page.
info
Logger::info() in Logger.php
init
SmartyViewLoader::init() in SmartyViewLoader.php
InQuireWebUtil
InQuireWebUtil in InQuireWebUtil.php
Utility class that has some usefull methods for use in the project where ever required.
isCategoryFilterExists
Check that the given trail contains any category filter id. Returns true if the trail contains category filter id else return false.
isEmpty
InQuireWebUtil::isEmpty() in InQuireWebUtil.php
THis method check the given string is null or emty then returns true else false.
isErrorResponse
InQuireWebUtil::isErrorResponse() in InQuireWebUtil.php
isFirstPage
Paginated::isFirstPage() in Paginated.php
isLastPage
Paginated::isLastPage() in Paginated.php
InQuireWebUtil.php
InQuireWebUtil.php in InQuireWebUtil.php
k
top
$KEYWORD_FILTER
SearchTrail::$KEYWORD_FILTER in SearchTrail.php
Contant Query paramter keys for all criteria/filters support by SearchTrail
keywordAction
FilterController::keywordAction() in FilterController.php
keywordAction is used to filter search based on the keyword entered.
keywordsearchAction
keywordsearchAction is used to perform keyword searches.
l
top
$LESSTHAN_OR_EQUAL_TO
lazyfiltersAction
lazyfiltersAction is used to fetch list of filters for a given search frm the target service.
load
SmartyViewLoader::load() in SmartyViewLoader.php
load
Paginator::load() in Paginator.php
Load the Paginated object with supplied results, count and page number.
Logger
Logger in Logger.php
Logger class is used to log warings and error messages to files
Logger.php
Logger.php in Logger.php
m
top
$MANUFACTURER_FILTER_ID
manufacturerAction
manufacturerAction is used to filter search based on the manufacturer selected.
o
top
$OTHER
WSException::$OTHER in WSException.php
p
top
$PARENT_CATEGORY_FILTER_ID
$PRODUCT_REQUEST
ProductController.php
ProductController.php in ProductController.php
PageLayout.php
PageLayout.php in PageLayout.php
Paginated.php
Paginated.php in Paginated.php
Paginator.php
Paginator.php in Paginator.php
Product.php
Product.php in Product.php
ProductDetailModel.php
ProductDetailModel.php in ProductDetailModel.php
pageAction
SearchController::pageAction() in SearchController.php
Pagination is used to organize search results in pages and every page contains set of results to maximize searching speed.
PageLayout
PageLayout in PageLayout.php
The interface which specifies the behaviour all page layout classes must implement
pagesizeAction
SearchController::pagesizeAction() in SearchController.php
PageSize is used to select the no of results that will be shown on each result page.
Paginated
Paginated in Paginated.php
Paginator
Paginator in Paginator.php
Paginator class load and number of pages according to the result counts. It requried SearchTrail url to pass in the constructor so it will be appended in every page link to request selected page data from target WebService.
populateRelatedProducts
populateSearchResults
This method populates the required data on Search Result Page
postDispatch
BaseController::postDispatch() in BaseController.php
This method overrides the default functionality of Zend_Controller_Action
preDispatch
BaseController::preDispatch() in BaseController.php
This method overrides the default functionality of Zend_Controller_Action
prepareChildCategoryFilter
This method prepare the trail for web service request and replace all child category ids with category ids.
prepareDisplayCategoryFilter
This method prepare the trail for web service request and replace all display category ids with category ids.
prepareKeywordFilter
This method will collect all keywords from the trail and prepare them to pass to web service request.
prepareParentCategoryFilter
This method prepare the trail for web service request and replace all parent category ids with category ids.
prepareTrailWithoutDisplayParameters
This method is used to remove all paramters those have only used to display there values not used by web service at all.
prepareTrailWithoutDisplayParameters1
Product
Product in Product.php
ProductController
ProductController in ProductController.php
This controller is used to get the content for any product. It uses REST based architecture to talk to the Etilize web services in order to get these content information.
ProductDetailModel
ProductDetailModel in ProductDetailModel.php
r
top
$REQUEST_TIMEOUT_ERROR
$REQUEST_VALIDATION_ERROR
$RESPONSE_VALIDATION_ERROR
$REST
WSConstants::$REST in WSConstants.php
$REST_GET
WSConstants::$REST_GET in WSConstants.php
$REST_OTHER
WSConstants::$REST_OTHER in WSConstants.php
$REST_POST
WSConstants::$REST_POST in WSConstants.php
$RETRY_ERROR
WSException::$RETRY_ERROR in WSException.php
RetryCode.php
RetryCode.php in RetryCode.php
registerFunctions
Register some php function as smarty modifiers to use in templates.
remove
SearchTrail::remove() in SearchTrail.php
Remove give filter type from the SearchTrail.
removeAction
FilterController::removeAction() in FilterController.php
removeAction is used to remove sleted filter frm search based on the id and filter passed in request paramters.
removeSpecialCharacters
This method will remove any special characters in the SearchTrail generated trialString. Current URLDecoding unable to decode there special charaters.
renderDynamicTemplates
This method wil dispatch to the script path where fragment template need to be included and automatically map it with current script path template directory.
replaceFirstOccurance
RetryCode
RetryCode in RetryCode.php
Code that failed or throw some exception and need to be re-executed that code for some type of exceptions will be implemented with this abstract class.
run
RetryCode::run() in RetryCode.php
Method that runs the retry logic. In uses following configuration parameters in the retry logic.
s
top
$SEARCH_REQUEST
WSConstants::$SEARCH_REQUEST in WSConstants.php
$SERVICE_FAILED
WSException::$SERVICE_FAILED in WSException.php
$SERVICE_NOT_EXISTS
$SIMPLE
WSConstants::$SIMPLE in WSConstants.php
$SOAP
WSConstants::$SOAP in WSConstants.php
$starttime
BaseController::$starttime in BaseController.php
SearchController.php
SearchController.php in SearchController.php
SearchFilterListModel.php
SearchFilterListModel.php in SearchFilterListModel.php
SearchTrail.php
SearchTrail.php in SearchTrail.php
SmartyDispatcher.php
SmartyDispatcher.php in SmartyDispatcher.php
SmartyView.php
SmartyView.php in SmartyView.php
SmartyViewLoader.php
SmartyViewLoader.php in SmartyViewLoader.php
SpexLiveServiceClient.php
SpexLiveServiceClient.php in SpexLiveServiceClient.php
SearchController
SearchController in SearchController.php
SearchController is responsible to control all the search actions. However, it is not responsible for filtering actions.
SearchFilterListModel
SearchFilterListModel in SearchFilterListModel.php
SearchFilterListModel is used to format lazy filters list retrieve through ajax call.
SearchTrail
SearchTrail in SearchTrail.php
SearchTrail class is use to to keep track of filters applied on search results. Its a Wrapper class for criteria that maintains a 'trail' of filters added to the current search.
send
WSGateway::send() in WSGateway.php
Send Request to SpexliveService through SpexLiveServiceClient. Call service with retry. Retry is useful because sometimes the connection will fail for some reason but will succeed when retried again.
serviceRequest
BaseController::serviceRequest() in BaseController.php
This is helper method and is used to perform web service request. It makes the web service call and return a php object.
setCategory
Product::setCategory() in Product.php
setCompareProductPage
This method sets the variable that are required for Compare Products Page rendering
setFooter
BaseController::setFooter() in BaseController.php
This method renders the Footer template and stores the HTML response in includeFooter variable of viewRenders instance that is available on View
setHeader
BaseController::setHeader() in BaseController.php
This method renders the header and dislayCategories templates and stores the HTML response in displayCategories & includeHeader variables of viewRenders instance that is available on View
setHomePage
BaseController::setHomePage() in BaseController.php
This method sets the variable that are required for Home Page rendering
setId
Product::setId() in Product.php
setLayout
Paginated::setLayout() in Paginated.php
<description>
setLongDescription
setMfgNumber
setOffSet
Paginated::setOffSet() in Paginated.php
setPageNumber
setPageSize
Paginated::setPageSize() in Paginated.php
setPrice
Product::setPrice() in Product.php
setRowNumber
Paginated::setRowNumber() in Paginated.php
setRs
Paginated::setRs() in Paginated.php
setSearchResultsPage
This method sets the variable that are required for Search Results Page rendering
setShortDescription
setSkus
Product::setSkus() in Product.php
setWSRequestFailed
This method populates the required data on Search Result Page
SmartyDispatcher
SmartyDispatcher in SmartyDispatcher.php
SmartyDispatcher class is used resolve the path for template files those are need to be included in the current template file. it controls dynamic mapping of template directories and dispatch request request to appropriate template for rendering.
SmartyView
SmartyView in SmartyView.php
SmartyView is the Wrapper class around Zend_View and provides entry point for Smarty related activities.
SmartyViewLoader
SmartyViewLoader in SmartyViewLoader.php
SmartyView Loaders load Smarty as a Zend View and register it as a view helper.
SpexLiveServiceClient
SpexLiveServiceClient in SpexLiveServiceClient.php
SpexLiveServiceClient is a simple client for connecting to an end service, sending WSRequest and retrieving it's raw XML response. It a Singleton class so only one instance of this class is created anytime.
suggestAction
FilterController::suggestAction() in FilterController.php
suggestAction is used to perform search with suggested keyword.
t
top
toParameterString
Return string contaning paramters that are use in filtering requests. This method remove all parameters those are used only to maintains trail filters and distinguish between there types. The results trail that used in Web Service request not requires those parameters.
typeof
InQuireWebUtil::typeof() in InQuireWebUtil.php
This function will retrun the type of object pass in paramter.
u
top
unLoad
SmartyViewLoader::unLoad() in SmartyViewLoader.php
w
top
WSConstants.php
WSConstants.php in WSConstants.php
WSException.php
WSException.php in WSException.php
WSFactory.php
WSFactory.php in WSFactory.php
WSGateway.php
WSGateway.php in WSGateway.php
WSRequest.php
WSRequest.php in WSRequest.php
WSResponse.php
WSResponse.php in WSResponse.php
WSConstants
WSConstants in WSConstants.php
WSConstant class contains static constants used by WSModel.
WSException
WSException in WSException.php
WSException class used to represent error produce by WSGateway class.
WSFactory
WSFactory in WSFactory.php
WSFactory class is responsible for creating Webservice objects
WSGateway
WSGateway in WSGateway.php
This is a Gateway class to the WebService. All the web services requests will be sent through Gateway class.
WSRequest
WSRequest in WSRequest.php
WSRequest class is used to send web services request to WSGateway class. This class i sa wrapper around REST based requests. It contains methods that is need by the target service and some utility methods.
WSResponse
WSResponse in WSResponse.php
WSResponse class represents the web services response. It will create different types of response required by the client.
a b c d e f g i k l m o p r s t u w _