Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 57 additions & 42 deletions en/appendices/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,50 @@ Glossary

.. glossary::

routing array
An array of attributes that are passed to :php:meth:`Router::url()`.
They typically look like::

['controller' => 'Posts', 'action' => 'view', 5]
CSRF
Cross Site Request Forgery. Prevents replay attacks, double
submissions and forged requests from other domains.

CDN
Content Delivery Network. A 3rd party vendor you can pay to help
distribute your content to data centers around the world. This helps
put your static assets closer to geographically distributed users.

columns
Used in the ORM when referring to the table columns in an database
table.

DSN
Data Source Name. A connection string format that is formed like a URI.
CakePHP supports DSN's for Cache, Database, Log and Email connections.

dot notation
Dot notation defines an array path, by separating nested levels with ``.``
For example::

Cache.default.engine

Would point to the following value::

[
'Cache' => [
'default' => [
'engine' => 'File'
]
]
]


DRY
Don't repeat yourself. Is a principle of software development aimed at
reducing repetition of information of all kinds. In CakePHP DRY is used
to allow you to code things once and re-use them across your
application.

fields
A generic term used to describe both entity properties, or database
columns. Often used in conjunction with the FormHelper.

HTML attributes
An array of key => values that are composed into HTML attributes. For example::
Expand All @@ -27,6 +66,15 @@ Glossary
// Would generate
checked="checked"


PaaS
Platform as a Service. Platform as a Service providers will provide
cloud based hosting, database and caching resources. Some popular
providers include Heroku, EngineYard and PagodaBox

properties
Used when referencing columns mapped onto an ORM entity.

plugin syntax
Plugin syntax refers to the dot separated class name indicating classes
are part of a plugin::
Expand All @@ -37,53 +85,20 @@ Glossary
// The plugin is "AcmeCorp/Tools", and the class name is "Toolbar".
'AcmeCorp/Tools.Toolbar'

dot notation
Dot notation defines an array path, by separating nested levels with ``.``
For example::

Cache.default.engine

Would point to the following value::

[
'Cache' => [
'default' => [
'engine' => 'File'
]
]
]

CSRF
Cross Site Request Forgery. Prevents replay attacks, double
submissions and forged requests from other domains.

CDN
Content Delivery Network. A 3rd party vendor you can pay to help
distribute your content to data centers around the world. This helps
put your static assets closer to geographically distributed users.

routes.php
A file in ``config`` directory that contains routing configuration.
This file is included before each request is processed.
It should connect all the routes your application needs so
requests can be routed to the correct controller + action.

DRY
Don't repeat yourself. Is a principle of software development aimed at
reducing repetition of information of all kinds. In CakePHP DRY is used
to allow you to code things once and re-use them across your
application.

PaaS
Platform as a Service. Platform as a Service providers will provide
cloud based hosting, database and caching resources. Some popular
providers include Heroku, EngineYard and PagodaBox
routing array
An array of attributes that are passed to :php:meth:`Router::url()`.
They typically look like::

DSN
Data Source Name. A connection string format that is formed like a URI.
CakePHP supports DSN's for Cache, Database, Log and Email connections.
['controller' => 'Posts', 'action' => 'view', 5]


.. meta::
:title lang=en: Glossary
:keywords lang=en: html attributes,array class,array controller,glossary glossary,target blank,dot notation,routing configuration,forgery,replay,router,syntax,config,submissions
:keywords lang=en: html attributes,array class,array controller,glossary glossary,target blank,fields,properties,columns,dot notation,routing configuration,forgery,replay,router,syntax,config,submissions
13 changes: 0 additions & 13 deletions en/intro/conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,19 +142,6 @@ Now that you've been introduced to CakePHP's fundamentals, you might try a run
through the :doc:`/tutorials-and-examples/bookmarks/intro` to see how things fit
together.

ORM and FormHelper Naming Conventions
=====================================

While navigating the CakePHP source code, when dealing with the database schema,
fields are often referred to as columns but when dealing with entities,
they are often referred to as properties.

Fields/columns described as keys usually reflect primary or foreign key columns.

When looking for schema columns, database fields and entity properties, make
sure to check if they are referenced by nomenclature field, property or column and
vice versa as this can vary throughout the framework.

.. meta::
:title lang=en: CakePHP Conventions
:keywords lang=en: web development experience,maintenance nightmare,index method,legacy systems,method names,php class,uniform system,config files,tenets,articles,conventions,conventional controller,best practices,maps,visibility,news articles,functionality,logic,cakephp,developers