Package Configuration - boxlist_items

The boxlist_items section is mainly used for settings pages, and for an example of this item, visit the Settings->Users or Settings->Financial menus of the administration panel. Placing them within the package.yml file provides extendability and allows any developer to add an item into any boxlist item for their own package.

The section consists of an array of associative arrays, the keys of each associative array are explained below.

Key	Description
alias	The alias of the boxlist item, formatted as PACKAGE.ALIAS.
href	The URI to link the boxlist item to.
title	The title of the boxlist item
description	The description of the boxlist item.

Adding Boxlists to Web Pages

After you have defined a new boxlist, you may place it on any web page with the "boxlist" tag, for example:

<s:boxlist alias="users.settings">

Example

Great examples can be found within the package.yml files of various base packages such as the "users" and "transaction" packages. Below shows the contents of the boxlist_items secion from the "users" package.

  -
    alias: users.settings
    href: admin/settings/users_general
    title: General
    description: General user settings, such as whether public profiles are enabled, name formatting, and so on.
  -
    alias: users.settings
    href: admin/settings/users_groups
    title: User Groups
    description: Define the various user groups available if you offer different levels of membership.
  -
    alias: users.settings
    href: admin/settings/users_profile_fields
    title: Profile Fields
    description: Define the additional profile fields stored with each user account.  Useful if you want to store more than the default profile info such as address, Skype username, etc.
  -
    alias: users.settings
    href: admin/settings/users_delete_all
    title: Delete All Users
    description: If you ever need to delete all users from the system, and start with a clean database.