GreenCape/joomla-manifest

View on GitHub
src/GreenCape/Manifest/Sections/SchemaSection.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * GreenCape Joomla Extension Manifests
 *
 * MIT License
 *
 * Copyright (c) 2014-2015, Niels Braczek <nbraczek@bsds.de>. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
 * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
 * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @package         GreenCape\Manifest
 * @author          Niels Braczek <nbraczek@bsds.de>
 * @copyright   (C) 2014-2015 GreenCape, Niels Braczek <nbraczek@bsds.de>
 * @license         http://opensource.org/licenses/MIT The MIT license (MIT)
 * @link            http://greencape.github.io
 * @since           File available since Release 0.1.0
 */

namespace GreenCape\Manifest;

/**
 * Schema Section
 *
 * @package GreenCape\Manifest
 * @author  Niels Braczek <nbraczek@bsds.de>
 * @since   Class available since Release 0.1.0
 */
class SchemaSection extends SqlSection
{
    protected $elementIndex;
    protected $driverIndex;
    protected $structureIndex;
    /** @var array The file list */
    protected $files = [];

    /**
     * Constructor
     *
     * @param array $data Optional XML structure to preset the manifest
     */
    public function __construct($data = null)
    {
        $this->structureIndex = 'schemas';
        $this->driverIndex    = '@type';
        $this->elementIndex   = 'schemapath';

        if ($data !== null) {
            $this->set($data);
        }
    }

    /**
     * Add a folder to the section
     *
     * @param string $driver     The name of a database driver
     * @param string $folder     The name of the folder
     * @param array  $attributes Optional attributes for this entry
     *
     * @return $this This object, to provide a fluent interface
     */
    public function addFolder($driver, $folder, $attributes = [])
    {
        $this->addFile($driver, $folder, $attributes);

        return $this;
    }

    /**
     * Remove a folder from the section
     *
     * @param string $folder The name of the folder
     *
     * @return $this This object, to provide a fluent interface
     */
    public function removeFolder($folder)
    {
        $this->removeFile($folder);

        return $this;
    }
}