modules/ModuleBuilder/MB/MBPackage.php

Show:

inherited

Classes
- \MBPackage

Table of Contents

\MBPackage
jump to top

Package:

Properties


                 $author= ''''

Default value''Details

Type: n/a


                 $date_modified= ''''

Default value''Details

Type: n/a


                 $description= ''''

Default value''Details

Type: n/a


                 $has_images= 'true'

Default valuetrueDetails

Type: n/a


                 $is_uninstallable= 'true'

Default valuetrueDetails

Type: n/a


                 $key= ''''

Default value''Details

Type: n/a


                 $modules= 'array()'

Default valuearray()Details

Type: n/a


                 $name= ''

Details

Type: n/a


                 $readme= ''''

Default value''Details

Type: n/a

Methods

MBPackage(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

build(
           $export
              =
              true,  $clean
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$export
$clean

buildInstall(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

convertLangFilesToExtensions(
           $langDir
          )
        
        :
          void

Parameters

Name	Type	Description
$langDir

copy(
           $new_name
          )
        
        :
          void

Parameters

Name	Type	Description
$new_name

copyCustomDropdownValuesForModules(
           $modules,  $path
          )
        
        :
          void

Parameters

Name	Type	Description
$modules
$path

customBuildInstall(
           $modules,  $path,  $extensions
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$modules
$path
$extensions

delete(
          
          )
        
        :
          void

deleteBuild(
          
          )
        
        :
          void

deleteModule(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

exportCustom(
           $modules,  $export
              =
              true,  $clean
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$modules
$export
$clean

exportProject(
           $package,  $export
              =
              true,  $clean
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$export
$clean

exportProjectInstall(
           $package,  $for_export
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$for_export

filterExportedRelationshipFile(
          \$fn $fn, \$module $module, \$includeRelationship $includeRelationships
          )
        
        :
          boolean

Processes the name of the file and compares against the passed in module names to evaluate whether the file should be included for export. Returns true or false

Parameters

Name	Type	Description
$fn	\$fn	(file name that is being evaluated)
$module	\$module	(name of current module being evaluated)
$includeRelationships	\$includeRelationship	(list of related modules that are also being exported, to be used as filters)

Returns

Type	Description
boolean	true or false

getBuildDir(
          
          )
        
        :
          void

getColumnsName(
          
          )
        
        :
          void

getCustomDropDownStringsForModules(
           $modules,  $list_strings
          )
        
        :
          void

Parameters

Name	Type	Description
$modules
$list_strings

getCustomFieldsManifestForModule(
           $module,  $installdefs
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$installdefs

getCustomMetadataManifestForModule(
           $module,  $installdefs
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$installdefs

getCustomModules(
           $module
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$module

getCustomRelationshipsByModuleName(
          string $moduleName, bool $lhs
              =
              false
          )
        
        :
          mixed

This returns an UNFILTERED list of custom relationships by module name. You will have to filter the relationships by the modules being exported after calling this method

Parameters

Name	Type	Description
$moduleName	string
$lhs	bool	Return relationships where $moduleName - left module in join.

Returns

Type	Description
mixed	Array or false when module name is wrong.

getCustomRelationshipsMetaFilesByModuleName(
          string $moduleName, bool $lhs
              =
              false, bool $metadataOnly
              =
              false, \$includeRelationship $exportedModulesFilter
              =
              array()
          )
        
        :
          array

Parameters

Name	Type	Description
$moduleName	string
$lhs	bool	Return relationships where $moduleName - left module in join.
$metadataOnly	bool	Return only relationships metadata file.
$exportedModulesFilter	\$includeRelationship	(list of related modules that are also being exported)

Returns

Type	Description
array	(array of relationships filtered to only include relationships to modules being exported)

getExtensionsList(
          array $module, mixed $includeRelationships
              =
              true
          )
        
        :
          array

Get _custom_ extensions for module.

Default path - custom/Extension/modules/$module/Ext.

Parameters

Name	Type	Description
$module	array	Name.
$includeRelationships	mixed	ARRAY - relationships files between $module and names in array; TRUE - with all relationships files;

Returns

Type	Description
array	Paths.

getExtensionsManifestForPackage(
          string $path, array $installdefs
          )
        
        :
          void

Parameters

Name	Type	Description
$path	string
$installdefs	array	link

Details

Todo: private changed protected for testing purposes.

getLanguageManifestForModule(
           $module,  $installdefs
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$installdefs

getManifest(
           $version_specific
              =
              false,  $for_export
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version_specific
$for_export

getModule(
           $name, bool $force
              =
              true
          )
        
        :
          \MBModule

Parameters

Name	Type	Description
$name
$force	bool

Returns

Type	Description
\MBModule

getModuleByFullName(
          string $name
          )
        
        :
          \MBModule

Returns an MBModule by the given full name (package key + module name) if it exists in this package

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\MBModule

getNodes(
          
          )
        
        :
          void

getPackageDir(
          
          )
        
        :
          void

getRelationshipsForModule(
          \$moduleName $moduleName
          )
        
        :
          array

Returns a set of field defs for fields that will exist when this package is deployed based on the relationships in all of its modules.

Parameters

Name	Type	Description
$moduleName	\$moduleName	(module must be from whithin this package)

Returns

Type	Description
array	Field defs

getZipDir(
          
          )
        
        :
          void

loadModuleTitles(
          \$languge $languge
              =
              ''
          )
        
        :

Loads the translated module titles from the selected language into.

Will override currently loaded string to reflect undeployed label changes. $app_list_strings

Parameters

Name	Type	Description
$languge	\$languge	String language identifyer

loadModules(
           $force
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$force

populateFromPost(
          
          )
        
        :
          void

rename(
           $new_name
          )
        
        :
          void

Parameters

Name	Type	Description
$new_name

updateModulesMetaData(
           $save
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$save

modules/ModuleBuilder/MB/MBPackage.php

\MBPackagejump to top

Properties

Methods

\MBPackage
jump to top