concrete5 Cookbook

concrete5 Cookbook

Overview of this book

concrete5 is an increasingly popular open source content management system because of its incredible and easy-to-use interface. But, it also comes complete with a robust PHP framework, allowing web developers to create custom websites and applications with ease. "concrete5 Cookbook" is a practical collection of solutions to tasks that both novice and experienced concrete5 developers face on a regular basis. Readers will learn multiple subjects, including full blueprints for developing an event calendar add-on and an image gallery block. Developers new to concrete5 will quickly learn how to customize concrete5 to their needs, and seasoned pros will find it an excellent quick reference for performing specific tasks. "concrete5 Cookbook" will transform ordinary PHP developers into concrete5 experts capable of bending concrete5 to their will and unleashing the true power of this up-and-coming content management system. Throughout the course of over 140 recipes and 3 bonus project blueprint chapters, PHP developers will learn how to create custom blocks and dashboard interfaces as well as programmatically work with pages, files, users, permissions, and more. Discover the built-in Active Record support that makes working with databases simple and maintainable. Readers will also learn how to take advantage of the numerous helper classes included in concrete5, and will dive deep into the concrete5 MVC framework to create powerful custom websites and applications. Tie together all of the concepts learned in the recipes with 3 bonus chapters featuring complete blueprints to create a calendar add-on, an image gallery block type, and tips on how to sell your themes and add-ons for money! "concrete5 Cookbook" is a complete collection of recipes to solve the most common (and some not-so-common) tasks that concrete5 developers will face on a regular basis.

concrete5 Cookbook

Credits

About the Author

About the Reviewers

www.PacktPub.com

Preface

Free Chapter

Pages and Page Types

Introduction

Create a custom debugging function

Getting the current Page object

Getting a Page object by its ID

Getting a Page object by its path

Getting a page type by its ID

Getting a page type by its handle

Getting a page type's ID

Getting a page type's name

Getting a page type's handle

Getting the icon for a page type

Getting a list of pages that belong to a page type

Updating an existing page

Setting page attributes

Getting a page attribute

Getting a page's ID

Getting a page's path

Getting a page's handle

Getting a page's name

Getting a page's description

Getting a page's page type ID

Getting a page's page type handle

Getting a page's theme object

Getting the children below a page

Moving a page

Deleting a page (and its children)

Getting a list of pages

Adding a page selector field to a form

Working with Blocks

Introduction

Creating a custom block type

Using block controller callback functions

Sending variables from the controller to the view

Adding items to the page header and footer from the block controller

Creating custom block templates

Including JavaScript in block forms

Including JavaScript in the block view

Including CSS in the block view

Loading a block type by its handle

Adding a block to a page

Getting the blocks from an area

Files and File Sets

Introduction

Loading a file by its ID

Getting a file's path

Getting a list of files

Uploading a file to the file manager

Loading a file set by its ID

Adding a file to a file set

Removing a file from a file set

Checking if a file is part of a file set

Getting all of the files in a file set

Duplicating a file

Deleting a file

Reindexing a file's search attributes

Setting passwords on file objects

Setting permissions on files

Getting the download URL for a file

Getting the download statistics for a file

Adding a file picker to a form

Using the Core Helpers

Introduction

Loading a helper class

Using the Date helper

Using the Encryption helper

Loading an RSS feed with the Feed helper

Managing files and directories with the File helper

Creating custom forms with the Form helper

Including a WYSIWYG editor on a form

Generating HTML code with the HTML helper

Generating and caching thumbnails with the Image helper

Encoding and decoding JSON with the JSON helper

Sending e-mails with the Mail helper

Determining the MIME type of a file extension using the MIME helper

Getting page URLs and breadcrumbs with the Navigation helper

Working with strings using the Text helper

Generating URLs with the URL helper

Validating input data using the Validation helpers

Preventing spam using the Captcha helper

Getting a list of countries

Getting a list of states and provinces

Showing a color picker on a form

Showing a date/time selector on a form

Showing a rating widget on a form

Using the banned words list

Reading and writing to the system cache

Writing to the debug log

Reading and writing to the configuration registry

Working with Databases and Models

Introduction

Loading the database object

Retrieving data from the database

Writing data to the database

Guarding against SQL injections using prepared statements

Creating a custom model class

Reading from the database with active record

Writing to the database with active record

Updating a database record with active record

Searching the database using active record

Deleting objects using active record and model classes

Defining relationships with active record

Creating CRUD Interfaces

Introduction

Creating controller files for single pages on the dashboard

Creating view files for single pages on the dashboard

Adding single pages to the dashboard

Creating a form to create items

Saving data to the database from a controller

Creating a view to display a list of database items

Adding editing capabilities to create a form

Creating a delete action

Working with Users and Permissions

Introduction

Checking if the current user is logged in

Getting the currently logged-in user

Loading a user by its ID

Loading a user by its username

Getting a user's info

Setting a user's attributes

Retrieving a user's attributes

Loading a group by its ID

Loading a group by its name

Adding a user to a group

Getting all of the users from a group

Checking if a user is a member of a group

Removing a user from a group

Logging out a user

Deleting a user

Getting the permission object

Checking if a user can read a page

Checking if a user can edit a page

Checking a user's file permissions

Working with Themes and Add-ons

Introduction

Creating a custom theme

Including the concrete5 required scripts and styles

Defining editable content areas

Creating page type templates

Using elements for repeated portions of HTML

Customizing system pages

Creating a custom add-on package

Using the package controller to execute custom code

System Events and Advanced Configuration

Introduction

Declaring advanced configuration variables

Enabling events in concrete5

Listening to system events

Passing parameters to event handlers

Defining a page type event

Sending an e-mail when a user creates an account

Sending an e-mail when a file has been uploaded

Creating a custom scheduled job

Making your add-on translation ready

Rebranding concrete5 as a white label CMS

Changing the dashboard background image

Blueprint – Creating an Image Gallery Add-on

Before we begin...

Creating the package controller

Creating the block type

Installing the block type with the package

Giving life to the block

Wrap-up

Blueprint – Creating an Events Calendar Add-on

Before we begin...

Creating the package

Installing the package

Creating the list single page

Creating the add form single page

Adding events to the database

Adding a delete confirmation

Creating the custom block type

Adding the block to a page

Wrapping up

Submitting an Add-on Package to the concrete5 Marketplace

The rules

The process

Official resources

Index

Customer Reviews

5 star

4 star

3 star

2 star

1 star

Getting a list of pages

Many applications will have a need to get a list of pages and perform various filter and sorting functions on the list. For this, there is the PageList class, which exposes many convenient helper functions to assist in working with large lists of pages.

Getting ready

In this example, we are going to find all of the pages under the /blog page. This is a common use of the page list model. The PageList class is not automatically loaded by concrete5, so we will need to use the Loader class to have it available to us.

If your site does not have a page located at /blog, it would be helpful to create that page, as well as a few child pages below it. Otherwise, feel free to adapt the code in this recipe to suit your needs.

How to do it...

In this recipe, we will get a list of 20 pages that exist under /blog in the sitemap. The steps are as follows:

First, we must make the PageList class available for us to use.
```
Loader::model('page_list');
```
Create a new instance of the PageList class. We will assign it to a variable called $list.
```
$list = new PageList();
```
Filter the list to only include pages underneath the /blog page.
```
$list->filterByPath('/blog');
```
Limit the list of pages to only include the first 20 results.
```
$list->setItemsPerPage(20);
```
Run the database query and get the first "page" of results, which will return an array of 20 Page objects.
```
$pages = $list->getPage();
```

Dump the contents of the pages variable to see the array.

foreach ($pages as $page) {
  echo $page->getCollectionTitle().'<br />';
}
exit;

How it works...

The PageList class extends the core DatabaseItemList class, which has a number of useful functions itself. The get() function accepts two parameters, the number of records to retrieve, and the offset.

There's more...

The page list class implements "magic methods," which allow allow us to filter the list by any page attribute. We simply need to create a function name based off of the camel cased version of the attribute handle, preceded by "filterBy". So to filter all pages that have the exclude_nav attribute, we would write the following function:

$list->filterByExcludeNav(true);

Alternatively, if you want to just get an array of the first 99 Page objects and ignore pagination, use the get() function.

$pages = $list->get(99);

Since version 5.5, concrete5 uses Twitter's open source Bootstrap CSS framework for many of their internal styles. You can get the pagination controls in nicely formatted HTML (with relevant Bootstrap CSS classes) by printing/echoing the results of the following function (preferably you'd use this function in a view or template file of a block or single page):

echo $list->displayPagingV2();

The DatabaseItemList class and PageList class have several functions that make working with a collection of pages easier. You can filter by keywords, by collection type, parent page, and by any attribute using magic methods. We will cover the DatabaseItemList class further in Chapter 5, Working with Databases and Models.

concrete5 Cookbook

concrete5 Cookbook

Overview of this book

Related Content you might be interested in

Current Title:

concrete5 Cookbook

Getting a list of pages

Getting ready

How to do it...

How it works...

There's more...