ilPaymentShoppingCart Class Reference

Collaboration diagram for ilPaymentShoppingCart:

Public Member Functions
	ilPaymentShoppingCart ($user_obj)
	setSessionId ($a_session_id)
	getSessionId ()
	setPobjectId ($a_pobject_id)
	getPobjectId ()
	setPriceId ($a_price_id)
	getPriceId ()
	getEntries ($a_pay_method=0)
	setTotalAmount ($a_total_amount)
	getTotalAmount ()
	isInShoppingCart ($a_pobject_id)
	getEntry ($a_pobject_id)
	add ()
	update ($a_psc_id)
	delete ($a_psc_id)
	emptyShoppingCart ()
	getShoppingCart ($a_pay_method=0)
	getTotalAmountValue ($a_pay_method=0)
	getVat ($a_amount=0, $a_pobject_id=0)
	clearCouponItemsSession ()
	calcDiscountPrices ($coupons)

Static Public Member Functions
static	_assignObjectsToUserId ($a_user_id)
static	_migrateShoppingcart ($a_old_sessid, $a_new_sessid)
static	_hasEntries ($a_user_id)
static	_deleteExpiredSessionsPSC ()

Data Fields
	$user_obj = null
	$db = null
	$coupon_obj = null
	$sc_entries = array()
	$session_id = null

Private Member Functions
	__read ()

Detailed Description

Definition at line 16 of file class.ilPaymentShoppingCart.php.

Member Function Documentation

ilPaymentShoppingCart::__read ( )

private

Definition at line 301 of file class.ilPaymentShoppingCart.php.

References $pay_method, $res, $row, ilPaymentPrices\_getTotalAmount(), ilPaymentPrices\_priceExists(), getSessionId(), setPobjectId(), and setTotalAmount().

Referenced by add(), delete(), emptyShoppingCart(), ilPaymentShoppingCart(), and update().

        {
                global $ilUser;         
                include_once './Services/Payment/classes/class.ilPaymentPrices.php';

                $this->sc_entries = array();

                
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE session_id = %s',
                                array('text'), array($this->getSessionId()));                   
                }
                else
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE customer_id = %s',
                                array('integer'), array($this->user_obj->getId()));                     
                }
                        
                while($row = $this->db->fetchObject($res))
                {
                        $this->sc_entries[$row->psc_id]["psc_id"] = $row->psc_id;
                        $this->sc_entries[$row->psc_id]["customer_id"] = $row->customer_id; 
                        $this->sc_entries[$row->psc_id]["pobject_id"] = $row->pobject_id; 
                        $this->sc_entries[$row->psc_id]["price_id"] = $row->price_id;
                        $this->sc_entries[$row->psc_id]['session_id'] = $row->session_id;
                }

                // Delete all entries with not valid prices or pay_method
                unset($prices);
                foreach($this->sc_entries as $entry)
                {
                        // check if price_id exists for pobject
                        if(!ilPaymentPrices::_priceExists($entry['price_id'],$entry['pobject_id']))
                        {
                                $this->delete($entry['psc_id']);
                                return false;
                        }
                        
                        // check pay method
                        $tmp_pobj = new ilPaymentObject($this->user_obj, $entry['pobject_id']);
                        
                        $pay_method = $tmp_pobj->getPayMethod();
                        if($pay_method == $tmp_pobj->PAY_METHOD_NOT_SPECIFIED)
                        {
                                $this->delete($entry['psc_id']);
                                return false;
                        }
                        
                        // if payment is expired
                        if($tmp_pobj->getStatus() == $tmp_pobj->STATUS_EXPIRES)
                        { 
                                $this->delete($entry['psc_id']);

                                return false;
                        }


                        $this->sc_entries[$entry['psc_id']]['pay_method'] = $pay_method;

                        $prices[] = array(
                                'id' => $entry['price_id'],
                                'pay_method' => $pay_method
                        );
                        unset($tmp_pobj);
                }

                // set total amount
                $this->setTotalAmount(ilPaymentPrices::_getTotalAmount($prices ? $prices : array()));
                
                $this->setPobjectId($entry['pobject_id']);
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilPaymentShoppingCart::_assignObjectsToUserId (   $a_user_id )

static

Definition at line 98 of file class.ilPaymentShoppingCart.php.

References $ilDB, and $session_id.

Referenced by ilStartUpGUI\processStartingPage().

        {
                global  $ilDB;

                $session_id = session_id();

                $ilDB->update('payment_shopping_cart',
                array('customer_id' => array('integer', (int) $a_user_id)),
                array('session_id'=> array('text', $session_id)));

                return true;
        }

Here is the caller graph for this function:

static ilPaymentShoppingCart::_deleteExpiredSessionsPSC ( )

static

Definition at line 527 of file class.ilPaymentShoppingCart.php.

References $ilDB, and $query.

        {
                global $ilDB;
                
                $query = "DELETE FROM payment_shopping_cart "
                           . "WHERE psc_id IN " 
                           . "  (SELECT psc_id FROM payment_shopping_cart " 
                           . "   LEFT JOIN usr_session ON usr_session.session_id = payment_shopping_cart.session_id "
                           . "   WHERE customer_id = %s AND usr_session.session_id IS NULL)";
                $ilDB->manipulateF($query, array('integer'), array(ANONYMOUS_USER_ID)); 
                
        }

static ilPaymentShoppingCart::_hasEntries (   $a_user_id )

static

Definition at line 278 of file class.ilPaymentShoppingCart.php.

References $ilDB, $res, and getSessionId().

        {
                global $ilDB, $ilUser;
                
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $res = $ilDB->queryf('
                        SELECT * FROM payment_shopping_cart
                        WHERE session_id = %s',
                        array('text'), array($this->getSessionId()));           
                }
                else
                {
                        $res = $ilDB->queryf('
                        SELECT * FROM payment_shopping_cart
                        WHERE customer_id = %s',
                        array('integer'), array($a_user_id));           
                }
                return $res->numRows() ? true : false;
        }

Here is the call graph for this function:

static ilPaymentShoppingCart::_migrateShoppingcart (   $a_old_sessid,   $a_new_sessid  )

static

Definition at line 111 of file class.ilPaymentShoppingCart.php.

References $ilDB.

        {
                global $ilDB;
                
                $ilDB->update('payment_shopping_cart',
                array('session_id' => array('text', $a_new_sessid)),
                array('session_id'=> array('text', $a_old_sessid)));

        }

ilPaymentShoppingCart::add

(

)

Definition at line 176 of file class.ilPaymentShoppingCart.php.

References __read(), getPobjectId(), getPriceId(), and getSessionId().

        {
                global $ilUser;
                
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        // Delete old entries for same pobject_id
                        $statement = $this->db->manipulateF('
                                DELETE FROM payment_shopping_cart
                                WHERE session_id = %s
                                AND pobject_id = %s',
                                array('integer', 'integer'),
                                array($this->getSessionId(), $this->getPobjectId()));
                        
                }
                else
                {
                        // Delete old entries for same pobject_id
                        $statement = $this->db->manipulateF('
                                DELETE FROM payment_shopping_cart
                                WHERE customer_id = %s
                                AND pobject_id = %s',
                                array('integer', 'integer'),
                                array($this->user_obj->getId(), $this->getPobjectId()));
                }
                
                $next_id = $this->db->nextId('payment_shopping_cart');

                $this->db->insert('payment_shopping_cart',
                array('psc_id'   => array('integer', $next_id),
                        'customer_id'=> array('integer', $this->user_obj->getId()),
                        'pobject_id' => array('integer', $this->getPobjectId()),
                        'price_id'   => array('integer', $this->getPriceId()),
                        'session_id' => array('text', $this->getSessionId()))
                );

                $this->__read();

                return true;
        }

Here is the call graph for this function:

ilPaymentShoppingCart::calcDiscountPrices

(

$coupons

)

Definition at line 492 of file class.ilPaymentShoppingCart.php.

        {
                if (is_array($coupons))
                {
                        $r_items = array();
                        
                        foreach ($coupons as $coupon)
                        {       
                                $this->coupon_obj->setId($coupon['pc_pk']);
                                $this->coupon_obj->setCurrentCoupon($coupon);                           
                                
                                if (is_array($coupon['items']) && $coupon['total_objects_coupon_price'] > 0)
                                {                                       
                                        $bonus = ($this->coupon_obj->getCouponBonus($coupon['total_objects_coupon_price']));    
                                        
                                        foreach ($coupon['items'] as $item)
                                        {
                                                if (!array_key_exists($item['pobject_id'], $r_items))
                                                {
                                                        $r_items[$item['pobject_id']] = $item;
                                                        $r_items[$item['pobject_id']]['discount_price'] = (float) $item['math_price'];                                                  
                                                }                                                       
                                                
                                                $ratio = (float) $item['math_price'] / $coupon['total_objects_coupon_price'];
                                                $r_items[$item['pobject_id']]['discount_price'] += ($ratio * $bonus * (-1));                                                                                            
                                        }
                                }
                        }

                        return $r_items;
                }
                
                return array();
        }

ilPaymentShoppingCart::clearCouponItemsSession

(

)

Definition at line 474 of file class.ilPaymentShoppingCart.php.

References $_SESSION.

        {
                if (!empty($_SESSION['coupons']))
                {                                                                                                       
                        foreach ($_SESSION['coupons'] as $payment_type => $coupons_array)
                        {
                                if (is_array($coupons_array))
                                {
                                        foreach ($coupons_array as $coupon_key => $coupon)
                                        {
                                                $_SESSION['coupons'][$payment_type][$coupon_key]['total_objects_coupon_price'] = 0.0;
                                                $_SESSION['coupons'][$payment_type][$coupon_key]['items'] = array();                                            
                                        }       
                                }       
                        }
                }
        }

ilPaymentShoppingCart::delete

(

$a_psc_id

)

Definition at line 243 of file class.ilPaymentShoppingCart.php.

References __read().

        {
                $statement = $this->db->manipulateF('
                        DELETE FROM payment_shopping_cart
                        WHERE psc_id = %s',
                        array('integer'), array($a_psc_id));

                $this->__read();
        }

Here is the call graph for this function:

ilPaymentShoppingCart::emptyShoppingCart

(

)

Definition at line 253 of file class.ilPaymentShoppingCart.php.

References __read(), and getSessionId().

        {
                global $ilUser;
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $statement = $this->db->manipulateF('
                                DELETE FROM payment_shopping_cart
                                WHERE session_id = %s',
                                array('text'), array($this->getSessionId())
                                );
                }
                else
                {
                        $statement = $this->db->manipulateF('
                                DELETE FROM payment_shopping_cart
                                WHERE customer_id = %s',
                                array('integer'), array($this->user_obj->getId())
                        );
                }
                $this->__read();
        
                return true;
        }

Here is the call graph for this function:

ilPaymentShoppingCart::getEntries

(

$a_pay_method = 0

)

Definition at line 69 of file class.ilPaymentShoppingCart.php.

Referenced by getShoppingCart().

        {

                if ($a_pay_method == 0)
                {
                        return $this->sc_entries ? $this->sc_entries : array();
                }
                else
                {
                        $tmp_entries = array();
                        foreach($this->sc_entries as $entry)
                        {
                                if ($entry['pay_method'] == $a_pay_method)
                                {
                                        $tmp_entries[$entry['psc_id']] = $entry;
                                }
                        }
                        return $tmp_entries;
                }
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::getEntry

(

$a_pobject_id

)

Definition at line 148 of file class.ilPaymentShoppingCart.php.

References $res, and getSessionId().

        {
                global $ilUser;
                
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE session_id = %s
                                AND pobject_id = %s',
                                array('text', 'integer'),
                                array($this->getSessionId(), $a_pobject_id));
                }
                else
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE customer_id = %s
                                AND pobject_id = %s',
                                array('integer', 'integer'),
                                array($this->user_obj->getId(), $a_pobject_id));
                }
                if (is_object($res))
                {
                        return $this->db->fetchAssoc($res);
                }
        }

Here is the call graph for this function:

ilPaymentShoppingCart::getPobjectId

(

)

Definition at line 56 of file class.ilPaymentShoppingCart.php.

Referenced by add(), and update().

        {
                return $this->pobject_id;
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::getPriceId

(

)

Definition at line 64 of file class.ilPaymentShoppingCart.php.

Referenced by add(), and update().

        {
                return $this->price_id;
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::getSessionId

(

)

Definition at line 47 of file class.ilPaymentShoppingCart.php.

References $session_id.

Referenced by __read(), _hasEntries(), add(), emptyShoppingCart(), getEntry(), isInShoppingCart(), and update().

        {
                return $this->session_id;
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::getShoppingCart

(

$a_pay_method = 0

)

Definition at line 380 of file class.ilPaymentShoppingCart.php.

References ilPaymentPrices\_getPrice(), ilPaymentPrices\_getPriceString(), getEntries(), ilObjectFactory\getInstanceByRefId(), and ilShopVats\getRate().

Referenced by getTotalAmountValue().

        {

                if(!count($items = $this->getEntries($a_pay_method)))
                {
                        return 0;
                }

                $counter = 0;
                foreach($items as $item)
                {
                        $tmp_pobject = new ilPaymentObject($this->user_obj,$item['pobject_id']);

                        $tmp_obj = ilObjectFactory::getInstanceByRefId($tmp_pobject->getRefId(), false);

                        
                        $f_result[$counter]["psc_id"] = $item['psc_id'];
                        $f_result[$counter]["pobject_id"] = $item['pobject_id'];
                        if($tmp_obj)
                        {
                                $f_result[$counter]["obj_id"] = $tmp_obj->getId();
                                $f_result[$counter]["type"] = $tmp_obj->getType();
                                $f_result[$counter]["object_title"] = $tmp_obj->getTitle();
                        }
                        else
                        {
                                $f_result[$counter]["obj_id"] = '';
                                $f_result[$counter]["type"] = '';
                                $f_result[$counter]["object_title"] = $this->lng->txt('object_not_found');
                        }
                        $price_data = ilPaymentPrices::_getPrice($item['price_id']);
                        $price_string = ilPaymentPrices::_getPriceString($item['price_id']);

                        $price = (float)$price_data['price'];

                        $f_result[$counter]["price"] =  $price;
                        $f_result[$counter]["price_string"] = $price_string;
 
                 require_once './Services/Payment/classes/class.ilShopVats.php';
                        $oVAT = new ilShopVats((int)$tmp_pobject->getVatId());                                          
                        $f_result[$counter]['vat_rate'] = $oVAT->getRate();
                        $f_result[$counter]['vat_unit'] = $tmp_pobject->getVat($price);
                        
                        $f_result[$counter]["duration"] = $price_data["duration"];
                        $f_result[$counter]['unlimited_duration'] = $price_data['unlimited_duration'];

                        unset($tmp_obj);
                        unset($tmp_pobject);

                        ++$counter;
                }
                return $f_result;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPaymentShoppingCart::getTotalAmount

(

)

Definition at line 93 of file class.ilPaymentShoppingCart.php.

        {
                return $this->total_amount;
        }

ilPaymentShoppingCart::getTotalAmountValue

(

$a_pay_method = 0

)

Definition at line 434 of file class.ilPaymentShoppingCart.php.

References $result, and getShoppingCart().

        {
                $amount = 0.0;

                if (is_array($result = $this->getShoppingCart($a_pay_method)))
                {
                        for ($i = 0; $i < count($result); $i++)
                        {
                                $amount += $result[$i]["price"];
                        }
                }
                return (float) $amount;
        }

Here is the call graph for this function:

ilPaymentShoppingCart::getVat	(		$a_amount = 0,
			$a_pobject_id = 0
	)

Definition at line 448 of file class.ilPaymentShoppingCart.php.

References $ilDB, $res, and $row.

        {       
                global $ilDB;
                
                include_once './Services/Payment/classes/class.ilShopVats.php';
                
                $res = $ilDB->queryF('
                SELECT * FROM payment_objects WHERE pobject_id = %s',
                array('integer'), array($a_pobject_id));
                        
                while($row = $ilDB->fetchObject($res))
                {
                        $this->vat_id = $row->vat_id;
                }
                
                $res = $ilDB->queryF('
                        SELECT * FROM payment_vats WHERE vat_id = %s',
                        array('integer'),array($this->vat_id));
                        
                while($row = $ilDB->fetchObject($res))
                {
                        $this->vat_rate = $row->vat_rate;
                }
                return (float) ($a_amount - (round(($a_amount / (1 + ($this->vat_rate / 100.0))) * 100) / 100));                
        }

ilPaymentShoppingCart::ilPaymentShoppingCart

(

$user_obj

)

Definition at line 30 of file class.ilPaymentShoppingCart.php.

References $ilDB, $user_obj, and __read().

        {
                global $ilDB;

                $this->user_obj = $user_obj;
                $this->db = $ilDB;
                $this->session_id = session_id();
                $this->coupon_obj = new ilPaymentCoupons($this->user_obj);

                $this->__read();
        }

Here is the call graph for this function:

ilPaymentShoppingCart::isInShoppingCart

(

$a_pobject_id

)

Definition at line 121 of file class.ilPaymentShoppingCart.php.

References $res, $session_id, and getSessionId().

        { 
                global $ilUser;
                
                $session_id = $this->getSessionId();
        
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE session_id = %s
                                AND pobject_id = %s',
                                array('text', 'integer'),
                                array($session_id, $a_pobject_id));
                }
                else
                {
                        $res = $this->db->queryf('
                                SELECT * FROM payment_shopping_cart
                                WHERE customer_id = %s
                                AND pobject_id = %s',
                                array('integer', 'integer'),
                                array($this->user_obj->getId(), $a_pobject_id));
                }
                return $res->numRows() ? true : false;
        }

Here is the call graph for this function:

ilPaymentShoppingCart::setPobjectId

(

$a_pobject_id

)

Definition at line 52 of file class.ilPaymentShoppingCart.php.

Referenced by __read().

        {
                $this->pobject_id = $a_pobject_id;
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::setPriceId

(

$a_price_id

)

Definition at line 60 of file class.ilPaymentShoppingCart.php.

        {
                $this->price_id = $a_price_id;
        }

ilPaymentShoppingCart::setSessionId

(

$a_session_id

)

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

        {
                $this->session_id = $a_session_id;
        }

ilPaymentShoppingCart::setTotalAmount

(

$a_total_amount

)

Definition at line 89 of file class.ilPaymentShoppingCart.php.

Referenced by __read().

        {
                $this->total_amount = $a_total_amount;
        }

Here is the caller graph for this function:

ilPaymentShoppingCart::update

(

$a_psc_id

)

Definition at line 217 of file class.ilPaymentShoppingCart.php.

References __read(), getPobjectId(), getPriceId(), and getSessionId().

        {
                global $ilUser;
                if(ANONYMOUS_USER_ID == $ilUser->getId())
                {
                        $this->db->update('payment_shopping_cart',
                        array('pobject_id'=> array('integer', $this->getPobjectId()),
                                  'price_id'  => array('integer', $this->getPriceId()),
                                  'session_id'=> array('text', $this->getSessionId())),
                        array('psc_id'    => array('integer', (int)$a_psc_id)));

                }
                else
                {
                        $this->db->update('payment_shopping_cart',
                        array('customer_id'     => array('integer', $this->user_obj->getId()),
                                  'pobject_id'  => array('integer', $this->getPobjectId()),
                                  'price_id'    => array('integer', $this->getPriceId()),
                                  'session_id'  => array('text', $this->getSessionId())),
                        array( 'psc_id'         => array('integer', (int)$a_psc_id)));
                }
                $this->__read();

                return true;
        }

Here is the call graph for this function:

Field Documentation

ilPaymentShoppingCart::$coupon_obj = null

Definition at line 24 of file class.ilPaymentShoppingCart.php.

ilPaymentShoppingCart::$db = null

Definition at line 22 of file class.ilPaymentShoppingCart.php.

ilPaymentShoppingCart::$sc_entries = array()

Definition at line 26 of file class.ilPaymentShoppingCart.php.

ilPaymentShoppingCart::$session_id = null

Definition at line 27 of file class.ilPaymentShoppingCart.php.

Referenced by _assignObjectsToUserId(), getSessionId(), and isInShoppingCart().

ilPaymentShoppingCart::$user_obj = null

Definition at line 21 of file class.ilPaymentShoppingCart.php.

Referenced by ilPaymentShoppingCart().

---

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

• Services/Payment/classes/class.ilPaymentShoppingCart.php