Initial commit: apps.prometeysev.ru
This commit is contained in:
root committed
commit
96ccabcd8b
6561 files changed
+1270349
No files matched your search
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
import sys, os
|
||||
|
||||
# Append the top level directory of the docs, so we can import from the config dir.
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
# Pull in all the configuration options defined in the global config file..
|
||||
from config.all import *
|
||||
|
||||
language = 'en'
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: CakePHP Bake
|
||||
|
||||
/index
|
||||
/usage
|
||||
/development
|
||||
+304
@@ -0,0 +1,304 @@
|
||||
Extending Bake
|
||||
##############
|
||||
|
||||
Bake features an extensible architecture that allows your application or plugins
|
||||
to modify or add-to the base functionality. Bake makes use of a dedicated
|
||||
view class which uses the `Twig <https://twig.symfony.com/>`_ template engine.
|
||||
|
||||
Bake Events
|
||||
===========
|
||||
|
||||
As a view class, ``BakeView`` emits the same events as any other view class,
|
||||
plus one extra initialize event. However, whereas standard view classes use the
|
||||
event prefix "View.", ``BakeView`` uses the event prefix "Bake.".
|
||||
|
||||
The initialize event can be used to make changes which apply to all baked
|
||||
output, for example to add another helper to the bake view class this event can
|
||||
be used::
|
||||
|
||||
<?php
|
||||
// config/bootstrap_cli.php
|
||||
|
||||
use Cake\Event\Event;
|
||||
use Cake\Event\EventManager;
|
||||
|
||||
EventManager::instance()->on('Bake.initialize', function (Event $event) {
|
||||
$view = $event->getSubject();
|
||||
|
||||
// In my bake templates, allow the use of the MySpecial helper
|
||||
$view->loadHelper('MySpecial', ['some' => 'config']);
|
||||
|
||||
// And add an $author variable so it's always available
|
||||
$view->set('author', 'Andy');
|
||||
|
||||
});
|
||||
|
||||
If you want to modify bake from within another plugin, putting your plugin's
|
||||
bake events in the plugin ``config/bootstrap.php`` file is a good idea.
|
||||
|
||||
Bake events can be handy for making small changes to existing templates.
|
||||
For example, to change the variable names used when baking controller/template
|
||||
files one can use a function listening for ``Bake.beforeRender`` to modify the
|
||||
variables used in the bake templates::
|
||||
|
||||
<?php
|
||||
// config/bootstrap_cli.php
|
||||
|
||||
use Cake\Event\Event;
|
||||
use Cake\Event\EventManager;
|
||||
|
||||
EventManager::instance()->on('Bake.beforeRender', function (Event $event) {
|
||||
$view = $event->getSubject();
|
||||
|
||||
// Use $rows for the main data variable in indexes
|
||||
if ($view->get('pluralName')) {
|
||||
$view->set('pluralName', 'rows');
|
||||
}
|
||||
if ($view->get('pluralVar')) {
|
||||
$view->set('pluralVar', 'rows');
|
||||
}
|
||||
|
||||
// Use $theOne for the main data variable in view/edit
|
||||
if ($view->get('singularName')) {
|
||||
$view->set('singularName', 'theOne');
|
||||
}
|
||||
if ($view->get('singularVar')) {
|
||||
$view->set('singularVar', 'theOne');
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
You may also scope the ``Bake.beforeRender`` and ``Bake.afterRender`` events to
|
||||
a specific generated file. For instance, if you want to add specific actions to
|
||||
your UsersController when generating from a **Controller/controller.twig** file,
|
||||
you can use the following event::
|
||||
|
||||
<?php
|
||||
// config/bootstrap_cli.php
|
||||
|
||||
use Cake\Event\Event;
|
||||
use Cake\Event\EventManager;
|
||||
use Cake\Utility\Hash;
|
||||
|
||||
EventManager::instance()->on(
|
||||
'Bake.beforeRender.Controller.controller',
|
||||
function (Event $event) {
|
||||
$view = $event->getSubject();
|
||||
if ($view->viewVars['name'] == 'Users') {
|
||||
// add the login and logout actions to the Users controller
|
||||
$view->set('actions', [
|
||||
'login',
|
||||
'logout',
|
||||
'index',
|
||||
'view',
|
||||
'add',
|
||||
'edit',
|
||||
'delete'
|
||||
]);
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
By scoping event listeners to specific bake templates, you can simplify your
|
||||
bake related event logic and provide callbacks that are easier to test.
|
||||
|
||||
Bake Template Syntax
|
||||
====================
|
||||
|
||||
Bake template files use the `Twig <https://twig.symfony.com/doc/2.x/>`__ template syntax.
|
||||
|
||||
One way to see/understand how bake templates works, especially when attempting
|
||||
to modify bake template files, is to bake a class and compare the template used
|
||||
with the pre-processed template file which is left in the application's
|
||||
**tmp/bake** folder.
|
||||
|
||||
So, for example, when baking a shell like so:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bin/cake bake shell Foo
|
||||
|
||||
The template used (**vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig**)
|
||||
looks like this::
|
||||
|
||||
<?php
|
||||
namespace {{ namespace }}\Shell;
|
||||
|
||||
use Cake\Console\Shell;
|
||||
|
||||
/**
|
||||
* {{ name }} shell command.
|
||||
*/
|
||||
class {{ name }}Shell extends Shell
|
||||
{
|
||||
/**
|
||||
* main() method.
|
||||
*
|
||||
* @return bool|int Success or error code.
|
||||
*/
|
||||
public function main()
|
||||
{
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
And the resultant baked class (**src/Shell/FooShell.php**) looks like this::
|
||||
|
||||
<?php
|
||||
namespace App\Shell;
|
||||
|
||||
use Cake\Console\Shell;
|
||||
|
||||
/**
|
||||
* Foo shell command.
|
||||
*/
|
||||
class FooShell extends Shell
|
||||
{
|
||||
/**
|
||||
* main() method.
|
||||
*
|
||||
* @return bool|int Success or error code.
|
||||
*/
|
||||
public function main()
|
||||
{
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
.. note::
|
||||
|
||||
Prior to version 1.5.0 bake used a custom erb-style tags inside .ctp template files.
|
||||
|
||||
* ``<%`` A Bake template php open tag
|
||||
* ``%>`` A Bake template php close tag
|
||||
* ``<%=`` A Bake template php short-echo tag
|
||||
* ``<%-`` A Bake template php open tag, stripping any leading whitespace
|
||||
before the tag
|
||||
* ``-%>`` A Bake template php close tag, stripping trailing whitespace after
|
||||
the tag
|
||||
|
||||
.. _creating-a-bake-theme:
|
||||
|
||||
Creating a Bake Theme
|
||||
=====================
|
||||
|
||||
If you wish to modify the output produced by the "bake" command, you can
|
||||
create your own bake 'theme' which allows you to replace some or all of the
|
||||
templates that bake uses. The best way to do this is:
|
||||
|
||||
#. Bake a new plugin. The name of the plugin is the bake 'theme' name
|
||||
#. Create a new directory **plugins/[name]/src/Template/Bake/Template/**.
|
||||
#. Copy any templates you want to override from
|
||||
**vendor/cakephp/bake/src/Template/Bake/Template** to matching files in your
|
||||
plugin.
|
||||
#. When running bake use the ``--theme`` option to specify the bake-theme you
|
||||
want to use. To avoid having to specify this option in each call, you can also
|
||||
set your custom theme to be used as default theme::
|
||||
|
||||
<?php
|
||||
// in config/bootstrap.php or config/bootstrap_cli.php
|
||||
Configure::write('Bake.theme', 'MyTheme');
|
||||
|
||||
Customizing the Bake Templates
|
||||
==============================
|
||||
|
||||
If you wish to modify the default output produced by the "bake" command, you can
|
||||
create your own bake templates in your application. This way does not use the
|
||||
``--theme`` option in the command line when baking. The best way to do this is:
|
||||
|
||||
#. Create a new directory **/src/Template/Bake/**.
|
||||
#. Copy any templates you want to override from
|
||||
**vendor/cakephp/bake/src/Template/Bake/** to matching files in your
|
||||
application.
|
||||
|
||||
Creating New Bake Command Options
|
||||
=================================
|
||||
|
||||
It's possible to add new bake command options, or override the ones provided by
|
||||
CakePHP by creating tasks in your application or plugins. By extending
|
||||
``Bake\Shell\Task\BakeTask``, bake will find your new task and include it as
|
||||
part of bake.
|
||||
|
||||
As an example, we'll make a task that creates an arbitrary foo class. First,
|
||||
create the task file **src/Shell/Task/FooTask.php**. We'll extend the
|
||||
``SimpleBakeTask`` for now as our shell task will be simple. ``SimpleBakeTask``
|
||||
is abstract and requires us to define 3 methods that tell bake what the task is
|
||||
called, where the files it generates should go, and what template to use. Our
|
||||
FooTask.php file should look like::
|
||||
|
||||
<?php
|
||||
namespace App\Shell\Task;
|
||||
|
||||
use Bake\Shell\Task\SimpleBakeTask;
|
||||
|
||||
class FooTask extends SimpleBakeTask
|
||||
{
|
||||
public $pathFragment = 'Foo/';
|
||||
|
||||
public function name()
|
||||
{
|
||||
return 'foo';
|
||||
}
|
||||
|
||||
public function fileName($name)
|
||||
{
|
||||
return $name . 'Foo.php';
|
||||
}
|
||||
|
||||
public function template()
|
||||
{
|
||||
return 'foo';
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Once this file has been created, we need to create a template that bake can use
|
||||
when generating code. Create **src/Template/Bake/foo.twig**. In this file we'll
|
||||
add the following content::
|
||||
|
||||
<?php
|
||||
namespace {{ namespace }}\Foo;
|
||||
|
||||
/**
|
||||
* {{ name }} foo
|
||||
*/
|
||||
class {{ name }}Foo
|
||||
{
|
||||
// Add code.
|
||||
}
|
||||
|
||||
You should now see your new task in the output of ``bin/cake bake``. You can
|
||||
run your new task by running ``bin/cake bake foo Example``.
|
||||
This will generate a new ``ExampleFoo`` class in **src/Foo/ExampleFoo.php**
|
||||
for your application to use.
|
||||
|
||||
If you want the ``bake`` call to also create a test file for your
|
||||
``ExampleFoo`` class, you need to overwrite the ``bakeTest()`` method in the
|
||||
``FooTask`` class to register the class suffix and namespace for your custom
|
||||
command name::
|
||||
|
||||
public function bakeTest($className)
|
||||
{
|
||||
if (!isset($this->Test->classSuffixes[$this->name()])) {
|
||||
$this->Test->classSuffixes[$this->name()] = 'Foo';
|
||||
}
|
||||
|
||||
$name = ucfirst($this->name());
|
||||
if (!isset($this->Test->classTypes[$name])) {
|
||||
$this->Test->classTypes[$name] = 'Foo';
|
||||
}
|
||||
|
||||
return parent::bakeTest($className);
|
||||
}
|
||||
|
||||
* The **class suffix** will be appened to the name provided in your ``bake``
|
||||
call. In the previous example, it would create a ``ExampleFooTest.php`` file.
|
||||
* The **class type** will be the sub-namespace used that will lead to your
|
||||
file (relative to the app or the plugin you are baking into). In the previous
|
||||
example, it would create your test with the namespace ``App\Test\TestCase\Foo``
|
||||
.
|
||||
|
||||
.. meta::
|
||||
:title lang=en: Extending Bake
|
||||
:keywords lang=en: command line interface,development,bake view, bake template syntax,twig,erb tags,percent tags
|
||||
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
Bake Console
|
||||
############
|
||||
|
||||
CakePHP's bake console is another effort to get you up and running in CakePHP
|
||||
– fast. The bake console can create any of CakePHP's basic ingredients: models,
|
||||
behaviors, views, helpers, controllers, components, test cases, fixtures and plugins.
|
||||
And we aren't just talking skeleton classes: Bake can create a fully functional
|
||||
application in just a few minutes. In fact, Bake is a natural step to take once
|
||||
an application has been scaffolded.
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
Before trying to use or extend bake, make sure it is installed in your
|
||||
application. Bake is provided as a plugin that you can install with Composer::
|
||||
|
||||
composer require --dev cakephp/bake:~1.0
|
||||
|
||||
The above will install bake as a development dependency. This means that it will
|
||||
not be installed when you do production deployments.
|
||||
|
||||
When using the Twig templates make sure you are loading the
|
||||
``WyriHaximus/TwigView`` plugin with its bootstrap. You can also omit it
|
||||
completely which then makes Bake plugin load this plugin on demand.
|
||||
|
||||
.. meta::
|
||||
:title lang=en: Bake Console
|
||||
:keywords lang=en: command line interface,development,bake view, bake template syntax,erb tags,asp tags,percent tags
|
||||
+133
@@ -0,0 +1,133 @@
|
||||
Code Generation with Bake
|
||||
#########################
|
||||
|
||||
The cake console is run using the PHP CLI (command line interface).
|
||||
If you have problems running the script, ensure that:
|
||||
|
||||
#. You have the PHP CLI installed and that it has the proper modules enabled
|
||||
(eg: MySQL, intl).
|
||||
#. Users also might have issues if the database host is 'localhost' and should
|
||||
try '127.0.0.1' instead, as localhost can cause issues with PHP CLI.
|
||||
#. Depending on how your computer is configured, you may have to set execute
|
||||
rights on the cake bash script to call it using ``bin/cake bake``.
|
||||
|
||||
Before running bake you should make sure you have at least one database
|
||||
connection configured.
|
||||
|
||||
When run with no arguments ``bin/cake bake`` will output a list of available
|
||||
tasks.
|
||||
|
||||
For windows system try with ``bin\cake bake``.
|
||||
|
||||
You should see something like::
|
||||
|
||||
$ bin/cake bake
|
||||
|
||||
Welcome to CakePHP v3.4.6 Console
|
||||
---------------------------------------------------------------
|
||||
App : src
|
||||
Path: /var/www/cakephp.dev/src/
|
||||
PHP : 5.6.20
|
||||
---------------------------------------------------------------
|
||||
The following commands can be used to generate skeleton code for your application.
|
||||
|
||||
Available bake commands:
|
||||
|
||||
- all
|
||||
- behavior
|
||||
- cell
|
||||
- component
|
||||
- controller
|
||||
- fixture
|
||||
- form
|
||||
- helper
|
||||
- mailer
|
||||
- migration
|
||||
- migration_diff
|
||||
- migration_snapshot
|
||||
- model
|
||||
- plugin
|
||||
- seed
|
||||
- shell
|
||||
- shell_helper
|
||||
- task
|
||||
- template
|
||||
- test
|
||||
|
||||
By using `cake bake [name]` you can invoke a specific bake task.
|
||||
|
||||
You can get more information on what each task does, and what options are
|
||||
available using the ``--help`` option::
|
||||
|
||||
$ bin/cake bake --help
|
||||
|
||||
Welcome to CakePHP v3.4.6 Console
|
||||
---------------------------------------------------------------
|
||||
App : src
|
||||
Path: /var/www/cakephp.dev/src/
|
||||
PHP : 5.6.20
|
||||
---------------------------------------------------------------
|
||||
The Bake script generates controllers, models and template files for
|
||||
your application. If run with no command line arguments, Bake guides the
|
||||
user through the class creation process. You can customize the
|
||||
generation process by telling Bake where different parts of your
|
||||
application are using command line arguments.
|
||||
|
||||
Usage:
|
||||
cake bake.bake [subcommand] [options]
|
||||
|
||||
Subcommands:
|
||||
|
||||
all Bake a complete MVC skeleton.
|
||||
behavior Bake a behavior class file.
|
||||
cell Bake a cell class file.
|
||||
component Bake a component class file.
|
||||
controller Bake a controller skeleton.
|
||||
fixture Generate fixtures for use with the test suite. You
|
||||
can use `bake fixture all` to bake all fixtures.
|
||||
form Bake a form class file.
|
||||
helper Bake a helper class file.
|
||||
mailer Bake a mailer class file.
|
||||
migration Bake migration class.
|
||||
migration_diff Bake migration class.
|
||||
migration_snapshot Bake migration snapshot class.
|
||||
model Bake table and entity classes.
|
||||
plugin Create the directory structure, AppController class
|
||||
and testing setup for a new plugin. Can create
|
||||
plugins in any of your bootstrapped plugin paths.
|
||||
seed Bake seed class.
|
||||
shell Bake a shell class file.
|
||||
shell_helper Bake a shell_helper class file.
|
||||
task Bake a task class file.
|
||||
template Bake views for a controller, using built-in or
|
||||
custom templates.
|
||||
test Bake test case skeletons for classes.
|
||||
|
||||
To see help on a subcommand use `cake bake.bake [subcommand] --help`
|
||||
|
||||
Options:
|
||||
|
||||
--connection, -c Database connection to use in conjunction with `bake
|
||||
all`. (default: default)
|
||||
--everything Bake a complete MVC skeleton, using all the available
|
||||
tables. Usage: "bake all --everything"
|
||||
--force, -f Force overwriting existing files without prompting.
|
||||
--help, -h Display this help.
|
||||
--plugin, -p Plugin to bake into.
|
||||
--prefix Prefix to bake controllers and templates into.
|
||||
--quiet, -q Enable quiet output.
|
||||
--tablePrefix Table prefix to be used in models.
|
||||
--theme, -t The theme to use when baking code. (choices:
|
||||
Bake|Migrations)
|
||||
--verbose, -v Enable verbose output.
|
||||
|
||||
Bake Themes
|
||||
===========
|
||||
|
||||
The theme option is common to all bake commands, and allows changing the bake
|
||||
template files used when baking. To create your own templates, see the
|
||||
:ref:`bake theme creation documentation <creating-a-bake-theme>`.
|
||||
|
||||
.. meta::
|
||||
:title lang=en: Code Generation with Bake
|
||||
:keywords lang=en: command line interface,functional application,database,database configuration,bash script,basic ingredients,project,model,path path,code generation,scaffolding,windows users,configuration file,few minutes,config,iew,shell,models,running,mysql
|
||||
Reference in new issue
Block a user