PHP code example of andrewdanilov / yii2-custom-pages

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

andrewdanilov / yii2-custom-pages example snippets

$config = [
    // ...
    'modules' => [
        // ...
        'custompages' => [
            'class' => 'andrewdanilov\custompages\backend\Module',
            // access role for module controllers, optional, default is ['@']
            'access' => ['admin'],
            // path to Views for pages and categories
            'templatesPath' => '@frontend/views/custompages',
            // optional, path to user translates
            'translatesPath' => '@common/messages/custompages',
            // optional, enables controls for managing page tags, default is true
            'enableTags' => false,
            // optional, enables controls for managing page albums, default is true
            'enableAlbums' => false,
            // optional, enables controls for managing categories, default is true
            'enableCategories' => false,
            // optional, enables controls for managing pages extra fields, default is true
            'enablePageFields' => false,
            // file manager configuration, optional, default is:
            'fileManager' => [
                'basePath' => '@frontend/web',
                'paths' => [
                    [
                        'name' => 'News',
                        'path' => 'upload/images/news',
                    ],
                    [
                        'name' => 'Articles',
                        'path' => 'upload/images/articles',
                    ],
                ],
            ],
            // bootstrap version to use, optional, default is '5.x'
            'bsVersion' => '5.x',
        ],
    ],
];

use yii\helpers\Url;

$categoryUrl = Url::to(['/custompages/category']);
$pageUrl = Url::to(['/custompages/page']);
$pageTagUrl = Url::to(['/custompages/page-tag']);

$custom_pages_menu_items = [
    ['label' => 'Custom Pages'],
    ['label' => 'Articles', 'url' => ['/custompages/page', 'PageSearch' => ['category_id' => 123]], 'icon' => 'file'],
    ['label' => 'Without Category', 'url' => ['/custompages/page', 'PageSearch' => ['category_id' => 0]], 'icon' => 'file'],
    ['label' => 'All Pages', 'url' => ['/custompages/page'], 'icon' => 'file'],
];

echo \yii\widgets\Menu::widget(['items' => $custom_pages_menu_items]);

$config = [
    // ...
    'modules' => [
        // ...
        'custompages' => [
            'class' => 'andrewdanilov\custompages\frontend\Module',
            // optional, path to template Views for pages and categories
            'templatesPath' => '@frontend/views/custompages',
            // optional, path to user translates
            'translatesPath' => '@common/messages/custompages',
            // optional, page text short version length, default is 50
            'pageShortTextWordsCount' => '100',
            // optional, callable functions to process page and category text,
            // i.e. to replace some shortcodes on it
            'pageTextProcessor' => 'frontend\components\MyPageTextProcessor::replaceShortcodes',
            'categoryTextProcessor' => 'frontend\components\MyCategoryTextProcessor::replaceShortcodes',
            // pagination settings
            'paginationForcePageParam' => false, // optional, whether to always have the page parameter in the URL, even on first page, default is false
            'paginationPageParam' => 'page', // optional, name of the parameter storing the current page index, default is 'page'
            'paginationPageSizeParam' => false, // optional, false or name of the parameter storing the page size, default is false
            'paginationPageSize' => 20, // optional, number of items per page, default is 20
        ],
    ],
];

use yii\helpers\Url;

// detailed page url
$pageUrl = Url::to(['/custompages/default/page', 'id' => 123]);
// pages list url, shows pages in defined category
$categoryUrl = Url::to(['/custompages/default/category', 'id' => 1]);
// pages list url by tag id
$pageTagUrl = Url::to(['/custompages/default/page-tag', 'id' => 7]);
// pages list url by tag slug
$pageTagUrl = Url::to(['/custompages/default/page-tag', 'slug' => 'tagname']);
// pages list url by tag id, shows pages in defined category only
$pageTagUrl = Url::to(['/custompages/default/page-tag', 'id' => 7, 'category_id' => 123]);
// pages list url by tag slug, shows pages in defined category only
$pageTagUrl = Url::to(['/custompages/default/page-tag', 'slug' => 'tagname', 'category_id' => 123]);

 /* @var \andrewdanilov\custompages\common\models\Page $page */ 

return [
    // ...
    'language' => 'ru-RU',
    // ...
];

namespace frontend\components;

class MyPageTextProcessor
{
    public static function replaceShortcodes($text)
    {
        return str_replace('some string', 'other string', $text);
    }
}

php yii migrate --migrationPath=@andrewdanilov/custompages/console/migrations