Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractLayoutClass
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 2
2
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 __invoke
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
0
1<?php
2
3/**
4 * Helper class for managing high-level (body vs. sidebar) page layout.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2011.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  View_Helpers
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\View\Helper;
31
32/**
33 * Helper class for managing high-level (body vs. sidebar) page layout.
34 *
35 * @category VuFind
36 * @package  View_Helpers
37 * @author   Demian Katz <demian.katz@villanova.edu>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development Wiki
40 */
41abstract class AbstractLayoutClass extends \Laminas\View\Helper\AbstractHelper
42{
43    /**
44     * Constructor
45     *
46     * @param bool $sidebarOnLeft Does the sidebar go on the left?
47     * @param bool $offcanvas     Is offcanvas menu active?
48     * @param bool $rtl           Are we in right-to-left mode?
49     */
50    public function __construct(
51        protected bool $sidebarOnLeft = false,
52        protected bool $offcanvas = false,
53        protected bool $rtl = false
54    ) {
55    }
56
57    /**
58     * Helper to allow easily configurable page layout -- given a broad class
59     * name, return appropriate CSS classes to lay out the page according to
60     * the current configuration file settings.
61     *
62     * @param string $class Type of class to return ('mainbody' or 'sidebar')
63     *
64     * @return string       CSS classes to apply
65     */
66    abstract public function __invoke($class);
67}