Content Overview

Appearance

Return to top
On this page

Scaffolding

Configuration files

There are a couple of CLI commands you can use to create a starting point for configuration files.

php craft contentoverview/create/<type>

Currently implemented:

php craft contentoverview/create/plugin-config
php craft contentoverview/create/pages
php craft contentoverview/create/page

Custom classes

There are a couple of CLI commands you can use to create a starting point for custom classes.

php craft contentoverview/create/<type> <className>

Currently implemented:

php craft contentoverview/create/module
php craft contentoverview/create/section
php craft contentoverview/create/filter
php craft contentoverview/create/action
php craft contentoverview/create/service

You will be prompted for a class name if it is not provided as a parameter.

Additionally, depending on the type of class, you will be prompted for some settings. Press the ENTER key to continue with the default settings.

shell
php craft contentoverview/create/section MySection
Enter section settings.                                                                             
See docs for details: https://wsydney76.github.io/craft-contentoverview/config/section-settings.html
Press ENTER to use the default value.                                                          
Please note that your input is not validated.                                                       
Section handle:  news                                                                               
Heading:  
Limit:  12
Order By (e.g. title):  title
Image Field (fieldHandle):  featuredImage
Layout [list,cards,cardlets,line]:  cards
Size [tiny,small,medium,large]:  small
...
Enable Search [true,false]: true
File /var/www/html/modules/contentoverview/models/MySection.php created.
Refer to docs on how to activate your new class.
https://wsydney76.github.io/craft-contentoverview/dev/section.html
$co->createSection(MySection::class)

TIP

If you are not sure which values to use, just enter a placeholder and then edit the file.

WARNING

Any inputs are not validated. So be sure to enter valid input or check the file.

WARNING

These commands assume that your module lives in modules/contentoverview.

TIP

Use ddev craft ... if you are using DDEV.