ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilShopPurchaseGUI Class Reference

Class ilShopPurchaseGUI. More...

+ Inheritance diagram for ilShopPurchaseGUI:
+ Collaboration diagram for ilShopPurchaseGUI:

Public Member Functions

 __construct ($a_ref_id)
 executeCommand ()
 execute command
 showDetails ()
 addToShoppingCart ()
 __initShoppingCartObject ()
 __initPaymentObject ()
 __initPricesObject ()
 __buildHeader ()
 __buildStatusline ()
 __buildLocator ()
 __buildStylesheet ()
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not)
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui
 getCreationMode ()
 get creation mode
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 showMountWebfolderIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 setActions ($a_actions="")
 set possible actions for objects in list.
 setSubObjects ($a_sub_objects="")
 set possible subobjects for this object.
 setLocator ()
 set Locator
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 omitLocator ($a_omit=true)
 addAdminLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 undeleteObject ()
 get object back from trash
 insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
 recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
 confirmedDeleteObject ()
 confirmed deletion if object -> objects are moved to trash
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
 remove already deleted objects within the objects in trash recursive function
 createObject ()
 create new object form
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 saveObject ()
 save object
 importObject ()
 import new object form
 editObject ()
 edit object
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 updateObject ()
 updates object entry in object_data
 afterUpdate ()
 permObject ()
 show permissions of current node
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 permSaveObject ()
 save permissions
 isVisible ($a_ref_id, $a_type)
 displayList ()
 display object list
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 display deletion confirmation screen only for referenced objects.
 trashObject ()
 show trash content of object
 addRoleObject ()
 adds a local role This method is only called when choose the option 'you may add local roles'.
 showActions ($with_subobjects=false)
 show possible action (form buttons)
 getActions ()
 Get Actions.
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __showButton ($a_cmd, $a_text, $a_target= '')
 hitsperpageObject ()
__initTableGUI ()
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table
 __showClipboardTable ($a_result_set, $a_from="")
 infoObject ()
 __buildRoleFilterSelect ()
 __filterRoles ($a_roles, $a_filter)
 ownerObject ()
 changeOwnerObject ()
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 Add an object search in case the number of existing objects is too big to offer a selection list.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

Data Fields

 $ctrl
 $ilias
 $lng
 $tpl
 $object = null
- Data Fields inherited from ilObjectGUI
const COPY_WIZARD_NEEDS_PAGE = 1
 $ilias
 $objDefinition
 $tpl
 $tree
 $lng
 $data
 $object
 $ref_id
 $obj_id
 $maxcount
 $formaction
 $return_location
 $target_frame
 $tab_target_script
 $actions
 $sub_objects
 $omit_locator = false

Private Member Functions

 __getAbstractHTML ($a_payment_object_id)

Additional Inherited Members

- Protected Member Functions inherited from ilObjectGUI
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)

Detailed Description

Constructor & Destructor Documentation

ilShopPurchaseGUI::__construct (   $a_ref_id)

Definition at line 44 of file class.ilShopPurchaseGUI.php.

References $ilCtrl, $ilErr, $ilias, $lng, $tpl, ilObjectGUI\$tree, and ilObjectFactory\getInstanceByRefId().

{
$this->ctrl =& $ilCtrl;
$this->ctrl->saveParameter($this, array("ref_id"));
$this->ilErr =& $ilErr;
$this->ilias =& $ilias;
$this->lng =& $lng;
$this->lng->loadLanguageModule('payment');
$this->tpl =& $tpl;
$this->ref_id = $a_ref_id;
$this->object =& ilObjectFactory::getInstanceByRefId($this->ref_id);
}

+ Here is the call graph for this function:

Member Function Documentation

ilShopPurchaseGUI::__buildHeader ( )

Definition at line 368 of file class.ilShopPurchaseGUI.php.

Referenced by executeCommand().

{
$this->tpl->addBlockFile("CONTENT", "content", "tpl.payb_content.html");
$this->tpl->setVariable("HEADER",$this->object->getTitle());
$this->tpl->setVariable("DESCRIPTION",$this->object->getDescription());
# $this->__buildStylesheet();
# $this->__buildStatusline();
}

+ Here is the caller graph for this function:

ilShopPurchaseGUI::__buildLocator ( )

Definition at line 385 of file class.ilShopPurchaseGUI.php.

References ilUtil\sendInfo().

Referenced by __buildStatusline().

{
$this->tpl->addBlockFile("LOCATOR", "locator", "tpl.locator.html");
$this->tpl->setVariable("TXT_LOCATOR",$this->lng->txt("locator"));
$this->tpl->setCurrentBlock("locator_item");
$this->tpl->setVariable("ITEM", $this->lng->txt("repository"));
$this->tpl->setVariable("LINK_ITEM", "../repository.php?getlast=true");
$this->tpl->parseCurrentBlock();
// CHECK for new mail and info
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilShopPurchaseGUI::__buildStatusline ( )

Definition at line 379 of file class.ilShopPurchaseGUI.php.

References __buildLocator().

{
$this->tpl->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
$this->__buildLocator();
}

+ Here is the call graph for this function:

ilShopPurchaseGUI::__buildStylesheet ( )

Definition at line 401 of file class.ilShopPurchaseGUI.php.

References ilUtil\getStyleSheetLocation().

{
$this->tpl->setVariable("LOCATION_STYLESHEET",ilUtil::getStyleSheetLocation());
}

+ Here is the call graph for this function:

ilShopPurchaseGUI::__getAbstractHTML (   $a_payment_object_id)
private

Definition at line 272 of file class.ilShopPurchaseGUI.php.

References ilPageObject\_exists().

Referenced by showDetails().

{
// page object
include_once 'Services/COPage/classes/class.ilPageObject.php';
include_once 'Services/COPage/classes/class.ilPageObjectGUI.php';
// if page does not exist, return nothing
if(!ilPageObject::_exists('shop', $a_payment_object_id))
{
return '';
}
include_once 'Services/Style/classes/class.ilObjStyleSheet.php';
// get page object
$page_gui = new ilPageObjectGUI('shop', $a_payment_object_id);
$page_gui->setIntLinkHelpDefault('StructureObject', $a_payment_object_id);
$page_gui->setLinkXML('');
$page_gui->setFileDownloadLink($this->ctrl->getLinkTargetByClass('ilPageObjectGUI', 'downloadFile'));
$page_gui->setFullscreenLink($this->ctrl->getLinkTargetByClass('ilPageObjectGUI', 'displayMediaFullscreen'));
$page_gui->setSourcecodeDownloadScript($this->ctrl->getLinkTargetByClass('ilPageObjectGUI', 'download_paragraph'));
$page_gui->setPresentationTitle('');
$page_gui->setTemplateOutput(false);
$page_gui->setHeader('');
$page_gui->setEnabledRepositoryObjects(false);
$page_gui->setEnabledFileLists(false);
$page_gui->setEnabledPCTabs(true);
$page_gui->setEnabledMaps(true);
return $page_gui->showPage();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilShopPurchaseGUI::__initPaymentObject ( )

Definition at line 351 of file class.ilShopPurchaseGUI.php.

References ilPaymentObject\_lookupPobjectId().

Referenced by addToShoppingCart(), executeCommand(), and showDetails().

{
include_once './payment/classes/class.ilPaymentObject.php';
$this->pobject =& new ilPaymentObject($this->ilias->account,ilPaymentObject::_lookupPobjectId($this->ref_id));
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilShopPurchaseGUI::__initPricesObject ( )

Definition at line 359 of file class.ilShopPurchaseGUI.php.

Referenced by showDetails().

{
include_once './payment/classes/class.ilPaymentPrices.php';
$this->price_obj =& new ilPaymentPrices($this->pobject->getPobjectId());
return true;
}

+ Here is the caller graph for this function:

ilShopPurchaseGUI::__initShoppingCartObject ( )

Definition at line 342 of file class.ilShopPurchaseGUI.php.

Referenced by addToShoppingCart(), and showDetails().

{
include_once './payment/classes/class.ilPaymentShoppingCart.php';
$this->sc_obj =& new ilPaymentShoppingCart($this->ilias->account);
return true;
}

+ Here is the caller graph for this function:

ilShopPurchaseGUI::addToShoppingCart ( )

Definition at line 303 of file class.ilShopPurchaseGUI.php.

References __initPaymentObject(), __initShoppingCartObject(), exit, ilUtil\redirect(), ilUtil\sendInfo(), and showDetails().

{
global $ilUser;
if(ANONYMOUS_USER_ID == $ilUser->getId())
{
ilUtil::redirect('login.php?cmd=force_login&login_to_purchase_object=1');
exit();
}
if(!isset($_POST['price_id']))
{
ilUtil::sendInfo($this->lng->txt('pay_select_price'));
$this->showDetails();
return true;
}
else
{
$this->sc_obj->setPriceId((int) $_POST['price_id']);
$this->sc_obj->setPobjectId($this->pobject->getPobjectId());
$this->sc_obj->add();
$this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.pay_purchase_details.html', 'Services/Payment');
$this->tpl->setCurrentBlock('shopping_cart');
$this->tpl->setVariable('LINK_GOTO_SHOPPING_CART', 'ilias.php?baseClass=ilShopController&cmd=redirect&redirect_class=ilShopShoppingCartGUI');
$this->tpl->setVariable('TXT_GOTO_SHOPPING_CART', $this->lng->txt('pay_goto_shopping_cart'));
$this->tpl->parseCurrentBlock('shopping_cart');
ilUtil::sendInfo($this->lng->txt('pay_added_to_shopping_cart'));
return true;
}
}

+ Here is the call graph for this function:

ilShopPurchaseGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 67 of file class.ilShopPurchaseGUI.php.

References $cmd, __buildHeader(), and __initPaymentObject().

{
switch($this->ctrl->getCmdClass())
{
case 'ilpageobjectgui':
include_once 'Services/Style/classes/class.ilObjStyleSheet.php';
include_once 'Services/COPage/classes/class.ilPageObjectGUI.php';
$page_gui = new ilPageObjectGUI('shop', $this->pobject->getPobjectId());
$this->ctrl->forwardCommand($page_gui);
return;
break;
default:
$cmd = $this->ctrl->getCmd();
$this->__buildHeader();
if(!$cmd || !method_exists($this, $cmd))
{
$cmd = 'showDetails';
}
$this->$cmd();
break;
}
}

+ Here is the call graph for this function:

ilShopPurchaseGUI::showDetails ( )

Definition at line 91 of file class.ilShopPurchaseGUI.php.

References __getAbstractHTML(), __initPaymentObject(), __initPricesObject(), __initShoppingCartObject(), ilPaymentPrices\_getPriceString(), ilUtil\formRadioButton(), ilUtil\getImagePath(), ilObjectFactory\getInstanceByRefId(), ilUtil\sendInfo(), and ilExplorer\setTargetGet().

Referenced by addToShoppingCart().

{
global $ilMainMenu;
$ilMainMenu->setActive('shop');
$this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.pay_purchase_details.html', 'Services/Payment');
if($this->pobject->getStatus() == $this->pobject->STATUS_EXPIRES)
{
ilUtil::sendInfo($this->lng->txt('pay_expires_info'));
return false;
}
$prices = $this->price_obj->getPrices();
$buyedObject = "";
if($this->sc_obj->isInShoppingCart($this->pobject->getPobjectId()))
{
$buyedObject = $this->sc_obj->getEntry($this->pobject->getPobjectId());
if (is_array($prices) &&
count($prices) > 1)
{
ilUtil::sendInfo($this->lng->txt('pay_item_already_in_sc_choose_another'));
}
else
{
ilUtil::sendInfo($this->lng->txt('pay_item_already_in_sc'));
}
$this->tpl->setCurrentBlock("shopping_cart");
$this->tpl->setVariable("LINK_GOTO_SHOPPING_CART", 'ilias.php?baseClass=ilShopController&cmd=redirect&redirect_class=ilShopShoppingCartGUI');
$this->tpl->setVariable("TXT_GOTO_SHOPPING_CART", $this->lng->txt('pay_goto_shopping_cart'));
# $this->tpl->setVariable("TXT_BUY", $this->lng->txt('pay_click_to_buy'));
$this->tpl->parseCurrentBlock("shopping_cart");
}
$this->ctrl->setParameter($this, "ref_id", $this->pobject->getRefId());
# if (!is_array($buyedObject) ||
# (is_array($buyedObject) && is_array($prices) && count($prices) > 1))
# {
$this->tpl->setVariable("DETAILS_FORMACTION",$this->ctrl->getFormAction($this));
$this->tpl->setVariable("TYPE_IMG",ilUtil::getImagePath('icon_'.$this->object->getType().'_b.gif'));
$this->tpl->setVariable("ALT_IMG",$this->lng->txt('obj_'.$this->object->getType()));
$this->tpl->setVariable("TITLE",$this->object->getTitle());
// payment infos
$this->tpl->setVariable("TXT_INFO",$this->lng->txt('info'));
switch($this->pobject->getPayMethod())
{
case $this->pobject->PAY_METHOD_BILL:
$this->tpl->setVariable("INFO_PAY",$this->lng->txt('pay_bill'));
$this->tpl->setVariable("INPUT_CMD",'getBill');
$this->tpl->setVariable("INPUT_VALUE",$this->lng->txt('pay_get_bill'));
break;
case $this->pobject->PAY_METHOD_BMF:
$this->tpl->setVariable("INFO_PAY",$this->lng->txt('pay_info'));
if (is_array($buyedObject))
{
if (is_array($prices) && count($prices) > 1)
{
$this->tpl->setVariable("INPUT_CMD",'addToShoppingCart');
$this->tpl->setVariable("INPUT_VALUE",$this->lng->txt('pay_change_price'));
}
}
else
{
$this->tpl->setVariable("INPUT_CMD",'addToShoppingCart');
$this->tpl->setVariable("INPUT_VALUE",$this->lng->txt('pay_add_to_shopping_cart'));
}
break;
case $this->pobject->PAY_METHOD_PAYPAL:
$this->tpl->setVariable("INFO_PAY",$this->lng->txt('pay_info'));
if (is_array($buyedObject))
{
if (is_array($prices) && count($prices) > 1)
{
$this->tpl->setVariable("INPUT_CMD",'addToShoppingCart');
$this->tpl->setVariable("INPUT_VALUE",$this->lng->txt('pay_change_price'));
}
}
else
{
$this->tpl->setVariable("INPUT_CMD",'addToShoppingCart');
$this->tpl->setVariable("INPUT_VALUE",$this->lng->txt('pay_add_to_shopping_cart'));
}
break;
}
$this->tpl->setVariable("ROWSPAN",count($prices));
$this->tpl->setVariable("TXT_PRICES",$this->lng->txt('prices'));
# }
if (is_array($prices))
{
# if (count($prices) > 1)
# {
$counter = 0;
foreach($prices as $price)
{
if ($counter == 0)
{
$placeholderCheckbox = "CHECKBOX";
$placeholderDuration = "DURATION";
$placeholderPrice = "PRICE";
}
else
{
$placeholderCheckbox = "ROW_CHECKBOX";
$placeholderDuration = "ROW_DURATION";
$placeholderPrice = "ROW_PRICE";
}
$this->tpl->setCurrentBlock("price_row");
if ($buyedObject["price_id"] == $price['price_id'])
{
$this->tpl->setVariable($placeholderCheckbox,ilUtil::formRadioButton(1,'price_id',$price['price_id']));
}
else if (count($prices) == 1)
{
$this->tpl->setVariable($placeholderCheckbox,ilUtil::formRadioButton(1,'price_id',$price['price_id']));
}
else
{
$this->tpl->setVariable($placeholderCheckbox,ilUtil::formRadioButton(0,'price_id',$price['price_id']));
}
$this->tpl->setVariable($placeholderDuration,$price['duration'].' '.$this->lng->txt('paya_months'));
$this->tpl->setVariable($placeholderPrice,ilPaymentPrices::_getPriceString($price['price_id']));
$this->tpl->parseCurrentBlock();
$counter++;
}
# }
# else if (!is_array($buyedObject))
# {
# foreach($prices as $price)
# {
# $this->tpl->setVariable("CHECKBOX",ilUtil::formRadioButton(0,'price_id',$price['price_id']));
# $this->tpl->setVariable("DURATION",$price['duration'].' '.$this->lng->txt('paya_months'));
# $this->tpl->setVariable("PRICE",ilPaymentPrices::_getPriceString($price['price_id']));
# }
# }
}
// abstracts
if(($abstract_html = $this->__getAbstractHTML($this->pobject->getPobjectId())) != '')
{
$this->tpl->setCurrentBlock('abstract_block');
$this->tpl->setVariable('TXT_ABSTRACT', $this->lng->txt('pay_abstract'));
$this->tpl->setVariable('ABSTRACT_HTML', $abstract_html.$output);
$this->tpl->parseCurrentBlock();
}
// public content ilias lm
global $ilObjDataCache;
if($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->pobject->getRefId())) == 'lm')
{
include_once 'Modules/LearningModule/classes/class.ilShopPublicSectionSelector.php';
$exp = new ilShopPublicSectionSelector($this->ctrl->getLinkTarget($this, 'layout'),
ilObjectFactory::getInstanceByRefId($this->pobject->getRefId()), get_class($this));
$exp->setTargetGet('obj_id');
$exp->setOutput(0);
$output = $exp->getOutput();
if(trim($output) != '')
{
$this->tpl->setCurrentBlock('public_content_block');
$this->tpl->setVariable('TXT_CONTENT', $this->lng->txt('content'));
$this->tpl->setVariable('PUBLIC_CONTENT_HTML', $output);
$this->tpl->parseCurrentBlock();
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilShopPurchaseGUI::$ctrl

Definition at line 37 of file class.ilShopPurchaseGUI.php.

ilShopPurchaseGUI::$ilias

Definition at line 38 of file class.ilShopPurchaseGUI.php.

Referenced by __construct().

ilShopPurchaseGUI::$lng

Definition at line 39 of file class.ilShopPurchaseGUI.php.

Referenced by __construct().

ilShopPurchaseGUI::$object = null

Definition at line 42 of file class.ilShopPurchaseGUI.php.

ilShopPurchaseGUI::$tpl

Definition at line 40 of file class.ilShopPurchaseGUI.php.

Referenced by __construct().


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