oxpicturehandler.php

Go to the documentation of this file.

<?php

class oxPictureHandler extends oxSuperCfg
{
    private static $_instance = null;


    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if ( !self::$_instance instanceof oxPictureHandler ) {

            self::$_instance = oxNew( 'oxPictureHandler' );
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function generateArticlePictures( $oObject, $iIndex )
    {
        $iGeneratedImages = (int)$oObject->oxarticles__oxpicsgenerated->value;
        $oConfig = $this->getConfig();
        $oUtilsFile = oxUtilsFile::getInstance();

        if ( $iGeneratedImages < $iIndex ) {

            $iTotalGenerated = $iGeneratedImages;

            for ( $iNr = $iGeneratedImages + 1; $iNr <= $iIndex; $iNr++ ) {

                $sField = "oxarticles__oxpic" . $iNr;

                if ( $oObject->$sField->value ) {

                    $sMasterPictureSource = $oConfig->getMasterPictureDir() . $iIndex . "/" . basename($oObject->$sField->value);

                    if ( file_exists( $sMasterPictureSource ) ) {
                        $sNewName = $this->_getArticleMasterPictureName( $oObject, $iNr );

                        // generating main product picture
                        $sType = "P" . $iNr . "@oxarticles__oxpic" . $iNr;
                        $aFiles['myfile']['name']     = array( $sType => $sNewName );
                        $aFiles['myfile']['tmp_name'] = array( $sType => $sMasterPictureSource );
                        $oUtilsFile->processFiles( $oObject, $aFiles, true );
                        //$oObject->$sField->value = $oUtilsFile->getImageDirByType( "P".$iIndex ) . $oObject->$sField->value;

                        // generating zoom picture
                        $sType = "Z" . $iNr . "@oxarticles__oxzoom" . $iNr;
                        $sField = "oxarticles__oxzoom" . $iNr;
                        $aFiles['myfile']['name']     = array( $sType => $sNewName );
                        $aFiles['myfile']['tmp_name'] = array( $sType => $sMasterPictureSource );
                        $oObject->$sField = new oxField();
                        $oUtilsFile->processFiles( $oObject, $aFiles, true );
                        //$oObject->$sField->value = $oUtilsFile->getImageDirByType( "Z".$iIndex ) . $oObject->$sField->value;

                        // if this is picture with number #1, also generating
                        // thumbnail and icon
                        if ( $iNr == 1 ) {
                            // Thumbnail
                            $sType = "TH@oxarticles__oxthumb";
                            $aFiles['myfile']['name']     = array( $sType => $sNewName );
                            $aFiles['myfile']['tmp_name'] = array( $sType => $sMasterPictureSource );
                            $oUtilsFile->processFiles( $oObject, $aFiles, true );
                            $oObject->oxarticles__oxthumb = new oxField();

                            //$oObject->oxarticles__oxthumb = new oxField();
                            $oObject->oxarticles__oxthumb = null;

                            // Icon
                            $sType = "ICO@oxarticles__oxicon";
                            $aFiles['myfile']['name']     = array( $sType => $sNewName );
                            $aFiles['myfile']['tmp_name'] = array( $sType => $sMasterPictureSource );
                            $oUtilsFile->processFiles( $oObject, $aFiles, true );
                            $oObject->oxarticles__oxicon = new oxField();
                        }

                        $iTotalGenerated++;
                    }
                }
            }

            if ( $iTotalGenerated > $iGeneratedImages ) {
                $oObject->updateAmountOfGeneratedPictures( $iIndex );
            }
        }
    }

    protected function _getArticleMasterPictureName( $oObject, $iIndex )
    {
        $sName = '';

        if ( $iIndex ) {
            $sName = $oObject->{"oxarticles__oxpic".$iIndex}->value;
            $sName = $this->_getBaseMasterImageFileName( $sName );

        }

        return $sName;
    }

    public function deleteArticleMasterPicture( $oObject, $iIndex, $blDeleteMasterPicture = true )
    {
        $oDB        = oxDb::getDb( true );
        $myConfig   = $this->getConfig();
        $myUtilsPic = oxUtilsPic::getInstance();
        $oUtilsFile = oxUtilsFile::getInstance();

        $aDelPics = array();
        $sAbsDynImageDir = $myConfig->getAbsDynImageDir();
        $sMasterImage = $oObject->{"oxarticles__oxpic".$iIndex}->value;

        if ( !$sMasterImage || $sMasterImage == "nopic.jpg" ) {
            return;
        }

        $aDelPics = array();

        if ( $blDeleteMasterPicture ) {
            // master picture
            $aDelPics[] = array("sField"    => "oxpic".$iIndex,
                                "sDir"      => $oUtilsFile->getImageDirByType( "M".$iIndex ),
                                "sFileName" => $sMasterImage);
        }

        // general picture
        $aDelPics[] = array("sField"    => "oxpic".$iIndex,
                            "sDir"      => $oUtilsFile->getImageDirByType( "P".$iIndex ),
                            "sFileName" => $sMasterImage);

        // zoom picture
        $sZoomPicName = $this->getZoomName( $sMasterImage, $iIndex );
        $aDelPics[] = array("sField"    => "oxpic1",
                            "sDir"      => $oUtilsFile->getImageDirByType( "Z".$iIndex ),
                            "sFileName" => $sZoomPicName);

        if ( $iIndex == 1 ) {
            // deleting generated main icon picture if custom main icon
            // file name not equal with generated from master picture
            if ( $this->getMainIconName( $sMasterImage ) != basename($oObject->oxarticles__oxicon->value) ) {
                $aDelPics[] = array("sField"    => "oxpic1",
                                    "sDir"      => $oUtilsFile->getImageDirByType( "ICO" ),
                                    "sFileName" => $this->getMainIconName( $sMasterImage ));
            }

            // deleting generated thumbnail picture if custom thumbnail
            // file name not equal with generated from master picture
            if ( $this->getThumbName( $sMasterImage ) != basename($oObject->oxarticles__oxthumb->value) ) {
                $aDelPics[] = array("sField"    => "oxpic1",
                                    "sDir"      => $oUtilsFile->getImageDirByType( "TH" ),
                                    "sFileName" => $this->getThumbName( $sMasterImage ));
            }
        }

        foreach ( $aDelPics as $aPic ) {
            $myUtilsPic->safePictureDelete( $aPic["sFileName"], $myConfig->getAbsDynImageDir() . $aPic["sDir"], "oxarticles", $aPic["sField"] );
        }

        //deleting custom zoom pic (compatibility mode)
        if ( $oObject->{"oxarticles__oxzoom".$iIndex}->value ) {
            if ( basename($oObject->{"oxarticles__oxzoom".$iIndex}->value) !== "nopic.jpg" ) {
                // deleting old zoom picture
                $this->deleteZoomPicture( $oObject, $iIndex );
            }
        }

    }

    public function deleteMainIcon( $oObject )
    {
        $oDB        = oxDb::getDb( true );
        $myConfig   = $this->getConfig();
        $myUtilsPic = oxUtilsPic::getInstance();
        $oUtilsFile = oxUtilsFile::getInstance();

        $sMainIcon = $oObject->oxarticles__oxicon->value;

        if ( !$sMainIcon ) {
            return;
        }

        $aDelPics = array();
        $sAbsDynImageDir = $myConfig->getAbsDynImageDir();

        $aDelPics = array();

        // deleting article main icon and thumb picture
        $aPic = array("sField"    => "oxicon",
                      "sDir"      => $oUtilsFile->getImageDirByType( "ICO" ),
                      "sFileName" => $sMainIcon);

        $myUtilsPic->safePictureDelete( $aPic["sFileName"], $myConfig->getAbsDynImageDir() . $aPic["sDir"], "oxarticles", $aPic["sField"] );
    }

    public function deleteThumbnail( $oObject )
    {
        $oDB        = oxDb::getDb( true );
        $myConfig   = $this->getConfig();
        $myUtilsPic = oxUtilsPic::getInstance();
        $oUtilsFile = oxUtilsFile::getInstance();

        $aDelPics = array();
        $sAbsDynImageDir = $myConfig->getAbsDynImageDir();
        $sThumb = $oObject->oxarticles__oxthumb->value;

        if ( !$sThumb ) {
            return;
        }

        $aDelPics = array();

        // deleting article main icon and thumb picture
        $aPic = array("sField"    => "oxthumb",
                      "sDir"      => $oUtilsFile->getImageDirByType( "TH" ),
                      "sFileName" => $sThumb);

        $myUtilsPic->safePictureDelete( $aPic["sFileName"], $myConfig->getAbsDynImageDir() . $aPic["sDir"], "oxarticles", $aPic["sField"] );
    }

    public function deleteZoomPicture( $oObject, $iIndex )
    {
        // checking if oxzoom field exists
        $oDbHandler = oxNew( "oxDbMetaDataHandler" );
        $iZoomPicCount = (int) $this->getConfig()->getConfigParam( 'iZoomPicCount' );

        if ( $iIndex > $iZoomPicCount || !$oDbHandler->fieldExists( "oxzoom".$iIndex, "oxarticles" ) ) {
            return;
        }

        $oDB        = oxDb::getDb( true );
        $myConfig   = $this->getConfig();
        $myUtilsPic = oxUtilsPic::getInstance();
        $oUtilsFile = oxUtilsFile::getInstance();

        $aDelPics = array();
        $sAbsDynImageDir = $myConfig->getAbsDynImageDir();
        $sZoomPicName = basename($oObject->{"oxarticles__oxzoom".$iIndex}->value);

        if ( !$sZoomPicName ) {
            return;
        }

        $aDelPics = array();

        // deleting zoom picture
        $aPic = array("sField"    => "oxzoom".$iIndex,
                      "sDir"      => $oUtilsFile->getImageDirByType( "Z".$iIndex ),
                      "sFileName" => $sZoomPicName);

        $myUtilsPic->safePictureDelete( $aPic["sFileName"], $myConfig->getAbsDynImageDir() . $aPic["sDir"], "oxarticles", $aPic["sField"] );
    }

    public function getIconName( $sFilename )
    {
        $sIconName = preg_replace( '/(\.jpg|\.gif|\.png)$/i', '_ico\\1', basename($sFilename) );

        return $sIconName;
    }

    public function getMainIconName( $sMasterImageFile )
    {
        $sMasterImageFile = $this->_getBaseMasterImageFileName( $sMasterImageFile );
        $sIconName = preg_replace( '/(\.jpg|\.gif|\.png)$/i', '_ico\\1', $sMasterImageFile );

        return $sIconName;
    }

    public function getThumbName( $sMasterImageFile )
    {
        $sMasterImageFile = $this->_getBaseMasterImageFileName( $sMasterImageFile );
        $sThumbName = preg_replace( '/(\.jpg|\.gif|\.png)$/i', '_th\\1', $sMasterImageFile );

        return $sThumbName;
    }

    public function getZoomName( $sMasterImageFile, $iIndex )
    {
        $sMasterImageFile = $this->_getBaseMasterImageFileName( $sMasterImageFile );
        $sZoomName = preg_replace( '/(\.jpg|\.gif|\.png)$/i', '_z'.$iIndex.'\\1', $sMasterImageFile );

        return $sZoomName;
    }

    protected function _getBaseMasterImageFileName( $sMasterImageFile )
    {
        $sMasterImageFile = preg_replace( '/_p\d+(\.jpg|\.gif|\.png)$/i', '\\1', $sMasterImageFile );

        return basename( $sMasterImageFile );
    }
}