oxlist.php

Go to the documentation of this file.

<?php

class oxList extends oxSuperCfg implements ArrayAccess, Iterator, Countable
{
    protected $_aArray = array();

    private $_oBaseObject = null;

    private $_blValid = true;

    public function offsetExists( $offset )
    {
        if ( isset( $this->_aArray[$offset] ) ) {
            return true;
        } else {
            return false;
        }
    }

    public function offsetGet( $offset )
    {
        if ( $this->offsetExists( $offset ) ) {
            return $this->_aArray[$offset];
        } else {
            return false;
        }
    }

    public function offsetSet( $offset, $oBase )
    {
        if ( isset( $offset ) ) {
            $this->_aArray[$offset] = & $oBase;
        } else {
            $sLongFieldName = $this->_getFieldLongName( 'oxid' );
            if ( isset( $oBase->$sLongFieldName->value ) ) {
                $sOxid = $oBase->$sLongFieldName->value;
                $this->_aArray[$sOxid] = & $oBase;
            } else {
                $this->_aArray[] = & $oBase;
            }
        }

    }

    public function offsetUnset( $offset )
    {
        unset( $this->_aArray[$offset] );
    }

    public function arrayKeys()
    {
        return array_keys( $this->_aArray );
    }

    public function rewind()
    {
        $this->_blValid = ( false !== reset( $this->_aArray ) );
    }

    public function current()
    {
        return current( $this->_aArray );
    }

    public function key()
    {
        return key( $this->_aArray );
    }

    public function next()
    {
        $this->_blValid = ( false !== next( $this->_aArray ) );
    }

    public function valid()
    {
        return $this->_blValid;
    }

    public function count()
    {
        return count( $this->_aArray );
    }

    public function clear()
    {
        /*
        foreach ( $this->_aArray as $key => $sValue) {
            unset( $this->_aArray[$key]);
        }
        reset( $this->_aArray);*/
        $this->_aArray = array();
    }

    public function assign( $aArray )
    {
        $this->_aArray = $aArray;
    }

    public function reverse()
    {
        return array_reverse( $this->_aArray );
    }

    protected $_sObjectsInListName = 'oxBase';

    protected $_sCoreTable = null;

    protected $_sShopID = null;

    protected $_aAssignCallbackPrepend  = null;

    protected $_aAssignCallback = null;

    protected $_aSqlLimit = array();

    public function __construct( $sObjectName = null )
    {
        $myConfig = $this->getConfig();
        $this->_aSqlLimit[0] = 0;
        $this->_aSqlLimit[1] = 0;
        $this->_sShopID   = $myConfig->getShopId();

        if ( $sObjectName ) {
            $this->init( $sObjectName );
        }
    }

    public function __get( $sName)
    {
        //throw new Exception( 'oxList Access to undefined variable '. $sName);
        //echo( "Access to ".$sName.PHP_EOL);

        // TMP
        if ( $sName == 'aList') {
            return $this->_aArray;
        }
    }

    public function getArray()
    {
        return $this->_aArray;
    }

    public function init($sObjectName, $sCoreTable = null)
    {
        $this->_sObjectsInListName = $sObjectName;
        if ($sCoreTable) {
            $this->_sCoreTable = $sCoreTable;
        }
    }

    public function setAssignCallbackPrepend($aAssignCallbackPrepend)
    {
        $this->_aAssignCallbackPrepend = $aAssignCallbackPrepend;
    }

    public function setAssignCallback( $aAssignCallBack)
    {
        $this->_aAssignCallback = $aAssignCallBack;
    }

    public function getBaseObject()
    {
        if ( !$this->_oBaseObject ) {
            $this->_oBaseObject = oxNew( $this->_sObjectsInListName );
            $this->_oBaseObject->setInList();
            $this->_oBaseObject->init( $this->_sCoreTable );
        }

        return $this->_oBaseObject;
    }

    public function selectString( $sSql)
    {
        $this->clear();

        if ( $this->_aSqlLimit[0] || $this->_aSqlLimit[1]) {
            $rs = oxDb::getDb(true)->SelectLimit( $sSql, $this->_aSqlLimit[1], $this->_aSqlLimit[0]);
        } else {
            $rs = oxDb::getDb(true)->Execute( $sSql);
        }

        $oSaved = clone $this->getBaseObject();

        // this code is deprecated and will be removed:
        if ( $this->_aAssignCallbackPrepend && is_callable($this->_aAssignCallbackPrepend)) {
            call_user_func( $this->_aAssignCallbackPrepend, $oSaved);
        }
        // end of deprecated code

        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {

                $oListObject = clone $oSaved;

                $this->_assignElement($oListObject, $rs->fields);

                // this code is deprecated and will be removed:
                if ( $this->_aAssignCallback ) {
                    call_user_func( $this->_aAssignCallback, $oListObject );
                }
                // end of deprecated code

                if ($oListObject->getId()) {
                    $this->_aArray[$oListObject->getId()] = $oListObject;
                } else {
                    $this->_aArray[] = $oListObject;
                }

                $rs->moveNext();
            }
        }
    }

    public function setSqlLimit( $iStart, $iRecords)
    {
        $this->_aSqlLimit[0] = $iStart;
        $this->_aSqlLimit[1] = $iRecords;
    }

    public function containsFieldValue($oVal, $sFieldName)
    {
        $sFieldName = $this->_getFieldLongName($sFieldName);
        foreach ($this->_aArray as $obj) {
            if ($obj->{$sFieldName}->value == $oVal) {
                return true;
            }
        }

        return false;
    }

    public function getList()
    {
        $oListObject =$this->getBaseObject();
        $sFieldList = $oListObject->getSelectFields();
        $sQ = "select $sFieldList from " . $oListObject->getViewName();
        if ( $sActiveSnippet = $oListObject->getSqlActiveSnippet() ) {
            $sQ .= " where $sActiveSnippet ";
        }
        $this->selectString($sQ);

        return $this;
    }

    protected function _assignElement($oListObject, $aDbFields)
    {
        $oListObject->assign($aDbFields);
    }

    protected function _getFieldLongName($sFieldName)
    {
        if ($this->_sCoreTable) {
            return $this->_sCoreTable . '__' . $sFieldName;
        }

        return $sFieldName;
    }

}