blackcube/core

Blackcube CMS Core system

3.5.1 2024-10-30 21:07 UTC

Requires

• php: >=8.0
• ext-dom: *
• ext-fileinfo: *
• ext-intl: *
• ext-json: *
• ext-xmlreader: *
• hashids/hashids: ~4.1
• league/flysystem: ^2.4
• swaggest/json-schema: ~0.12
• vlucas/phpdotenv: ~5.4
• yiisoft/yii2: ~2.0.13
• yiisoft/yii2-imagine: ~2.3

Requires (Dev)

• codeception/codeception: ~5.0
• codeception/module-asserts: ~2.0
• codeception/module-yii2: ~1.1
• league/flysystem-async-aws-s3: ^2.5
• league/flysystem-aws-s3-v3: ^2.5
• league/flysystem-ftp: ^2.4
• league/flysystem-google-cloud-storage: ^2.4
• league/flysystem-memory: ^3.0
• league/flysystem-sftp: ^2.4
• yiisoft/yii2-debug: ~2.1
• yiisoft/yii2-gii: ~2.2

proprietary

• Philippe Gaultier

• cms
• content management
• core
• yii
• yii2
• blackcube

README

Pre-requisites

• PHP 7.4+
  • Extension dom
  • Extension fileinfo
  • Extension intl
  • Extension json
  • Extension mbstring
• Apache or NginX

Pre-flight

Add blackcube core to the project

composer require "blackcube/core" 

Installation

Beware: Blackcube core can be used in stand alone but Blackcube admin is recommended

Inject Blackcube core in application

// main configuration file
   'container' => [
      'singletons' => [
         // local filesystem
         blackcube\core\components\Flysystem::class => [
            'class' => blackcube\core\components\FlysystemLocal::class,
            'path' => getstrenv('FILESYSTEM_LOCAL_PATH'),
         ],
         // or s3
         blackcube\core\components\Flysystem::class => [
            'class' => blackcube\core\components\FlysystemAwsS3::class,
           'key' => getstrenv('FILESYSTEM_S3_KEY'),
           'secret' => getstrenv('FILESYSTEM_S3_SECRET'),
           'bucket' => getstrenv('FILESYSTEM_S3_BUCKET'),
           'region' => getstrenv('FILESYSTEM_S3_REGION'),
           'version' => 'latest',
           'endpoint' => getstrenv('FILESYSTEM_S3_ENDPOINT'),
           'pathStyleEndpoint' => getboolenv('FILESYSTEM_S3_PATH_STYLE'),
         ],
      ]
   ],
// ...
    'bootstrap' => [
        // ... boostrapped modules
        'blackcube', // blackcube core
    ],
    'modules' => [
        // ... other modules
        'blackcube' => [
            'class' => blackcube\core\Module::class,
            'plugins' => [
               // additional plugins
            ],
            'cmsEnabledmodules' => [
               // additional modules
            ],
            'allowedParameterDomains' => ['],
            // override components if needed
            'components' => [
               'db' => ...
               'cache' => ...
               'fs' => ...
            ],
            /// end override
        ],
    ],
// ...

Update DB

Add needed tables in DB

php yii.php migrate

Init database with basic stuff

php yii.php bc:init

Blackcube core is now ready, you can use it