core/src/CmsDefinition.php at master · dms-org/core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?php declare(strict_types = 1);

namespace Dms\Core;

/**
 * The cms definition class.
 *
 * @author Elliot Levin <elliotlevin@hotmail.com>
 */
class CmsDefinition
{
    /**
     * @var string[]
     */
    protected $namePackageMap = [];

    /**
     * CmsDefinition constructor.
     */
    public function __construct()
    {
    }

    /**
     * Defines the list of installed packages within this cms.
     *
     * Example:
     * <code>
     * $cms->packages([
     *      'some-package-name' => SomePackage::class,
     * ]);
     * </code>
     *
     * @param array $namePackageMap
     *
     * @return void
     */
    public function packages(array $namePackageMap)
    {
        $this->namePackageMap += $namePackageMap;
    }

    /**
     * @return FinalizedCmsDefinition
     */
    public function finalize() : FinalizedCmsDefinition
    {
        return new FinalizedCmsDefinition($this->namePackageMap);
    }
}