#106 - rename transcoder class

image_transcoder.php

@@ -24,8 +24,8 @@ require_once('./inc/header.inc.php');
 $sTranscoderObject = bx_process_input(bx_get('o'));
 $sHandler = bx_process_input(bx_get('h'));
 
-bx_import('BxDolImageTranscoder');
-$oTranscoder = BxDolImageTranscoder::getObjectInstance($sTranscoderObject);
+bx_import('BxDolTranscoderImage');
+$oTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoderObject);
 
 if (!$oTranscoder) {
     ob_end_clean();

inc/classes/BxDolCronPruning.php

@@ -55,8 +55,8 @@ class BxDolCronPruning extends BxDolCron
         $iDeletedExpiredTokens = BxDolStorage::pruning();
 
         // clean outdated transcoded images
-        bx_import('BxDolImageTranscoder');
-        $iDeletedTranscodedImages = BxDolImageTranscoder::pruning();
+        bx_import('BxDolTranscoderImage');
+        $iDeletedTranscodedImages = BxDolTranscoderImage::pruning();
 
         // clean expired keys
         bx_import('BxDolKey');

inc/classes/BxDolImageTranscoder.php → inc/classes/BxDolTranscoderImage.php

@@ -8,12 +8,12 @@
  */
 
 bx_import('BxDolStorage');
-bx_import('BxDolImageTranscoderQuery');
+bx_import('BxDolTranscoderImageQuery');
 
 /**
  * @page objects
- * @section images_transcoder Images Transcoder
- * @ref BxDolImageTranscoder
+ * @section transcoder)images Images Transcoder
+ * @ref BxDolTranscoderImage
  */
 
 /**
@@ -73,15 +73,15 @@ bx_import('BxDolImageTranscoderQuery');
  *
  * Example of usage:
  * @code
- * bx_import('BxDolImageTranscoder');
- * $oTranscoder = BxDolImageTranscoder::getObjectInstance('bx_images_thumb'); // change images transcode object name to your own
+ * bx_import('BxDolTranscoderImage');
+ * $oTranscoder = BxDolTranscoderImage::getObjectInstance('bx_images_thumb'); // change images transcode object name to your own
  * $oTranscoder->registerHandlers(); // make sure to call it only once! before the first usage, no need to call it every time
  * $sTranscodedImageUrl = $oTranscoder->getImageUrl('my_dog.jpg'); // the name of file, in the case of 'Folder' storage type this is file name
  * echo 'My dog : <img src="' . $sUrl . '" />'; // transcoded(resized and/or grayscaled) image will be shown, according to the specified filters
  * @endcode
  *
  */
-class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
+class BxDolTranscoderImage extends BxDol implements iBxDolFactoryObject
 {
     protected $_aObject; ///< object properties
     protected $_oStorage; ///< storage object, transcoded images are stored here
@@ -96,21 +96,21 @@ class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
         parent::__construct();
         $this->_aObject = $aObject;
         $this->_oStorage = $oStorage;
-        $this->_oDb = new BxDolImageTranscoderQuery($aObject);
+        $this->_oDb = new BxDolTranscoderImageQuery($aObject);
     }
 
     /**
      * Get image transcode object instance.
      * @param $sObject - name of trancode object.
-     * @return false on error or instance of BxDolImageTranscoder class.
+     * @return false on error or instance of BxDolTranscoderImage class.
      */
     public static function getObjectInstance($sObject)
     {
-        if (isset($GLOBALS['bxDolClasses']['BxDolImageTranscoder!'.$sObject]))
-            return $GLOBALS['bxDolClasses']['BxDolImageTranscoder!'.$sObject];
+        if (isset($GLOBALS['bxDolClasses']['BxDolTranscoderImage!'.$sObject]))
+            return $GLOBALS['bxDolClasses']['BxDolTranscoderImage!'.$sObject];
 
         // get transcode object
-        $aObject = BxDolImageTranscoderQuery::getTranscoderObject($sObject);
+        $aObject = BxDolTranscoderImageQuery::getTranscoderObject($sObject);
         if (!$aObject || !is_array($aObject))
             return false;
 
@@ -125,9 +125,9 @@ class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
             return false;
 
         // create instance
-        $o = new BxDolImageTranscoder($aObject, $oStorage);
+        $o = new BxDolTranscoderImage($aObject, $oStorage);
 
-        return ($GLOBALS['bxDolClasses']['BxDolImageTranscoder!'.$sObject] = $o);
+        return ($GLOBALS['bxDolClasses']['BxDolTranscoderImage!'.$sObject] = $o);
     }
 
     /**
@@ -138,11 +138,11 @@ class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
     static public function pruning ()
     {
         $iCount = 0;
-        $aObjects = BxDolImageTranscoderQuery::getTranscoderObjects ();
+        $aObjects = BxDolTranscoderImageQuery::getTranscoderObjects ();
         foreach ($aObjects as $aObject) {
             if (!$aObject['atime_tracking'] || !$aObject['atime_pruning'])
                 continue;
-            $oTranscoder = BxDolImageTranscoder::getObjectInstance($aObject['object']);
+            $oTranscoder = BxDolTranscoderImage::getObjectInstance($aObject['object']);
             if (!$oTranscoder)
                 continue;
             $iCount += $oTranscoder->prune();
@@ -185,7 +185,7 @@ class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
      */
     static public function onAlertResponseFileDeleteLocal ($oAlert, $sObject)
     {
-        $oTranscoder = BxDolImageTranscoder::getObjectInstance($sObject);
+        $oTranscoder = BxDolTranscoderImage::getObjectInstance($sObject);
         if (!$oTranscoder)
             return;
 
@@ -200,7 +200,7 @@ class BxDolImageTranscoder extends BxDol implements iBxDolFactoryObject
      */
     static public function onAlertResponseFileDeleteOrig ($oAlert, $sObject)
     {
-        $oTranscoder = BxDolImageTranscoder::getObjectInstance($sObject);
+        $oTranscoder = BxDolTranscoderImage::getObjectInstance($sObject);
         if (!$oTranscoder)
             return;
 

inc/classes/BxDolImageTranscoderQuery.php → inc/classes/BxDolTranscoderImageQuery.php

@@ -10,9 +10,9 @@
 bx_import('BxDolDb');
 
 /**
- * @see BxDolImageTranscoder
+ * @see BxDolTranscoderImage
  */
-class BxDolImageTranscoderQuery extends BxDolDb
+class BxDolTranscoderImageQuery extends BxDolDb
 {
     protected $_aObject;
 

inc/classes/BxDolUploader.php

@@ -320,8 +320,8 @@ abstract class BxDolUploader extends BxDol
 
         $oImagesTranscoder = false;
         if ($sImagesTranscoder) {
-            bx_import('BxDolImageTranscoder');
-            $oImagesTranscoder = BxDolImageTranscoder::getObjectInstance($sImagesTranscoder);
+            bx_import('BxDolTranscoderImage');
+            $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sImagesTranscoder);
         }
 
         $a = '';

modules/base/general/classes/BxBaseModGeneralInstaller.php

@@ -11,7 +11,7 @@
 
 bx_import('BxDolStudioInstaller');
 bx_import('BxDolStorage');
-bx_import('BxDolImageTranscoder');
+bx_import('BxDolTranscoderImage');
 bx_import('BxDolService');
 
 class BxBaseModGeneralInstaller extends BxDolStudioInstaller
@@ -36,7 +36,7 @@ class BxBaseModGeneralInstaller extends BxDolStudioInstaller
         if (!$aResult['result']) // proces further only in case of successful enable
             return $aResult;
 
-        BxDolImageTranscoder::registerHandlersArray($this->_aTranscoders);
+        BxDolTranscoderImage::registerHandlersArray($this->_aTranscoders);
 
         if ($this->_aMenuTriggers) {
             bx_import('BxDolMenu');
@@ -49,13 +49,13 @@ class BxBaseModGeneralInstaller extends BxDolStudioInstaller
 
     function disable($aParams)
     {
-        BxDolImageTranscoder::unregisterHandlersArray($this->_aTranscoders);
-        BxDolImageTranscoder::cleanupObjectsArray($this->_aTranscoders);
+        BxDolTranscoderImage::unregisterHandlersArray($this->_aTranscoders);
+        BxDolTranscoderImage::cleanupObjectsArray($this->_aTranscoders);
 
         $aResult = parent::disable($aParams);
 
         if (!$aResult['result']) // we need to register it back if disabling failed
-            BxDolImageTranscoder::registerHandlersArray($this->_aTranscoders);
+            BxDolTranscoderImage::registerHandlersArray($this->_aTranscoders);
 
         return $aResult;
     }

modules/base/profile/classes/BxBaseModProfileFormEntry.php

@@ -10,6 +10,7 @@
  */
 
 bx_import('BxBaseModGeneralFormEntry');
+bx_import('BxDolTranscoderImage');
 
 /**
  * Create/edit profile form.
@@ -75,7 +76,7 @@ class BxBaseModProfileFormEntry extends BxBaseModGeneralFormEntry
             if (!isset($this->aInputs[$aVals['field_preview']]) || !empty($this->aInputs[$aVals['field_preview']]['content']))
                 continue;
 
-            $oTranscoder = BxDolImageTranscoder::getObjectInstance($aVals['images_transcoder']);
+            $oTranscoder = BxDolTranscoderImage::getObjectInstance($aVals['images_transcoder']);
 
             $aVars = array (
                 'bx_if:picture' => array (

modules/base/profile/classes/BxBaseModProfileTemplate.php

@@ -169,8 +169,8 @@ class BxBaseModProfileTemplate extends BxBaseModGeneralTemplate
     {
         $sImageUrl = false;
         if ($aData[$sField]) {
-            bx_import('BxDolImageTranscoder');
-            $oImagesTranscoder = BxDolImageTranscoder::getObjectInstance($sTranscodeObject);
+            bx_import('BxDolTranscoderImage');
+            $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscodeObject);
             if ($oImagesTranscoder)
                 $sImageUrl = $oImagesTranscoder->getImageUrl($aData[$sField]);
         }

modules/base/text/classes/BxBaseModTextTemplate.php

@@ -36,8 +36,8 @@ class BxBaseModTextTemplate extends BxBaseModGeneralTemplate
         // get thumb url
         $sPhotoThumb = '';
         if ($aData[$CNF['FIELD_THUMB']]) {
-            bx_import('BxDolImageTranscoder');
-            $oImagesTranscoder = BxDolImageTranscoder::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']);
+            bx_import('BxDolTranscoderImage');
+            $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']);
             if ($oImagesTranscoder)
                 $sPhotoThumb = $oImagesTranscoder->getImageUrl($aData[$CNF['FIELD_THUMB']]);
         }
@@ -159,10 +159,10 @@ class BxBaseModTextTemplate extends BxBaseModGeneralTemplate
 
         bx_import('BxTemplFunctions');
         bx_import('BxDolStorage');
-        bx_import('BxDolImageTranscoder');
+        bx_import('BxDolTranscoderImage');
 
         $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']);
-        $oTranscoder = BxDolImageTranscoder::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']);
+        $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']);
 
         $aGhostFiles = $oStorage->getGhosts ($aData[$CNF['FIELD_AUTHOR']], $aData[$CNF['FIELD_ID']]);
         if (!$aGhostFiles)

modules/boonex/organizations/classes/BxOrgsFormEntry.php

@@ -12,7 +12,6 @@
 bx_import('BxBaseModProfileFormEntry');
 bx_import('BxDolProfile');
 bx_import('BxDolStorage');
-bx_import('BxDolImageTranscoder');
 
 /**
  * Create/Edit Organization Form.

modules/boonex/persons/classes/BxPersonsFormEntry.php

@@ -12,7 +12,6 @@
 bx_import('BxBaseModProfileFormEntry');
 bx_import('BxDolProfile');
 bx_import('BxDolStorage');
-bx_import('BxDolImageTranscoder');
 
 /**
  * Create/Edit Person Form.

modules/boonex/timeline/classes/BxTimelineTemplate.php

@@ -798,8 +798,8 @@ class BxTimelineTemplate extends BxBaseModNotificationsTemplate
                     bx_import('BxDolStorage');
                     $oStorage = BxDolStorage::getObjectInstance($this->_oConfig->getObject('storage'));
 
-                    bx_import('BxDolImageTranscoder');
-                    $oTranscoder = BxDolImageTranscoder::getObjectInstance($this->_oConfig->getObject('transcoder_view'));
+                    bx_import('BxDolTranscoderImage');
+                    $oTranscoder = BxDolTranscoderImage::getObjectInstance($this->_oConfig->getObject('transcoder_view'));
 
                     foreach($aPhotos as $iPhotoId) {
                         $iPhotoIndex = array_search($iPhotoId, $aPhotos);

samples/transcoder.php

@@ -65,8 +65,8 @@ function PageCompMainCode()
     ob_start();
 
     $iProfileId = 123;
-    bx_import('BxDolImageTranscoder');
-    $oTranscoder = BxDolImageTranscoder::getObjectInstance('sample');
+    bx_import('BxDolTranscoderImage');
+    $oTranscoder = BxDolTranscoderImage::getObjectInstance('sample');
     if (!$oTranscoder)
         die('Transcoder object isn\'t defined');
 

studio/template/scripts/BxBaseStudioDesigner.php

@@ -219,9 +219,9 @@ class BxBaseStudioDesigner extends BxDolStudioDesigner
                 BX_DOL_TRANSCODER_OBJ_ICON_FAVICON => '_adm_dsg_txt_icon_favicon'
             );
 
-            bx_import('BxDolImageTranscoder');
+            bx_import('BxDolTranscoderImage');
             foreach($aTranscoders as $sTranscoder => $sTitle) {
-                $oTranscoder = BxDolImageTranscoder::getObjectInstance($sTranscoder);
+                $oTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoder);
 
                 $sImageUrl = $oTranscoder->getImageUrl($iId);
                 if($sImageUrl === false) {

template/scripts/BxBaseCmts.php

@@ -227,8 +227,8 @@ class BxBaseCmts extends BxDolCmts
                 bx_import('BxDolStorage');
         		$oStorage = BxDolStorage::getObjectInstance($this->getStorageObjectName());
 
-            	bx_import('BxDolImageTranscoder');
-                $oTranscoder = BxDolImageTranscoder::getObjectInstance($this->getTranscoderPreviewName());
+            	bx_import('BxDolTranscoderImage');
+                $oTranscoder = BxDolTranscoderImage::getObjectInstance($this->getTranscoderPreviewName());
 
                 foreach($aImages as $aImage)
                     $aTmplImages[] = array(

template/scripts/BxBaseFunctions.php

@@ -307,18 +307,18 @@ class BxBaseFunctions extends BxDol implements iBxDolSingleton
         $sImageUrlFav = $sImageUrlFcb = $sImageUrlApl = '';
 
         if(!empty($iId)) {
-            bx_import('BxDolImageTranscoder');
+            bx_import('BxDolTranscoderImage');
 
             // favicon icon
-            $oTranscoder = BxDolImageTranscoder::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FAVICON);
+            $oTranscoder = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FAVICON);
             $sImageUrlFav = $oTranscoder->getImageUrl($iId);
 
             // facebook icon
-            $oTranscoder = BxDolImageTranscoder::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK);
+            $oTranscoder = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK);
             $sImageUrlFcb = $oTranscoder->getImageUrl($iId);
 
             // apple touch icon
-            $oTranscoder = BxDolImageTranscoder::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_APPLE);
+            $oTranscoder = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_APPLE);
             $sImageUrlApl = $oTranscoder->getImageUrl($iId);
         }
 

template/scripts/BxBaseImageServices.php

@@ -19,14 +19,14 @@ class BxBaseImageServices extends BxDol
 
     public function serviceAlertResponseFileDeleteLocal($oAlert, $sObject)
     {
-        bx_import('BxDolImageTranscoder');
-        BxDolImageTranscoder::onAlertResponseFileDeleteLocal($oAlert, $sObject);
+        bx_import('BxDolTranscoderImage');
+        BxDolTranscoderImage::onAlertResponseFileDeleteLocal($oAlert, $sObject);
     }
 
     public function serviceAlertResponseFileDeleteOrig($oAlert, $sObject)
     {
-        bx_import('BxDolImageTranscoder');
-        BxDolImageTranscoder::onAlertResponseFileDeleteOrig($oAlert, $sObject);
+        bx_import('BxDolTranscoderImage');
+        BxDolTranscoderImage::onAlertResponseFileDeleteOrig($oAlert, $sObject);
     }
 }