Skip to content

Latest commit

 

History

History
162 lines (112 loc) · 3.82 KB

README.md

File metadata and controls

162 lines (112 loc) · 3.82 KB
Raw

vaahcms-module-cms

Cms Module for VaahCMS

New Version Release

  • Version should be updated in composer.json and Config/config.php file

For Hot Reload add following:

MODULE_CMS_ENV=develop

Frontend Routes

<public-url>/{permalink}

<public-url>/{content_type}/{permalink}

<public-url>/taxonomies/{taxonomy_type_slug}/{taxonomy_slug}

<public-url>/search

Helper Methods

Theme Locations

{!! vh_location('top', true) !!}

Content

{!! get_content($data) !!}                      //   return HTML format

{!! get_the_content($data) !!}                  //   return DATA format
get_content(Content $content, $type=null)

$type = content/template;

Content List

{!! get_contents('page') !!}                      //   return HTML format

{!! get_the_contents('page') !!}                  //   return DATA format
get_contents($content_type_slug='pages', array $args = null,$has_pagination = true)

$args = [

    'q'                         => 'search_item', 
    'per_page'                  => 5,                                       // default = 20
    'include_groups'            => [],                                      // group_slug
    'exclude_groups'            => [],                                      // group_slug   
    'order'                     => 'name',                                  // default = id      
    'order_by'                  => 'asc',                                   // default = desc      asc/desc/ASC/DESC
    'container_opening_tag'     => '<div class="columns is-multiline">',
    'container_closing_tag'     => '</div>',
    'content_opening_tag'       => '<div class="column is-4">',
    'content_closing_tag'       => '</div>'               

];

Field

{!! get_field($data, 'title', 'default') !!}        //   return HTML format

{!! get_the_field($data, 'title', 'default') !!}    //   return DATA format
get_field(Content $content, $field_slug,
         $group_slug='default', $type='content',
         $group_index = 0 , $field_index = null)

$type = content/template;

$group_index = 0/1/2/3/4/.....
$field_index = 0/1/2/3/4/.....

Group

{!! get_group($data ,'default' ) !!}            //   return HTML format

{!! get_the_group($data ,'default' ) !!}        //   return DATA format
get_group(Content $content, $group_slug='default', 
            $type='content, $group_index = null)

$type = content/template;

$group_index = 0/1/2/3/4/.....

API

Content

parameter = [

    'q'                         => 'search_item', 
    'per_page'                  => 5,                                       // default = 20
    'include_groups'            => [],                                      // group_slug
    'exclude_groups'            => [],                                      // group_slug
    'order'                     => 'name',                                  // default = id      
    'order_by'                  => 'asc',                                   // default = desc      asc/desc/ASC/DESC              

];

<public-url>/api/cms/contents/{plural_slug}
<public-url>/api/cms/contents/{singular_slug}/{content_slug}

Content Type

<public-url>/api/cms/contents-types

<public-url>/api/cms/contents-types/{slug}

To Run Modules Dusk Test:

  • Change path of dusk in phpunit.dusk.xml to following:
<directory suffix="Test.php">./VaahCms/Modules/Cms/Tests/Browser</directory>
  • Then run php artisan dusk

Change Log

  • Install npm install auto-changelog -g
  • To generate CHANGELOG.md, run auto-changelog --commit-limit false in the root folder of the project

Maintain following pre-fixes to your commit messages:

Added:
Changed:
Deprecated:
Removed:
Fixed:
Security: