Detailed Description
Modules list class. 
Definition at line 9 of file oxmodulelist.php.
Member Function Documentation
  
  
      
        
          | oxModuleList::_extendsClasses  | 
          ( | 
            | 
          $sModuleDir | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Checks if module extends any shop class.
- Parameters
 - 
  
    | string | $sModuleDir | dir path | 
  
   
- Returns
 - bool 
 
Definition at line 662 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_getInvalidExtensions  | 
          ( | 
            | 
          $sModuleId | ) | 
           | 
         
       
   | 
  
private   | 
  
 
Returns invalid extensions array by module id.
- Parameters
 - 
  
  
 
- Returns
 - array 
 
Definition at line 718 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_getModuleIdsFromExtensions  | 
          ( | 
            | 
          $aData | ) | 
           | 
         
       
   | 
  
private   | 
  
 
Returns module ids which have extensions.
- Parameters
 - 
  
  
 
- Returns
 - array 
 
Definition at line 697 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_isVendorDir  | 
          ( | 
            | 
          $sModuleDir | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Checks if directory is vendor directory.
- Parameters
 - 
  
    | string | $sModuleDir | dir path | 
  
   
- Returns
 - bool 
 
Definition at line 646 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeExtensions  | 
          ( | 
            | 
          $aModuleIds | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension by given modules ids.
- Parameters
 - 
  
    | array | $aModuleIds | Modules ids which must be deleted from config.  | 
  
   
Definition at line 364 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromDatabase  | 
          ( | 
            | 
          $aDeletedExtIds | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from database - oxConfig, oxConfigDisplay and oxTplBlocks tables
- Parameters
 - 
  
    | array | $aDeletedExtIds | deleted extensions ID's | 
  
   
- Returns
 - null 
 
Definition at line 488 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromDisabledModulesArray  | 
          ( | 
            | 
          $aDeletedExtIds | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from disabled modules array
- Parameters
 - 
  
    | array | $aDeletedExtIds | Deleted extension id's of array  | 
  
   
Definition at line 383 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromModulesEventsArray  | 
          ( | 
            | 
          $aDeletedModule | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from modules events array
- Parameters
 - 
  
    | array | $aDeletedModule | deleted extensions ID's  | 
  
   
Definition at line 432 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromModulesFilesArray  | 
          ( | 
            | 
          $aDeletedModule | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from modules files array
- Parameters
 - 
  
    | array | $aDeletedModule | deleted extensions ID's  | 
  
   
Definition at line 450 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromModulesPathsArray  | 
          ( | 
            | 
          $aDeletedModule | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from modules paths array
- Parameters
 - 
  
    | array | $aDeletedModule | deleted extensions ID's  | 
  
   
Definition at line 396 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromModulesTemplatesArray  | 
          ( | 
            | 
          $aDeletedModule | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from modules templates array
- Parameters
 - 
  
    | array | $aDeletedModule | deleted extensions ID's  | 
  
   
Definition at line 468 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_removeFromModulesVersionsArray  | 
          ( | 
            | 
          $aDeletedModule | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
Removes extension from modules versions array
- Parameters
 - 
  
    | array | $aDeletedModule | deleted extensions ID's  | 
  
   
Definition at line 414 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_saveModulePath  | 
          ( | 
            | 
          $sModuleId,  | 
         
        
           | 
           | 
            | 
          $sModulePath  | 
         
        
           | 
          ) | 
           |  | 
         
       
   | 
  
protected   | 
  
 
Saving module path info. Module path is saved to config variable "aModulePaths".
- Parameters
 - 
  
  
 
Definition at line 682 of file oxmodulelist.php.
 
 
  
  
      
        
          | oxModuleList::_sortModules  | 
          ( | 
            | 
          $oModule1,  | 
         
        
           | 
           | 
            | 
          $oModule2  | 
         
        
           | 
          ) | 
           |  | 
         
       
   | 
  
protected   | 
  
 
Callback function for sorting module objects by name.
- Parameters
 - 
  
    | object | $oModule1 | module object  | 
    | object | $oModule2 | module object | 
  
   
- Returns
 - bool 
 
Definition at line 634 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::buildModuleChains  | 
          ( | 
            | 
          $aModuleArray | ) | 
           | 
        
      
 
Build module chains from nested array
- Parameters
 - 
  
    | array | $aModuleArray | Module array (nested format) | 
  
   
- Returns
 - array 
 
Definition at line 337 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::cleanup  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::diffModuleArrays  | 
          ( | 
            | 
          $aAllModuleArray,  | 
        
        
           | 
           | 
            | 
          $aRemModuleArray  | 
        
        
           | 
          ) | 
           |  | 
        
      
 
Diff two nested module arrays together so that the values of $aRmModuleArray are removed from $aAllModuleArray
- Parameters
 - 
  
    | array | $aAllModuleArray | All Module array (nested format)  | 
    | array | $aRemModuleArray | Remove Module array (nested format) | 
  
   
- Returns
 - array 
 
Definition at line 301 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::extractModulePaths  | 
          ( | 
           | ) | 
           | 
        
      
 
Extract module id's with paths from extended classes.
- Returns
 - array 
 
Definition at line 157 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getActiveModuleInfo  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getDeletedExtensions  | 
          ( | 
           | ) | 
           | 
        
      
 
Checks module list - if there is extensions that are registered, but extension directory is missing
- Returns
 - array 
 
Definition at line 269 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getDisabledModuleClasses  | 
          ( | 
           | ) | 
           | 
        
      
 
Returns disabled module classes with path using config aModules and aModulePaths. aModules has all extended classes aModulePaths has module id to main path array
- Returns
 - array 
 
Definition at line 202 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getDisabledModuleInfo  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getDisabledModules  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getList  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModule  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleEvents  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleExtensions  | 
          ( | 
            | 
          $sModuleId | ) | 
           | 
        
      
 
Returns module extensions.
- Parameters
 - 
  
  
 
- Returns
 - array 
 
Definition at line 607 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getModuleFiles  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleIds  | 
          ( | 
           | ) | 
           | 
        
      
 
Returns module ids which have extensions or files.
- Returns
 - array 
 
Definition at line 592 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getModulePaths  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModules  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModulesFromDir  | 
          ( | 
            | 
          $sModulesDir,  | 
        
        
           | 
           | 
            | 
          $sVendorDir = null  | 
        
        
           | 
          ) | 
           |  | 
        
      
 
Scans modules dir and returns collected modules list. Recursively loads also modules that are in vendor directory.
- Parameters
 - 
  
    | string | $sModulesDir | Main module dir path  | 
    | string | $sVendorDir | Vendor directory name | 
  
   
- Returns
 - array 
 
Definition at line 523 of file oxmodulelist.php.
 
 
      
        
          | oxModuleList::getModulesWithExtendedClass  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleTemplates  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleValidatorFactory  | 
          ( | 
           | ) | 
           | 
        
      
 
 
      
        
          | oxModuleList::getModuleVersions  | 
          ( | 
           | ) | 
           | 
        
      
 
 
Member Data Documentation
  
  
      
        
          | oxModuleList::$_aModuleExtensions = null | 
         
       
   | 
  
protected   | 
  
 
 
  
  
      
        
          | oxModuleList::$_aModules = array() | 
         
       
   | 
  
protected   | 
  
 
 
  
  
      
        
          | oxModuleList::$_aSkipFiles = array('functions.php', 'vendormetadata.php') | 
         
       
   | 
  
protected   | 
  
 
 
The documentation for this class was generated from the following file: