The package is an implementation of a simple but useful subsystem of a basic content organization for the Voyager Admin Panel package. Using this package you can rapidly and easily build small and medium-size scale web-sites.
- Basic Page management module, including systems pages.
- Basic SEO implementation - Seo title, Meta Description and Meta Keywords parameters.
- Breadcrumbs implementation.
- Flexible Block / Widget management module, to build parts of your site pages.
- Form management system, including AJAX sending.
- Liquid template subsystem for blocks/widgets and forms.
- Page layout construction using flexible Blocks/Widgets.
- Shortcodes integrated.
- Localizations from DB table, where you can easily keep and manage your translations.
- Advanced site settings module, including mail smtp settings and a mail sending test out of the box.
You should fully install the package Voyager Extension before.
Via Composer
$ composer require monstrex/voyager-siteThen run install command:
$ php artisan voyager-site:installPublish config if you need:
$ php artisan vendor:publish --provider="MonstreX\VoyagerSite\VoyagerSiteServiceProvider" --tag="config"
- route_home_page - Route name for Home Page ('home' by default).
- default_model_table - Default model table name to find records ('pages' by default).
- default_slug_field - Default slug field name ('slug' by default).
- use_legacy_error_handler - If false will be used voyager-site 404 error handler.
- template - Root folder name where stored view template files ('template' by default).
- template_master - Master template name ('layouts.master' by default).
- template_layout - Main Layout Template name ('layouts.main' by default).
- template_page - Page template name ('pages.page' by default).
Site settings is a flexible and extendable easy to use settings subsystem integrated in the package.
You can use and modify exist settings and group and add you own group and settings. To retrieve certain setting you may use helper function:
$mail = site_setting('mail.to_address');Some of the site settings used by internal package functions and override Laravel .env settings.
The settings have built-in SMTP mail parameters and the mail sending test function.
You can easily modify settings or add new ones using JSON-like setting fields configuration by clicking on the Edit action.
{
"fields": {
"to_address": {
"label": "Default address for site emails",
"type": "text",
"value": "destination@example.com",
"class": "col-md-12"
},
"section_smtp": {
"type": "section",
"icon": "voyager-mail",
"label": "E-Mail transport"
},
"driver": {
"label": "Mail driver",
"type": "dropdown",
"value": "smtp",
"options": {
"smtp": "SMTP",
"mailgun": "MAILGUN"
},
"class": "col-md-12"
}
}
}Built-in field types are
- text
- number
- textarea
- rich_text_box (tinyMCE editor)
- code_editor (ACE Code Editor)
- checkbox
- radio
- image (voyager type image)
- media (image file, using laravel medialibrary package)
- route (returns URL using route name)
- section (don't has value, used just for visual separation of field groups)
The package provides DB-like localization storage for all strings you need to localize. Just add language columns to the storage and it'll be used instead a localization in files.
The VPage module allows you manage basic pages on your site. You can easily find and prepare any page and its related attributes - like SEO data, breadcrumbs and data sources and then send this data collection to a view. It can be used by two ways: implementing the PageTrait class into your controller or using the facade VPage. Look for the examples:
Example #1:
namespace App\Http\Controllers;
use MonstreX\VoyagerSite\Traits\PageTrait;
class PagesController extends Controller
{
use PageTrait;
public function home()
{
$this->create('home');
return $this->view();
}
public function show($alias)
{
$this->create($alias);
return $this->view();
}
public function showArticle($alias)
{
$this->create($alias,'articles');
return $this->view('layout.article', ['vars' => $some_vars]);
}
}Example #2:
namespace App\Http\Controllers;
use MonstreX\VoyagerSite\Traits\PageTrait;
use VSite, VPage, VData;
class PagesController extends Controller
{
public function home()
{
VPage::create(VData::find('home'), VSite::getSettings());
return VPage::view();
}
}What the example does:
- Finds in default (or given) model the certain record (using 'slug' field by default). If you use (int) value then it'll be found by ID field. If a record is not found or the record has empty (null) status field then it'll throw an exception 404.
- Creates a VPage instance and initialize the instance with a Page Data:
- Founded model object.
- Site settings.
- Initialized breadcrumbs.
- Initialized SEO parameters (seo title, meta description, meta keywords).
- Attached data sources, if details field has data sources descriptions.
- Renders page using default (or given) View.
Available variables in the View:
$template_master // Master template name (to extend View)
$template_page // Internal page template name
$breadcrumbs // Breadcrumbs array
$title // Page title
$page // Page record
$page_data_sets // Data sources attached to the Page
$seo['title'] // Seo Title
$seo['description'] // Meta Description
$seo['keywords'] // Meta Keywords
$data // Additional given dataIt is a subsystem to retrieve additional data necessary to use on a certain page.
The data are different record collections from different models.
To use it you need having details field in your model, the record of that filled up with a certain JSON data structure:
Note: the attached data defined in JSON structure will load automatically during a call the create method.
{
"data_sources": {
"articles": {
"model": "Article",
"where": {
"status": 1
}
},
"services": {
"model": "Service",
"where": {
"status": 1,
"featured": 0,
"type": "main"
},
"with": [
"category",
"country"
],
"order" : {
"field" : "order",
"direction" : "asc"
}
}
}
}And in your View template you can easily use it like this:
@foreach($page_data_sets['articles'] as $article)
<h2>{{ $article['title'] }}</h2>
@endforeachNote: this type of the JSON data structure also uses in Block/Widget subsystems.
You may want to override default template names on a certain page. To do this define new template names in details field:
{
"template": "my-theme",
"template_master": "layout.master",
"template_layout": "layout.main",
"template_page": "pages.contacts"
}SEO parameters are generated inside the create Page method. By default:
SEO Title - from the page seo fields group if an appropriate field is not empty, otherwise checks field Title, if the field is not present then checks a site setting seo.seo_title, if the setting is empty then takes value from site setting general.site_title. And at last the given value passed through seo title template site setting - seo.seo_title_template.
You can override the SEO Title value with method VPage::setSeoTitle('new title').
META Description - from the page seo fields group if an appropriate field is not empty, otherwise checks a site setting seo.meta_description, if the setting is empty then takes value from site setting general.site_description.
You can override the META Description value with method VPage::setMetaDescription('new description').
META Keywords - from the page seo fields group if an appropriate field is not empty, otherwise checks a site setting seo.meta_keywords.
You can override the META Keywords value with method VPage::setMetaKeywords('new keywords').
When you call the Page create method it adds the first element to the Breadcrumbs array.
How sets the first breadcrumb element:
addBreadcrumbs(__('site.breadcrumb_home'), route(config('voyager-site.route_home_page')));To add other elements to the Breadcrumbs array just use the method VPage::addBreadcrumbs($title, $path)
Blocks / Widgets is a flexible subsystem provides your a way to implement and organize additional content parts and include them into your page.
Each block has the follow structure:
Status - If disabled the block will be ignored.
Title - Visible only in admin panel.
Block key - A key (slug) using to find and render this block.
Region position - Used for grouping blocks and then render them as a group in certain order. Available positions can be edited in the Regions menu.
Block content - Main block content. You can use as pure HTML code or as a Liquid template. Available variables:
- images - holds images items listed bellow.
- data - Data sources if defined in Options field.
Example #1 (usage of image list):
<h3>My images</h3>
<div class="images-list">
{% for image in images %}
<img src="{{ image.url | crop: 300,200 | url }}" alt=""/>
{% endfor %}
</div>Where image.url represent relative URL of image. Crop filter - crop and store (if not stored yet) the image with given sizes. -url filter - makes full url from the relative one. image.full_url - Full url of the image. image.props.* - Custom image properties.
Example #2 (usage data sources):
<h3>Articles Block</h3>
<ul>
{% for article in data.articles %}
<li>{{ article.title }}</li>
{% endfor %}
</ul>For this kind of template you need to define data sources JSON-like structure in the options field:
{
"data_sources": {
"articles": {
"model": "Article",
"where": {
"field": "satus",
"value": 1
},
"order" : {
"field" : "order",
"direction" : "asc"
}
}
}
}Block render
If you discover any security related issues, please email author email instead of using the issue tracker.
license. Please see the license file for more information.