Skip to content
Snippets Groups Projects
components_helper.php 13.2 KiB
Newer Older
  • Learn to ignore specific revisions
  • <?php
    
    /**
     * @copyright  2020 Podlibre
     * @license    https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
     * @link       https://castopod.org/
     */
    
    if (!function_exists('button')) {
        /**
         * Button component
         *
         * Creates a stylized button or button like anchor tag if the URL is defined.
         *
         * @param string           $label The button label
         * @param mixed|null       $uri URI string or array of URI segments
         * @param array            $customOptions button options: variant, size, iconLeft, iconRight
         * @param array            $customAttributes Additional attributes
         *
         * @return string
         */
        function button(
            string $label = '',
            $uri = null,
            $customOptions = [],
            $customAttributes = []
        ): string {
            $defaultOptions = [
                'variant' => 'default',
                'size' => 'base',
                'iconLeft' => null,
                'iconRight' => null,
                'isSquared' => false,
            ];
            $options = array_merge($defaultOptions, $customOptions);
    
            $baseClass =
    
                'inline-flex items-center font-semibold shadow-xs rounded-full focus:outline-none focus:ring';
    
                'default' => 'text-black bg-gray-300 hover:bg-gray-400',
                'primary' => 'text-white bg-pine-700 hover:bg-pine-800',
    
                'secondary' => 'text-white bg-gray-700 hover:bg-gray-800',
    
                'accent' => 'text-white bg-rose-600 hover:bg-rose-800',
    
                'success' => 'text-white bg-green-600 hover:bg-green-700',
                'danger' => 'text-white bg-red-600 hover:bg-red-700',
                'warning' => 'text-black bg-yellow-500 hover:bg-yellow-600',
    
                'info' => 'text-white bg-blue-500 hover:bg-blue-600',
    
                'base' => 'text-sm md:text-base',
                'large' => 'text-lg md:text-xl',
            ];
    
            $basePaddings = [
    
                'small' => 'px-2 md:px-3 md:py-1',
                'base' => 'px-3 py-1 md:px-4 md:py-2',
                'large' => 'px-3 py-2 md:px-5',
    
            ];
    
            $squaredPaddings = [
                'small' => 'p-1',
                'base' => 'p-2',
                'large' => 'p-3',
            ];
    
            $buttonClass =
                $baseClass .
                ' ' .
                ($options['isSquared']
                    ? $squaredPaddings[$options['size']]
                    : $basePaddings[$options['size']]) .
                ' ' .
                $sizeClass[$options['size']] .
                ' ' .
                $variantClass[$options['variant']];
    
            if (!empty($customAttributes['class'])) {
                $buttonClass .= ' ' . $customAttributes['class'];
                unset($customAttributes['class']);
            }
    
            if ($options['iconLeft']) {
                $label = icon($options['iconLeft'], 'mr-2') . $label;
            }
    
            if ($options['iconRight']) {
                $label .= icon($options['iconRight'], 'ml-2');
            }
    
            if ($uri) {
                return anchor(
                    $uri,
                    $label,
                    array_merge(
                        [
                            'class' => $buttonClass,
                        ],
    
                );
            }
    
            $defaultButtonAttributes = [
                'type' => 'button',
            ];
    
            $attributes = stringify_attributes(
                array_merge($defaultButtonAttributes, $customAttributes),
            );
    
            return <<<HTML
                <button class="$buttonClass" $attributes>
                $label
                </button>
            HTML;
    
        }
    }
    
    // ------------------------------------------------------------------------
    
    if (!function_exists('icon_button')) {
        /**
         * Icon Button component
         *
         * Abstracts the `button()` helper to create a stylized icon button
         *
         * @param string           $label The button label
         * @param mixed|null       $uri URI string or array of URI segments
         * @param array            $customOptions button options: variant, size, iconLeft, iconRight
         * @param array            $customAttributes Additional attributes
         *
         * @return string
         */
        function icon_button(
            string $icon,
            string $title,
            $uri = null,
            $customOptions = [],
            $customAttributes = []
        ): string {
            $defaultOptions = [
                'isSquared' => true,
            ];
            $options = array_merge($defaultOptions, $customOptions);
    
            $defaultAttributes = [
                'title' => $title,
                'data-toggle' => 'tooltip',
                'data-placement' => 'bottom',
            ];
            $attributes = array_merge($defaultAttributes, $customAttributes);
    
            return button(icon($icon), $uri, $options, $attributes);
        }
    }
    
    // ------------------------------------------------------------------------
    
    if (!function_exists('hint_tooltip')) {
        /**
         * Hint component
         *
         * Used to produce tooltip with a question mark icon for hint texts
         *
         * @param string $hintText The hint text
         *
         * @return string
         */
        function hint_tooltip(string $hintText = '', string $class = ''): string
        {
            $tooltip =
                '<span data-toggle="tooltip" data-placement="bottom" tabindex="0" title="' .
                $hintText .
    
                '" class="inline-block text-gray-500 align-middle outline-none focus:ring';
    
    
            if ($class !== '') {
                $tooltip .= ' ' . $class;
            }
    
            return $tooltip . '">' . icon('question') . '</span>';
        }
    }
    
    // ------------------------------------------------------------------------
    
    if (!function_exists('data_table')) {
        /**
         * Data table component
         *
         * Creates a stylized table.
         *
         * @param array     $columns array of associate arrays with `header` and `cell` keys where `cell` is a function with a row of $data as parameter
         * @param array     $data data to loop through and display in rows
         * @param array     ...$rest Any other argument to pass to the `cell` function
         *
         * @return string
         */
        function data_table($columns, $data = [], ...$rest): string
        {
            $table = new \CodeIgniter\View\Table();
    
            $template = [
                'table_open' => '<table class="w-full whitespace-no-wrap">',
    
                'thead_open' =>
                    '<thead class="text-xs font-semibold text-left text-gray-500 uppercase border-b">',
    
                'heading_cell_start' => '<th class="px-4 py-2">',
                'cell_start' => '<td class="px-4 py-2">',
                'cell_alt_start' => '<td class="px-4 py-2">',
    
    
                'row_start' => '<tr class="bg-gray-100 hover:bg-pine-100">',
                'row_alt_start' => '<tr class="hover:bg-pine-100">',
    
            ];
    
            $table->setTemplate($template);
    
            $tableHeaders = [];
            foreach ($columns as $column) {
                array_push($tableHeaders, $column['header']);
            }
    
            $table->setHeading($tableHeaders);
    
            if ($dataCount = count($data)) {
                for ($i = 0; $i < $dataCount; $i++) {
                    $row = $data[$i];
                    $rowData = [];
                    foreach ($columns as $column) {
                        array_push($rowData, $column['cell']($row, ...$rest));
                    }
                    $table->addRow($rowData);
                }
            } else {
                return lang('Common.no_data');
            }
    
            return '<div class="overflow-x-auto bg-white rounded-lg shadow" >' .
                $table->generate() .
                '</div>';
        }
    }
    
    // ------------------------------------------------------------------------
    
         * Shows the stylized publication datetime in regards to current datetime.
    
         *
         * @param \CodeIgniter\I18n\Time    $publicationDate publication datetime of the episode
         * @param boolean                   $isPublished whether or not the episode has been published
         * @param string                   $customClass css class to add to the component
         *
         * @return string
         */
        function publication_pill(
            $publicationDate,
    
                    ? 'text-pine-500 border-pine-500'
                    : 'text-red-600 border-red-600';
    
    
            $transParam = [];
            if ($publicationDate) {
                $transParam = [
                    '<time pubdate datetime="' .
    
                    $publicationDate .
                    '">' .
                    lang('Common.mediumDate', [$publicationDate]) .
                    '</time>',
    
                ];
            }
    
            $label = lang(
                'Episode.publication_status.' . $publicationStatus,
    
            return '<span class="px-1 font-semibold border ' .
    
    
    // ------------------------------------------------------------------------
    
    
    if (!function_exists('publication_button')) {
        /**
         * Publication button component
         *
         * Displays the appropriate publication button depending on the publication status.
         *
         * @param integer   $podcastId
         * @param integer   $episodeId
         * @param boolean   $publicationStatus the episode's publication status     *
         * @return string
         */
        function publication_button(
            $podcastId,
            $episodeId,
            $publicationStatus
        ): string {
            switch ($publicationStatus) {
                case 'not_published':
                    $label = lang('Episode.publish');
                    $route = route_to('episode-publish', $podcastId, $episodeId);
                    $variant = 'primary';
                    $iconLeft = 'upload-cloud';
                    break;
                case 'scheduled':
                    $label = lang('Episode.publish_edit');
                    $route = route_to(
                        'episode-publish_edit',
                        $podcastId,
                        $episodeId,
                    );
                    $variant = 'accent';
                    $iconLeft = 'upload-cloud';
                    break;
                case 'published':
                    $label = lang('Episode.unpublish');
                    $route = route_to('episode-unpublish', $podcastId, $episodeId);
                    $variant = 'danger';
                    $iconLeft = 'cloud-off';
                    break;
            }
    
            return button($label, $route, [
                'variant' => $variant,
                'iconLeft' => $iconLeft,
            ]);
        }
    }
    
    // ------------------------------------------------------------------------
    
    
    if (!function_exists('episode_numbering')) {
        /**
         * Returns relevant translated episode numbering.
         *
         * @param int|null  $episodeNumber
         * @param int|null  $seasonNumber
         * @param string    $class styling classes
         * @param string    $is_abbr component will show abbreviated numbering if true
         *
    
         * @return string|null
    
         */
        function episode_numbering(
            $episodeNumber = null,
            $seasonNumber = null,
            $class = '',
            $isAbbr = false
        ): string {
            if (!$episodeNumber && !$seasonNumber) {
                return '';
            }
    
            $transKey = '';
            $args = [];
            if ($episodeNumber && $seasonNumber) {
                $transKey = 'Episode.season_episode';
                $args = [
                    'seasonNumber' => $seasonNumber,
                    'episodeNumber' => $episodeNumber,
                ];
            } elseif ($episodeNumber && !$seasonNumber) {
                $transKey = 'Episode.number';
                $args = [
                    'episodeNumber' => $episodeNumber,
                ];
            } elseif (!$episodeNumber && $seasonNumber) {
                $transKey = 'Episode.season';
                $args = [
                    'seasonNumber' => $seasonNumber,
                ];
            }
    
            if ($isAbbr) {
                return '<abbr class="' .
                    $class .
                    '" title="' .
                    lang($transKey, $args) .
                    '">' .
                    lang($transKey . '_abbr', $args) .
                    '</abbr>';
            }
    
            return '<span class="' .
                $class .
                '">' .
                lang($transKey, $args) .
                '</span>';
        }
    }
    
    
    if (!function_exists('location_link')) {
        /**
         * Returns link to display from location info
         *
         * @param string $locationName
         * @param string $locationGeo
         * @param string $locationOsmid
         *
         * @return string
         */
        function location_link(
            $locationName,
            $locationGeo,
            $locationOsmid,
            $class = ''
        ) {
    
            if (!empty($locationName)) {
    
                    location_url($locationName, $locationGeo, $locationOsmid),
    
                    icon('map-pin', 'mr-2') . $locationName,
    
                            'inline-flex items-baseline hover:underline' .
                            (empty($class) ? '' : " $class"),
    
                        'target' => '_blank',
                        'rel' => 'noreferrer noopener',
    
    // ------------------------------------------------------------------------