Zikula\GroupsModule\Helper\CommonHelper

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setTranslator()	0	4	1
A	gtypeLabels()	0	14	2
A	stateLabels()	0	13	2

<?php

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - http://zikula.org/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\GroupsModule\Helper;

use Zikula\Common\Translator\TranslatorInterface;
use Zikula\Common\Translator\TranslatorTrait;

/**
 * Common helper functions and constants.
 */
class CommonHelper
{
    use TranslatorTrait;
    /**
     * Constant value for core type groups.
     */
    const GTYPE_CORE = 0;

    /**
     * Constant value for public type groups.
     */
    const GTYPE_PUBLIC = 1;

    /**
     * Constant value for private type groups.
     */
    const GTYPE_PRIVATE = 2;

    /**
     * Constant value for groups in the Closed state (not accepting members).
     */
    const STATE_CLOSED = 0;

    /**
     * Constant value for groups in the Open state (accepting members).
     */
    const STATE_OPEN = 1;

    /**
     * Constructs an instance of this helper class.
     */
    public function __construct(TranslatorInterface $translator)
    {
        $this->setTranslator($translator);
    }

    public function setTranslator($translator)
    {
        $this->translator = $translator;
    }

    /**
     * Return the standard set of labels for Group types.
     *
     * @staticvar array $gtypeLabels The array of standard group type labels.
     *
     * @return array An associative array of group type labels indexed by group type constants
     */
    public function gtypeLabels()
    {
        static $gtypeLabels;

        if (!isset($gtypeLabels)) {
            $gtypeLabels = [
                self::GTYPE_CORE => $this->__('Core'),
                self::GTYPE_PUBLIC => $this->__('Public'),
                self::GTYPE_PRIVATE => $this->__('Private')
            ];
        }

        return $gtypeLabels;
    }

    /**
     * Return the standard set of labels for Group states.
     *
     * @staticvar array $stateLabels The array of standard state labels.
     *
     * @return array An associative array of state labels indexed by state constants
     */
    public function stateLabels()
    {
        static $stateLabels;

        if (!isset($stateLabels)) {
            $stateLabels = [
                self::STATE_CLOSED => $this->__('Closed'),
                self::STATE_OPEN => $this->__('Open')
            ];
        }

        return $stateLabels;
    }
}