Index
A
- account creation
- e-mail, sending on / Sending an e-mail when a user creates an account, How to do it..., How it works...
- active record
- database, reading from / Reading from the database with active record, How to do it..., How it works...
- database, writing to / Writing to the database with active record, How it works...
- database record, updating / Updating a database record with active record, How it works...
- used, for searching database / Searching the database using active record, How to do it...
- used, for deleting objects / Deleting objects using active record and model classes
- used, for deleting model classes / Deleting objects using active record and model classes
- relationships, defining with / Getting ready, How to do it...
- add() function / There's more..., How it works..., How it works...
- add-on
- custom add-on package, creating / Creating a custom add-on package, How to do it..., How it works...
- translation, preparing / How to do it...
- rules / The rules
- submitting, to concrete5 marketplace / The rules, The process
- selling / Selling your add-on
- approval / Once the add-on is approved...
- PRB approved, URL / Official resources
- addEdit function / Giving life to the block
- addFooterItem function / How it works...
- add form single page
- creating / Creating the add form single page
- addHeaderItem function / How it works...
- ADOdb_Active_Record class / How it works...
- ADOXMLS format / How to do it...
- akID attribute / Getting ready
- arena
- block, getting from / Getting the blocks from an area, How it works...
- AttributeKey object / How it works...
- attributes, user
- setting / Setting a user's attributes, Getting ready
- retrieving / Getting ready, How it works...
- AXMLS
B
- $btInterfaceHeight variable / How it works...
- $btTable variable / How it works...
- banned words list
- block
- about / Introduction
- adding, by page / Adding a block to a page, How it works...
- getting, from arena / Getting the blocks from an area, How it works...
- controller / The block's controller, Giving life to the block
- database XML file / The block's database XML file
- view files / The block view files
- adding, to page / Adding the block to a page
- block controller
- items, adding to page header / Adding items to the page header and footer from the block controller, How to do it..., How it works...
- items, adding to page footer / Adding items to the page header and footer from the block controller, How to do it..., How it works...
- block controller callback functions
- block forms
- JavaScript, including / Including JavaScript in block forms, How it works...
- blocks
- about / Introduction
- block templates
- custom block templates, creating / Creating custom block templates, There's more...
- block type
- custom block type, creating / Creating a custom block type, How to do it..., How it works...
- loading, by handle / Loading a block type by its handle, How it works...
- creating / Creating the block type
- database XML file / The database XML file
- view files / The block type's view files
- installing, with package / Installing the block type with the package
- block view
- JavaScript, including / Including JavaScript in the block view, How it works...
- CSS, including / Including CSS in the block view, How it works...
- breadcrumbs
- getting, with Navigation helper / Getting page URLs and breadcrumbs with the Navigation helper, How it works...
- btTable class variable / How to do it...
C
- $content variable / How it works...
- Captcha helpers
- used, for preventing spam / Preventing spam using the Captcha helper
- cCacheFullPageContent attribute / There's more...
- cCacheFullPageContentLifetimeCustom attribute / There's more...
- cCacheFullPageContentOverrideLifetime attribute / There's more...
- cDatePublic attribute / There's more...
- cDescription attribute / There's more...
- cHandle attribute / There's more...
- children below page
- getting / Getting the children below a page, How it works...
- cName attribute / There's more...
- coding / A note about the code in this chapter
- color picker
- showing, on form / Showing a color picker on a form
- concrete5
- banned words list, using / Using the banned words list, There's more...
- requires scripts, including / Including the concrete5 required scripts and styles, There's more...
- requires styles, including / Including the concrete5 required scripts and styles, There's more...
- events, enabling / Enabling events in concrete5, How it works...
- rebranding, as white label CMS / Rebranding concrete5 as a white label CMS, How to do it..., There's more...
- package, installing / Installing the package in concrete5
- file set, adding / Trying out the block
- concrete5 coding style guidelines
- URL / Official resources
- concrete5 marketplace
- add-on, submitting to / The rules, The process
- about / The process
- URL / The process
- rules, URL / Official resources
- concrete5 pages
- about / Introduction
- configuration registry
- configuration variables
- advanced configuration variables, declaring / Declaring advanced configuration variables
- controller
- to view, items adding from / Sending variables from the controller to the view, How to do it...
- data, saving to database / Saving data to the database from a controller, How it works...
- controller file / How to do it...
- controller files
- creating, for single pages on dashboard / Creating controller files for single pages on the dashboard, How to do it...
- countries
- list, getting / Getting a list of countries
- CRUD (create, read, update, delete) / Adding a file picker to a form
- about / Introduction
- CSS
- including, in block view / Including CSS in the block view, How it works...
- ctHandle attribute / Getting ready
- ctIcon attribute / Getting ready
- ctID attribute / There's more...
- ctIsInternal attribute / Getting ready
- ctName attribute / Getting ready
- custom block type
- creating / Creating the custom block type
- custom model class
- creating / Creating a custom model class, How to do it..., There's more...
- cvIsApproved attribute / There's more...
D
- dashboard
- single pages, adding / Adding single pages to the dashboard, How it works...
- package, installing / Installing the package to the dashboard
- dashboard background image
- data
- retrieving, from database / Retrieving data from the database, Getting ready, There's more...
- writing, to database / Getting ready, There's more...
- saving to database, from controller / Saving data to the database from a controller, How it works...
- database
- data, retrieving from / Retrieving data from the database, Getting ready, There's more...
- data, writing to / Writing data to the database, There's more...
- reading from, with active record / Reading from the database with active record, How to do it..., How it works...
- writing to, with active record / Writing to the database with active record, How it works...
- searching, active record used / Searching the database using active record, How it works...
- data saving to, from controller / Saving data to the database from a controller, How it works...
- events, adding / Adding events to the database
- database credentials
- configuring / Configuring database credentials
- database items list
- displaying, by creating view / Creating a view to display a list of database items, Getting ready, How to do it...
- database object
- loading / Loading the database object
- database record
- updating, with active record / Updating a database record with active record
- Date helper
- using / Using the Date helper, How it works...
- date selector
- showing, on form / Showing a date/time selector on a form, How to do it...
- debugging function
- custom debugging function, creating / Create a custom debugging function
- debug log
- writing to / Writing to the debug log
- delete() function / How it works...
- delete action
- creating / Creating a delete action, How it works...
- delete confirmation
- adding / Adding a delete confirmation
- die function / How to do it...
- directories
- managing, with File helper / Getting ready, How it works...
- don't repeat yourself (DRY) / There's more...
E
- e-mail
- sending, on account creation / Sending an e-mail when a user creates an account, How to do it..., How it works...
- sending, on file upload / Sending an e-mail when a file has been uploaded, How to do it..., How it works...
- e-mails
- sending, with Mail helper / Sending e-mails with the Mail helper, How it works..., There's more...
- EAV format (entity, attribute, value / How it works...
- edit() function / How it works...
- editable content areas
- defining / Defining editable content areas, How it works...
- edit function / Giving life to the block
- editing capabilities
- adding, to create form / Adding editing capabilities to create a form, How to do it..., There's more...
- edit view files
- filling / Filling out the add and edit view files
- elements
- using, for HTML repeated portions / Using elements for repeated portions of HTML, How it works...
- Encryption helper
- event handlers
- parameters, passing / Passing parameters to event handlers, How it works...
- event list block type / The event list block type
- events
- adding, to database / Adding events to the database
- Events$$extend() function / How it works...
- exclude_nav attribute / There's more...
- execute function / There's more...
F
- fancyBox
- URL / Wrap-up
- feed helper
- RSS feed, loading with / Loading an RSS feed with the Feed helper, There's more...
- file
- loading, by ID / Loading a file by its ID, How it works...
- path, getting / Getting a file's path, How it works...
- list, getting / Getting a list of files, How it works...
- uploading, to file manager / Uploading a file to the file manager, How to do it...
- by ID, loading / Loading a file set by its ID, See also
- adding, to file set / Adding a file to a file set, There's more...
- removing, from file set / Removing a file from a file set, How it works...
- set part, checking / Checking if a file is part of a file set, How it works...
- in file set, getting / Getting all of the files in a file set, How to do it...
- duplicating / Duplicating a file, How it works...
- deleting / Deleting a file, How it works...
- search attributes, reindexing / Reindexing a file's search attributes
- objects, passwords setting on / Setting passwords on file objects
- permissions, setting / Setting permissions on files
- download URL, getting / Getting the download URL for a file
- download statistics, getting / Getting the download statistics for a file, How it works...
- picker, adding to form / Adding a file picker to a form, How it works...
- file() function / How it works...
- File helper
- used, for managing files / Managing files and directories with the File helper, How it works...
- used, for managing directories / Getting ready, How it works...
- FileImporter class / How it works...
- FileList class / Giving life to the block
- file manager
- about / Introduction
- file, uploading to / Uploading a file to the file manager, How to do it...
- file permissions, user
- checking / Checking a user's file permissions
- files
- managing, with File helper / Managing files and directories with the File helper, How it works...
- file set
- file, adding / Getting ready, There's more...
- file, removing from / Getting ready, How it works..., See also
- files, retrieving / Getting all of the files in a file set, How it works...
- FileType class / There's more...
- file upload
- e-mail, sending on / Sending an e-mail when a file has been uploaded, How to do it..., How it works...
- find function / There's more...
- form
- page selector field, adding / Adding a page selector field to a form, How it works...
- file picker, adding / Adding a file picker to a form, How to do it..., There's more...
- WYSIWYG editor, including / Including a WYSIWYG editor on a form, How it works...
- color picker, showing / Getting ready
- date selector, showing / Showing a date/time selector on a form, How to do it...
- time selector, showing / Showing a date/time selector on a form, How to do it...
- rate widget, displaying / Showing a rating widget on a form
- creating, to create items / Creating a form to create items, How to do it...
- creating, editing capabilities used / Adding editing capabilities to create a form, How to do it..., There's more...
- Form helper
- used, for creating custom forms / Creating custom forms with the Form helper, How to do it...
- forms
- custom forms, creating with Form helper / Creating custom forms with the Form helper, How to do it...
- form view file
- about / The form view file
- func_get_args() function / How it works...
G
- gallery
- page, creating for / Creating a page for the gallery
- gallery view file
- creating / Creating the gallery view file
- get() function / How it works..., There's more..., How it works...
- getByName function / How it works...
- getCollectionTypeName function / How it works...
- getCurrentPage function / How it works..., There's more...
- getDate() function / Creating the custom block type
- group
- loading, by ID / Loading a group by its ID, How it works...
- loading, by name / Loading a group by its name
- user, adding / Adding a user to a group
- users, getting / Getting all of the users from a group, How to do it...
- member, checking / Checking if a user is a member of a group, How it works...
- user, removing / Removing a user from a group, How to do it...
H
- handle
- about / Introduction
- page type, getting by / Getting a page type by its handle, How to do it...
- of page type, getting / Getting a page type's handle, How it works...
- block type, loading by / Getting ready, How it works...
- HTML code
- generating, with HTML helper / Generating HTML code with the HTML helper
- HTML helper
- used, for generating HTML code / Generating HTML code with the HTML helper
I
- icon
- for page type, getting / Getting the icon for a page type, How it works...
- ID
- page object, getting by / Getting ready, How it works...
- page type, getting by / Getting a page type by its ID, How to do it...
- of page type, getting / Getting a page type's ID, How it works...
- file, loading by / Getting ready, How it works...
- file set, loading / Loading a file set by its ID, There's more...
- user, loading by / Loading a user by its ID, How it works...
- group, loading by / Loading a group by its ID, How it works...
- image helper
- used, for caching thumbnails / Generating and caching thumbnails with the Image helper, There's more...
- used, for generating thumbnails / Generating and caching thumbnails with the Image helper, There's more...
- input data
- validating, Validation helpers used / Validating input data using the Validation helpers, How it works...
- items
- adding, to page footer from block controller / Adding items to the page header and footer from the block controller, How to do it..., How it works...
- adding, to page header from block controller / Adding items to the page header and footer from the block controller, How to do it...
- creation, by creating forms / Creating a form to create items, How to do it...
J
- JavaScript
- including, in block forms / Including JavaScript in block forms, How it works...
- including, in block view / Including JavaScript in the block view, How it works...
- JSON
- decoding, with JSON helper / Encoding and decoding JSON with the JSON helper, How it works...
- encoding, with JSON helper / Encoding and decoding JSON with the JSON helper, How it works...
- JSON helper
- used, for encoding JSON / Encoding and decoding JSON with the JSON helper, How it works...
- used, for decoding JSON / Encoding and decoding JSON with the JSON helper, How it works...
L
- $leftSidebarPageType variable / How to do it...
- Left Sidebar
- about / Introduction
- list single page
- creating / Creating the list single page
- list view
- creating / Creating the list view
- Loader class / Loading a helper class, How it works...
- logged-in user
- getting / Getting the currently logged-in user
- log in status, user
- checking / Checking if the current user is logged in
M
- magic methods / There's more...
- Mail helper
- used, for sending e-mails / Sending e-mails with the Mail helper, There's more...
- Master Collection page / How it works...
- MIME
- model / The model
- model classes
- deleting, active record used / Deleting objects using active record and model classes
- my_debug function / Getting ready
N
- name
- of page type, getting / Getting a page type's name, How it works...
- group, loading by / Loading a group by its name
- Navigation helper
- used, for getting page URLs / Getting page URLs and breadcrumbs with the Navigation helper, How it works...
- used, for getting breadcrumbs / Getting page URLs and breadcrumbs with the Navigation helper, How it works...
O
- object
- deleting, active record used / Deleting objects using active record and model classes
- onStartFired handler / Passing parameters to event handlers
- on_before_render() function / How it works...
- on_page_add event / Defining a page type event
- on_page_update event / How it works...
- on_page_view() function / How it works...
- on_start() function / How it works...
P
- package
- block type, installing with / Installing the block type with the package
- installing, in concrete5 / Installing the package in concrete5
- creating / Creating the package
- controller / The package controller
- database XML file / The package database XML file
- model / The model
- single page controllers / Single page controllers
- single page views / Single page views
- event list block type / The event list block type
- block database XML file / The block's database XML file
- block view files / The block view files
- installing / Installing the package
- installing, to dashboard / Installing the package to the dashboard
- package controller
- using, to execute custom code / Using the package controller to execute custom code, See also
- creating / Creating the package controller
- page
- creating / Creating a page type
- creating, steps for / How to do it..., How it works...
- existing page, updating / Updating an existing page, There's more...
- attributes, setting / Setting page attributes, How it works...
- attributes, getting / Getting a page attribute
- ID, getting / Getting a page's ID
- path, getting / Getting a page's path, See also
- handle, getting / Getting a page's handle
- name, getting / Getting a page's name, See also
- description, getting / Getting a page's description
- type handle, getting / Getting a page's page type handle, See also
- theme object, getting / Getting a page's theme object
- children below page, getting / How to do it..., How it works...
- moving / Moving a page, How it works...
- deleting / Deleting a page (and its children), How it works...
- list, getting / Getting ready, How to do it..., There's more...
- block, adding by / Adding a block to a page, How it works...
- creating, for gallery / Creating a page for the gallery
- block, adding / Adding the block to a page
- page footer
- items adding to, block controller used / Adding items to the page header and footer from the block controller, How to do it..., How it works...
- page header
- items adding to, block controller used / Adding items to the page header and footer from the block controller, How to do it..., How it works...
- PageList class / How it works..., There's more...
- page object
- current page object, getting / Getting the current Page object
- getting, by ID / Getting a Page object by its ID, How it works...
- getting, by path / Getting a Page object by its path, How it works...
- page selector field
- adding, to form / Adding a page selector field to a form, How it works...
- PageSelectorHelper class / How to do it...
- page type
- getting, by ID / Getting a page type by its ID, How it works...
- getting, by handle / Getting a page type by its handle, How it works...
- IDs, getting / Getting a page type's ID, How to do it...
- name, getting / Getting a page type's name, How it works...
- handle, getting / Getting a page type's handle, How it works...
- icon, getting / Getting the icon for a page type, There's more...
- pages list, getting / Getting a list of pages that belong to a page type
- creating, steps for / Getting ready, How it works...
- updating, steps for / How to do it..., How it works...
- deleting / Deleting a page type, How to do it...
- page type event
- defining / Defining a page type event, How to do it..., How it works...
- page type templates
- creating / Creating page type templates, There's more...
- page URLs
- getting, with Navigation helper / Getting page URLs and breadcrumbs with the Navigation helper, How it works...
- parameters
- passing, to event handlers / Passing parameters to event handlers, How it works...
- passwords
- setting, on file objects / Setting passwords on file objects
- path
- page object, getting by / Getting a Page object by its path, How it works...
- permission object
- getting / Getting the permission object, How it works...
- pkgID attribute / There's more...
- post variable / How to do it...
- PRB
- about / The Peer Review Board
- prepared statements
- used, forf guarding aginst SQL injections / Guarding against SQL injections using prepared statements, How it works..., There's more...
- print_r function / A note about the code in this chapter
- provinces
- list, getting / Getting a list of states and provinces
R
- rating widget
- displaying, on form / Showing a rating widget on a form
- relationships
- defining, with active record / Defining relationships with active record, How to do it...
- render() function / There's more...
- RSS feed
- loading, with feed helper / Loading an RSS feed with the Feed helper, There's more...
S
- save() function / How it works...
- save function / How to do it...
- scheduled job
- custom scheduled job, creating / Creating a custom scheduled job, How to do it..., How it works...
- scripts / How to do it...
- search attributes
- of file, reindexing / Reindexing a file's search attributes
- selectPage function / How it works...
- setAttribute / How it works...
- setAttribute function / How it works...
- single page
- about / Introduction
- single page controller / Single page controllers
- single pages
- about / Introduction
- on dashboard, controller files creating for / Creating controller files for single pages on the dashboard, How to do it...
- on dashboard, view files creating for / Creating view files for single pages on the dashboard, How to do it..., How it works...
- adding, to dashboard / Adding single pages to the dashboard, How it works...
- single page views / Single page views
- sitemap() function / There's more...
- site_post.php / A note about the code in this chapter
- slug / Getting a page's handle
- spam
- preventing, Captcha helpers used / Preventing spam using the Captcha helper
- SQL injections
- guarding aginst, prepared statements used / Guarding against SQL injections using prepared statements, How to do it..., How it works..., There's more...
- states
- list, getting / Getting a list of states and provinces
- strings
- working with, Text helper used / Working with strings using the Text helper, How it works...
- styles / How to do it...
- system cache
- system events
- listening to / Listening to system events, How to do it...
- system pages
- customizing / Customizing system pages, How it works...
T
- $title variable / How it works...
- t() function / How it works..., The package controller
- Text helper
- used, for working with strings / Working with strings using the Text helper, How it works...
- theme
- custom theme, creating / Creating a custom theme, How to do it..., How it works...
- thumbnails
- generating, with image helper / Generating and caching thumbnails with the Image helper, There's more...
- caching, with image helper / Generating and caching thumbnails with the Image helper, There's more...
- time selector
- showing, on form / Showing a date/time selector on a form, How to do it...
- TinyMCE / Including a WYSIWYG editor on a form
U
- uID attribute / There's more...
- update function / How it works...
- URL Helper
- used, for generating URLs / Generating URLs with the URL helper, There's more...
- URLs
- generating, with URL Helper / Generating URLs with the URL helper, How it works...
- user
- log in status, checking / Checking if the current user is logged in
- currently logged-in user, getting / Getting the currently logged-in user
- loading, by ID / Loading a user by its ID, How it works...
- loading, by user name / Loading a user by its username, See also
- info, getting / Getting a user's info, How it works...
- attributes, setting / Setting a user's attributes, How to do it..., How it works...
- attributes, retrieving / Retrieving a user's attributes, There's more...
- adding, to group / Adding a user to a group, How it works...
- getting, from group / Getting all of the users from a group, How it works...
- group member status, checking / Checking if a user is a member of a group, How it works...
- removing, from group / Removing a user from a group, How it works...
- logging out / Logging out a user, See also
- deleting / Deleting a user
- page reading capability, checking / Checking if a user can read a page, How it works...
- page editing capabi;ity, checking / Checking if a user can edit a page, There's more...
- file permissions, checking / Checking a user's file permissions, There's more...
- UserInfo class / How it works...
- UserInfo object / How to do it...
- username
- user, loading by / Loading a user by its username, How it works...
V
- Validation helpers
- used, for validating input data / Validating input data using the Validation helpers, How it works...
- variables
- sending, from controller to view / Sending variables from the controller to the view, How to do it...
- var_dump function / A note about the code in this chapter
- view
- creating, to display database items list / Creating a view to display a list of database items, Getting ready, How to do it...
- view() function / How it works...
- view files
- creating, for single pages on dashboard / Creating view files for single pages on the dashboard, How to do it..., How it works...
- view function / Giving life to the block
W
- white label CMS
- concrete5, rebranding as / Rebranding concrete5 as a white label CMS, How to do it..., There's more...
- WYSIWYG editor
- including, in form / Including a WYSIWYG editor on a form, How it works...