Inheritance diagram for ilShopVatsList:

Collaboration diagram for ilShopVatsList:

Public Member Functions
	__construct ()
	Constructor. More...

	read ()
	Reads the vat datasets from database. More...

	getNumItems ()

	hasItems ()

	getItems ()

	rewind ()

	valid ()

	current ()

	key ()

	next ()

	setOrderColumn ($a_order_column)
	Setter for order column. More...

	getOrderColumn ()
	Getter for order column. More...

	setOrderDirection ($a_order_column)
	Setter for order direction. More...

	getOrderDirection ()
	Getter for order direction. More...

	setListStart ($a_list_start)
	Setter for start value. More...

	getListStart ()
	Getter for start value. More...

	setListMax ($a_list_max)
	Setter for max value. More...

	getListMax ()
	Getter for max value. More...

Static Public Member Functions
static	_isVATAlreadyCreated ($a_vat_rate, $a_vat_id=null)
	Checks if the passed vat rate already exists in database. More...

Private Attributes
	$db = null

	$num_vat_list = 0

	$vat_list = array()

Detailed Description

Class ilShopVatsList.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilShopVatsList::__construct ( )

Constructor.

@access public

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

        {
                global $ilDB;
                
                $this->db = $ilDB;
        }

References $ilDB.

Member Function Documentation

◆ _isVATAlreadyCreated()

static ilShopVatsList::_isVATAlreadyCreated	(	$a_vat_rate,
		$a_vat_id = `null`
	)

static

Checks if the passed vat rate already exists in database.

@access public

Parameters

string	$a_vat_rate	The vat rate wish should be checked.
int	$a_vat_id	Id of an existing vat rate. (optional)

Returns: bool

Definition at line 32 of file class.ilShopVatsList.php.

        {
                global $ilDB;
                
                $types = array();
                $data = array();
                
                $query = "SELECT * FROM payment_vats "
                           . "WHERE vat_rate = ? ";
                $types[] = 'float';
                $data[] = (float)$a_vat_rate;
                
                if((int)$a_vat_id)
                {
                        $query .= "AND vat_id != ? ";
                        $types[] = 'integer';
                        $data[] = $a_vat_id;
                }
 
                $statement = $ilDB->prepare(trim($query), $types);
                $result = $ilDB->execute($statement, $data);
                while($row = $ilDB->fetchObject($result))
                {
                        return true;    
                }               
                
                return false;
        }

References $data, $ilDB, $query, $result, and $row.

Referenced by ilShopVats\save(), and ilShopVats\update().

Here is the caller graph for this function:

◆ current()

ilShopVatsList::current ( )

Definition at line 140 of file class.ilShopVatsList.php.

        {
                return current($this->vat_list);
        }

References current().

Referenced by current(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItems()

ilShopVatsList::getItems ( )

Definition at line 128 of file class.ilShopVatsList.php.

        {
                return is_array($this->vat_list) ? $this->vat_list : array();
        }       

◆ getListMax()

ilShopVatsList::getListMax ( )

Getter for max value.

@access public

Returns: int

Definition at line 249 of file class.ilShopVatsList.php.

        {
                return $this->list_max;
        }

Referenced by read().

Here is the caller graph for this function:

◆ getListStart()

ilShopVatsList::getListStart ( )

Getter for start value.

@access public

Returns: int

Definition at line 224 of file class.ilShopVatsList.php.

        {
                return $this->list_start;
        }

◆ getNumItems()

ilShopVatsList::getNumItems ( )

Definition at line 120 of file class.ilShopVatsList.php.

        {
                return $this->num_vat_list;
        }       

References $num_vat_list.

◆ getOrderColumn()

ilShopVatsList::getOrderColumn ( )

Getter for order column.

@access public

Returns: string

Definition at line 174 of file class.ilShopVatsList.php.

        {
                return $this->order_column;
        }

Referenced by read().

Here is the caller graph for this function:

◆ getOrderDirection()

ilShopVatsList::getOrderDirection ( )

Getter for order direction.

@access public

Returns: string

Definition at line 199 of file class.ilShopVatsList.php.

        {
                return $this->order_direction;
        }

Referenced by read().

Here is the caller graph for this function:

◆ hasItems()

ilShopVatsList::hasItems ( )

Definition at line 124 of file class.ilShopVatsList.php.

        {
                return (bool)count($this->vat_list);
        }       

◆ key()

ilShopVatsList::key ( )

Definition at line 144 of file class.ilShopVatsList.php.

        {
                return key($this->vat_list);
        }

References key().

Referenced by key().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ next()

ilShopVatsList::next ( )

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

        {
                return next($this->vat_list);
        }

References next().

Referenced by next().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilShopVatsList::read ( )

Reads the vat datasets from database.

@access public

Returns: ilShopVatsList

Definition at line 81 of file class.ilShopVatsList.php.

        {               
                $this->vat_list = array();
                
                $query = "SELECT * FROM payment_vats ";
                $query.= "WHERE 1 = 1 ";                
                if(!in_array($this->getOrderColumn(), array('vat_title', 'vat_rate')))
                {
                        $this->setOrderColumn('vat_rate');
                        $this->setOrderDirection('ASC');
                }               
                
                $order_limit = " ORDER BY ".$this->getOrderColumn()." ".strtoupper($this->getOrderDirection())." ";             
                if((int)$this->getListMax())
                {
                        $order_limit .= "LIMIT ".$this->getListStart().", ".$this->getListMax();
                }
 
                $res = $this->db->query($query.$order_limit);   
                while($row = $this->db->fetchObject($res))
                {                       
                        $oVAT = new ilShopVats();
                        $oVAT->setId($row->vat_id);                     
                        $oVAT->setTitle($row->vat_title);
                        $oVAT->setRate($row->vat_rate);
 
                        $this->vat_list[$oVAT->getId()] = $oVAT;        
                }
                
                $res = $this->db->query(str_replace('*', 'COUNT(vat_id) AS num_vat_list', $query));     
                while($row = $this->db->fetchObject($res))
                {                       
                        $this->num_vat_list = $row->num_vat_list;
                        break;  
                }
 
                return $this;
        }

References $query, $res, $row, getListMax(), getOrderColumn(), getOrderDirection(), setOrderColumn(), and setOrderDirection().

Here is the call graph for this function:

◆ rewind()

ilShopVatsList::rewind ( )

Definition at line 132 of file class.ilShopVatsList.php.

        {
                return reset($this->vat_list);
        }       

◆ setListMax()

ilShopVatsList::setListMax ( $a_list_max )

Setter for max value.

@access public

Parameters

int $a_list_max

Returns: ilShopVatsList

Definition at line 236 of file class.ilShopVatsList.php.

        {
                $this->list_max = $a_list_max;
                
                return $this;
        }       

◆ setListStart()

ilShopVatsList::setListStart ( $a_list_start )

Setter for start value.

@access public

Parameters

int $a_list_start

Returns: ilShopVatsList

Definition at line 211 of file class.ilShopVatsList.php.

        {
                $this->list_start = $a_list_start;
                
                return $this;
        }

◆ setOrderColumn()

ilShopVatsList::setOrderColumn ( $a_order_column )

Setter for order column.

@access public

Parameters

string $a_order_column

Returns: ilShopVatsList

Definition at line 161 of file class.ilShopVatsList.php.

        {
                $this->order_column = $a_order_column;
                
                return $this;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setOrderDirection()

ilShopVatsList::setOrderDirection ( $a_order_column )

Setter for order direction.

@access public

Parameters

string $a_order_column

Returns: ilShopVatsList

Definition at line 186 of file class.ilShopVatsList.php.

        {
                $this->order_direction = $a_order_column;
                
                return $this;
        }

Referenced by read().

Here is the caller graph for this function:

◆ valid()

ilShopVatsList::valid ( )

Definition at line 136 of file class.ilShopVatsList.php.

        {
                return (bool)current($this->vat_list);
        }

References current().

Here is the call graph for this function:

Field Documentation

◆ $db

ilShopVatsList::$db = null

private

Definition at line 18 of file class.ilShopVatsList.php.

◆ $num_vat_list

ilShopVatsList::$num_vat_list = 0

private

Definition at line 19 of file class.ilShopVatsList.php.

Referenced by getNumItems().

◆ $vat_list

ilShopVatsList::$vat_list = array()

private

Definition at line 20 of file class.ilShopVatsList.php.

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

Services/Payment/classes/class.ilShopVatsList.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _isVATAlreadyCreated()

◆ current()

◆ getItems()

◆ getListMax()

◆ getListStart()

◆ getNumItems()

◆ getOrderColumn()

◆ getOrderDirection()

◆ hasItems()

◆ key()

◆ next()

◆ read()

◆ rewind()

◆ setListMax()

◆ setListStart()

◆ setOrderColumn()

◆ setOrderDirection()

◆ valid()

Field Documentation

◆ $db

◆ $num_vat_list

◆ $vat_list