├── README.md
└── code_2nd_ed
    ├── .DS_Store
    ├── drupal7
        ├── mymodule
        │   ├── README.txt
        │   ├── mymodule-hookname.tpl.php
        │   ├── mymodule.info
        │   ├── mymodule.install
        │   ├── mymodule.js
        │   ├── mymodule.module
        │   ├── mymodule.rules.inc
        │   ├── mymodule.rules_defaults.inc
        │   ├── plugins
        │   │   └── ctools-relationships
        │   │   │   └── mymodule_relationship_most_recent_content.inc
        │   ├── rules
        │   │   └── sample_rule.txt
        │   └── tests
        │   │   └── mymodule.test
        └── mytheme
        │   ├── README.txt
        │   ├── mytheme.info
        │   └── templates
        │       └── page.tpl.php
    └── drupal8
        ├── mymodule
            ├── README.txt
            ├── config
            │   ├── install
            │   │   └── mymodule.settings.yml
            │   ├── optional
            │   │   └── views.view.myentity_content_list.yml
            │   └── schema
            │   │   └── mymodule.schema.yml
            ├── mymodule.info.yml
            ├── mymodule.install
            ├── mymodule.js
            ├── mymodule.libraries.yml
            ├── mymodule.links.action.yml
            ├── mymodule.links.menu.yml
            ├── mymodule.links.task.yml
            ├── mymodule.module
            ├── mymodule.permissions.yml
            ├── mymodule.routing.yml
            ├── mymodule.services.yml
            ├── src
            │   ├── Controller
            │   │   └── MyUrlController.php
            │   ├── Entity
            │   │   ├── MyEntity.php
            │   │   ├── MyEntityDeleteForm.php
            │   │   ├── MyEntityForm.php
            │   │   ├── MyEntityInterface.php
            │   │   ├── MyEntityType.php
            │   │   ├── MyEntityTypeDeleteForm.php
            │   │   ├── MyEntityTypeForm.php
            │   │   ├── MyEntityTypeInterface.php
            │   │   ├── MyEntityTypeListBuilder.php
            │   │   └── MyEntityViewsData.php
            │   ├── Form
            │   │   ├── ConfirmDeleteForm.php
            │   │   └── PersonalDataForm.php
            │   ├── Plugin
            │   │   ├── Block
            │   │   │   └── MyModuleFirstBlock.php
            │   │   ├── Field
            │   │   │   ├── FieldFormatter
            │   │   │   │   └── MyCustomText.php
            │   │   │   └── FieldWidget
            │   │   │   │   └── MyCustomText.php
            │   │   └── views
            │   │   │   └── wizard
            │   │   │       └── MyEntityViewsWizard.php
            │   ├── Routing
            │   │   └── MyModuleRouting.php
            │   └── Tests
            │   │   ├── MyModuleEnableTest.php
            │   │   ├── MyModuleEntityTest.php
            │   │   ├── MyModulePageTest.php
            │   │   ├── MyModuleSnippetsTest.php
            │   │   ├── MyThemeTest.php
            │   │   └── ProgrammersGuideTestBase.php
            └── templates
            │   ├── myentity.html.twig
            │   └── mymodule-hookname.html.twig
        └── mytheme
            ├── README.txt
            ├── mytheme.info.yml
            └── templates
                └── page.html.twig


/README.md:
--------------------------------------------------------------------------------
 1 | Programmer's Guide to Drupal
 2 | ============================
 3 | 
 4 | This is the example code that accompanies
 5 | [Programmer's Guide to Drupal, Second edition](http://shop.oreilly.com/product/0636920034612.do), by
 6 | [Jennifer Hodgdon](https://github.com/jhodgdon-drp) (ISBN: 978-1-4919-1146-4).
 7 | 
 8 | Click the Download Zip button on this page to download the code.
 9 | 
10 | See an error?
11 | [Report errors here](http://oreilly.com/catalog/errata.csp?isbn=0636920034612),
12 | or simply fork and send us a pull request.
13 | 


--------------------------------------------------------------------------------
/code_2nd_ed/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oreillymedia/programmers_guide_to_drupal/38af1d88ba559579a6e5d7065e65a45f9e87fec2/code_2nd_ed/.DS_Store


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/README.txt:
--------------------------------------------------------------------------------
 1 | This directory contains the Drupal module 7 code from the book "Programmers
 2 | Guide to Drupal", by Jennifer Hodgdon, second edition, 2014.
 3 | 
 4 | License: See book for details of license and copyright.
 5 | 
 6 | Dependencies:
 7 | 
 8 | Some of the code in the sample module depends on the contributed Entity API
 9 | module, so you cannot enable this module without it. Some of the other code is
10 | for integration with Rules, Panels, and CTools, but as it doesn't run without
11 | those modules installed, they are not listed as dependencies of this
12 | module. Modules mentioned:
13 | - https://drupal.org/project/ctools
14 | - https://drupal.org/project/entity
15 | - https://drupal.org/project/panels
16 | - https://drupal.org/project/rules
17 | 
18 | Contents of this directory:
19 | 
20 | - mymodule.module: Module file containing code from many sections of the book.
21 | - mymodule.info: Info file for module.
22 | - mymodule.install: Install hooks for module, from several sections of the book.
23 | 
24 | - mymodule.js: Empty JavaScript file for inclusion in a form array.
25 | 
26 | - mymodule.tpl.php: Theme template file from section "Making Your Output
27 |   Themeable", Chapter 2.
28 | 
29 | - mymodule.rules.inc: Rules action from section "Providing Custom Actions to
30 |   Rules", chapter 4.
31 | - mymodule.rules_defaults.inc: Default rule provision from section "Providing
32 |   Default Reaction Rules and Components", chapter 4.
33 | - rules/sample_rule.txt: Exported sample rule for default rule provision.
34 | 
35 | - plugins/ctools-relationships/mymodule_relationship_most_recent_content.inc:
36 |   CTools relationship plugin from "Implementing CTools Plugins in Drupal 7",
37 |   chapter 4.
38 | 
39 | - tests/mymodule.test: SimpleTest test classes for code from the book.
40 | 
41 | Note: There is some functionality in the sample code that involves
42 | JavaScript, and therefore cannot be tested within the SimpleTest framework.
43 | To test it manually, you'll need to put this module in your sites/all/modules
44 | directory, enable the "My Module" module, and do the following:
45 | 
46 | 1. On the Personal Data Form page at example.com/mymodule/my_form_page :
47 |    a. When you visit the page, there should be a JavaScript alert box saying
48 |       "Hello!".
49 |    b. The field labeled "Autocomplete field" should have auto-complete behavior.
50 |       It is set up with a proxy that just adds some fixed text after
51 |       whatever you type in, so you should see some choices. You will need
52 |       to have 'Use company field' permission to see the auto-complete.
53 |    c. If you type in the field labeled "Type here to trigger Ajax", you should
54 |       see a message saying "You have triggered Ajax", and just below that, a
55 |       line saying "You typed [whatever you typed]".
56 |    d. If you click the button that says "Click here to trigger Ajax", you
57 |       should see a message saying "The button has been clicked", with a
58 |       light green background.
59 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule-hookname.tpl.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Sample theme template.
 6 |  *
 7 |  * From section "Making Your Output Themeable" in Chapter 2.
 8 |  *
 9 |  * This produces the same output as theme_mymodule_hookname_2(), but using
10 |  * a template file.
11 |  *
12 |  * @see mymodule_theme()
13 |  * @see theme_mymodule_hookname_2()
14 |  */
15 | ?>
16 | <div><?php print $input1; ?></div>
17 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.info:
--------------------------------------------------------------------------------
 1 | ; Drupal 7 sample module .info file
 2 | 
 3 | ; Comments start with ;
 4 | 
 5 | ; The name displayed on the Modules list page.
 6 | name = My Module
 7 | 
 8 | ; The longer description displayed on the Modules list.
 9 | description = Sample module from Programmers Guide to Drupal
10 | 
11 | ; The Drupal core version this module is compatible with.
12 | core = 7.x
13 | 
14 | ; Dependencies on other modules.
15 | dependencies[] = node
16 | dependencies[] = entity
17 | 
18 | ; Files that Drupal needs to be notified of.
19 | files[] = mymodule-hookname.tpl.php
20 | files[] = tests/mymodule.test
21 | 
22 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.install:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Install hooks for sample module.
  6 |  */
  7 | 
  8 | /**
  9 |  * Implements hook_enable().
 10 |  *
 11 |  * From "Internationalizing User-Entered Text in Drupal 7", Chapter 2:
 12 |  * creates a taxonomy vocabulary, for use in storing configuration.
 13 |  */
 14 | function mymodule_enable() {
 15 |   // Create the vocabulary if it doesn't already exist.
 16 |   $vocabulary = taxonomy_vocabulary_load(variable_get('mymodule_vocabulary', 0));
 17 |   if (!$vocabulary) {
 18 |     $vocabulary = (object) array(
 19 |       'name' => t('Some appropriate name'),
 20 |       'machine_name' => 'mymodule_appropriate_name',
 21 |       'description' => t('Some appropriate description'),
 22 |       'module' => 'mymodule',
 23 |     );
 24 |     taxonomy_vocabulary_save($vocabulary);
 25 |     variable_set('mymodule_vocabulary', $vocabulary->vid);
 26 |   }
 27 | }
 28 | 
 29 | /**
 30 |  * Implements hook_schema().
 31 |  *
 32 |  * 'mymodule_foo' table is from "Setting up Database Tables", Chapter 2.
 33 |  *
 34 |  * 'mymodule_myentity' table is from "Defining an Entity Type in Drupal 7",
 35 |  * chapter 4.
 36 |  */
 37 | function mymodule_schema() {
 38 |   $schema = array();
 39 | 
 40 |   // Define a simple table.
 41 |   $schema['mymodule_foo'] = array(
 42 |     'description' => 'Untranslated description of this table',
 43 |     'fields' => array(
 44 |       'bar' => array(
 45 |         'description' => 'Untranslated description of this field',
 46 |         'type' => 'varchar',
 47 |         'length' => 50,
 48 |         'default' => '',
 49 |       ),
 50 |       'baz' => array(
 51 |         'description' => 'Untranslated description of this field',
 52 |         'type' => 'int',
 53 |         'unsigned' => TRUE,
 54 |         'default' => 0,
 55 |       ),
 56 |     ),
 57 |     'primary key' => array('baz'),
 58 |   );
 59 | 
 60 |   // Define a table for entity storage.
 61 |   $schema['mymodule_myentity'] = array(
 62 |     'description' => 'Storage for myentity entity: settings for mymodule',
 63 |     'fields' => array(
 64 |      'myentity_id' => array(
 65 |         'description' => 'Primary key: settings ID.',
 66 |         'type' => 'serial',
 67 |         'unsigned' => TRUE,
 68 |         'not null' => TRUE,
 69 |       ),
 70 |       'title' => array(
 71 |         'description' => 'Label assigned to this set of settings',
 72 |         'type' => 'varchar',
 73 |         'length' => 200,
 74 |         'default' => '',
 75 |       ),
 76 |       'language' => array(
 77 |         'description' => 'Language of this set of settings',
 78 |         'type' => 'varchar',
 79 |         'length' => 12,
 80 |         'not null' => TRUE,
 81 |         'default' => '',
 82 |       ),
 83 |       // Consider adding additional fields for time created, time updated.
 84 |     ),
 85 | 
 86 |     'primary key' => array('myentity_id'),
 87 | 
 88 |     'indexes' => array(
 89 |       'language' => array('language'),
 90 |       // Add indexes for created/updated here too.
 91 |     ),
 92 |   );
 93 | 
 94 |   return $schema;
 95 | }
 96 | 
 97 | /**
 98 |  * Make one field wider and add a new field in the mymodule_foo table.
 99 |  *
100 |  * From Setting up Database Tables section in Chapter 2.
101 |  *
102 |  * Note: If you actually want to run this update, change the function name
103 |  * to remove the "not_", and then visit example.com/update.php.
104 |  */
105 | function not_mymodule_update_7001() {
106 |   db_change_field('mymodule_foo', 'bar', 'bar', array(
107 |     'description' => 'Untranslated description of this field',
108 |     'type' => 'varchar',
109 |     'length' => 150,
110 |     'default' => '',
111 |   ));
112 |   db_add_field('mymodule_foo', 'bay', array(
113 |     'description' => 'Untranslated description of this field',
114 |     'type' => 'varchar',
115 |     'length' => 50,
116 |     'default' => '',
117 |   ));
118 | }
119 | 
120 | /**
121 |  * Implements hook_install().
122 |  *
123 |  * From "Defining an Entity Type in Drupal 7", chapter 4. Adds two fields to
124 |  * this internal-use entity type.
125 |  */
126 | function mymodule_install() {
127 |   // Create a plain text field for a setting.
128 |   $field = field_create_field(array(
129 |     'field_name' => 'myentity_setting_1',
130 |     'type' => 'text',
131 |     'entity_types' => array('myentity'),
132 |     'locked' => TRUE,
133 |     'translatable' => TRUE,
134 |   ));
135 | 
136 |   // Attach the field to the entity bundle.
137 |   $instance = field_create_instance(array(
138 |     'field_name' => 'myentity_setting_1',
139 |     'entity_type' => 'myentity',
140 |     'bundle' => 'myentity',
141 |     'label' => t('Setting 1'),
142 |     'description' => t('Help for this setting'),
143 |     'required' => TRUE,
144 |     'widget' => array(
145 |       'type' => 'text_textfield',
146 |     ),
147 |     'display' => array(
148 |       'default' => array(
149 |         'label' => 'above',
150 |         'type' => 'text_default',
151 |       ),
152 |     ),
153 |   ));
154 | 
155 |   // Repeat these two function calls for each additional field.
156 | }
157 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.js:
--------------------------------------------------------------------------------
1 | // JavaScript file (empty) for this module.
2 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.module:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Sample module for Drupal 7.
  6 |  */
  7 | 
  8 | /**
  9 |  * Implements hook_theme().
 10 |  *
 11 |  * From section "Making Your Output Themeable" in Chapter 2.
 12 |  *
 13 |  * To use the first theme hook in a render array:
 14 |  * @code
 15 |  * $build['hello'] = array(
 16 |  *   '#input1' => t('Hello World!'),
 17 |  *   '#theme' => 'mymodule_hookname',
 18 |  * );
 19 |  * @endcode
 20 |  *
 21 |  * To use the second theme hook in a call to theme() directly:
 22 |  * @code
 23 |  * $data = array('input1' => t('Hello World!'));
 24 |  * $output = theme('mymodule_hookname_2', $data);
 25 |  * @endcode
 26 |  *
 27 |  * @see theme_mymodule_hookname_2()
 28 |  * @see mymodule-hookname.tpl.php
 29 |  */
 30 | function mymodule_theme($existing, $type, $theme, $path) {
 31 |   return array(
 32 |     // The array keys are names of the theme hooks you are defining.
 33 |     'mymodule_hookname' => array(
 34 |       // Input variables.
 35 |       'variables' => array(
 36 |         // These are passed as an array to theme(), which passes them on
 37 |         // to your theme function or template. Here, provide default values.
 38 |         'input1' => '',
 39 |       ),
 40 |       // If you want to use a template, include this line; for a theme
 41 |       // function, leave it out.
 42 |       'template' => 'mymodule-hookname',
 43 |     ),
 44 | 
 45 |     // Define a second theme hook, using a theme function.
 46 |     'mymodule_hookname_2' => array(
 47 |       'variables' => array(
 48 |         'input1' => '',
 49 |       ),
 50 |     ),
 51 |   );
 52 | }
 53 | 
 54 | /**
 55 |  * Sample theme function to go with the hook_theme() implementation.
 56 |  *
 57 |  * This produces the same output as mymodule-hookname.tpl.php, but using
 58 |  * a theme function.
 59 |  *
 60 |  * From section "Making Your Output Themeable" in Chapter 2.
 61 |  *
 62 |  * @see mymodule_theme()
 63 |  * @see mymodule-hookname.tpl.php
 64 |  */
 65 | function theme_mymodule_hookname_2($variables) {
 66 |   return '<div>' . $variables['input1'] . '</div>';
 67 | }
 68 | 
 69 | /**
 70 |  * Implements hook_permission().
 71 |  */
 72 | function mymodule_permission() {
 73 |   return array(
 74 |     // Sample permission from "Drupal core's main permission system" section
 75 |     // in Chapter 2.
 76 | 
 77 |     // The array keys in hook_permission() are the permissions' machine names.
 78 |     'administer mymodule' => array(
 79 |       'title' => t('Administer My Module settings'), // Human-readable name.
 80 |       'description' => t('Longer description only if it is really necessary.'),
 81 |     ),
 82 | 
 83 |     // Permission for mymodule_personal_data_form().
 84 |     'use company field' => array(
 85 |       'title' => t('Use the Company field'),
 86 |     ),
 87 | 
 88 |     // Permission for confirmation form.
 89 |     'delete mycontent items' => array(
 90 |       'title' => t('Delete ficticious content items'),
 91 |     ),
 92 | 
 93 |     // Entity access permissions, from "Defining an Entity Type in Drupal 7",
 94 |     // chapter 4.
 95 |     'view myentity' => array(
 96 |       'title' => t('View my entity content'),
 97 |     ),
 98 |     'administer myentity' => array(
 99 |       'title' => t('Administer my entities'),
100 |     ),
101 | 
102 |   );
103 | }
104 | 
105 | /**
106 |  * Implements hook_menu().
107 |  *
108 |  * @see mymodule_page_generate()
109 |  * @see mymodule_personal_data_form()
110 |  * @see mymodule_confirm_delete()
111 |  * @see mymodule_autocomplete()
112 |  * @see mymodule_entity_info()
113 |  * @see mymodule_myentity_uri()
114 |  */
115 | function mymodule_menu() {
116 |   $items = array();
117 | 
118 |   // First path is from "Registering for a URL in Drupal 7" section, chapter 4.
119 | 
120 |   // The array key is the URL path.
121 |   $items['mymodule/mypath'] = array(
122 |     // Do not translate this! It will be translated when it is output.
123 |     'title' => 'My page title',
124 | 
125 |     // Function that will generate the content.
126 |     'page callback' => 'mymodule_page_generate',
127 | 
128 |     // Function used to check permissions. This defaults to user_access(),
129 |     // which is provided here as an illustration -- you can omit this line
130 |     // if you want to use the user_access() function. Put the name of your
131 |     // custom access check function here if you have one.
132 |     'access callback' => 'user_access',
133 | 
134 |     // Arguments needed for your access callback function. If using the
135 |     // default user_access() function, the argument is the name of the
136 |     // permission a user must have to access the page.
137 |     'access arguments' => array('administer mymodule'),
138 |   );
139 | 
140 |   // Second path is from "Basic Form Generation and Processing in Drupal 7",
141 |   // chapter 4.
142 | 
143 |   $items['mymodule/my_form_page'] = array(
144 |     'page callback' => 'drupal_get_form',
145 |     'page arguments' => array('mymodule_personal_data_form'),
146 |     'access callback' => TRUE,
147 |     'title' => 'Personal data form',
148 |   );
149 | 
150 |   // Third path is from "Creating Confirmation Forms", chapter 4.
151 | 
152 |   // Assume there is a content ID number.
153 |   $items['admin/content/mycontent/delete/%'] = array(
154 |     'title' => 'Delete content item?',
155 |     'page callback' => 'drupal_get_form',
156 |     // Pass the content ID number to the form generating function.
157 |     // It is position 4 in the path (starting from 0).
158 |     'page arguments' => array('mymodule_confirm_delete', 4),
159 |     // Permission needs to be defined in a hook_permission().
160 |     'access arguments' => array('delete mycontent items'),
161 |   );
162 | 
163 |   // Fourth path is for autocomplete, from "Adding Auto-Complete to Forms",
164 |   // chapter 4.
165 | 
166 |   $items['mymodule/autocomplete'] = array(
167 |     'page callback' => 'mymodule_autocomplete',
168 |     'access arguments' => array('use company field'),
169 |     'type' => MENU_CALLBACK,
170 |   );
171 | 
172 |   // Fifth path is for displaying an entity, from "Defining an Entity Type
173 |   // in Drupal 7", chapter 4. If you do not need a page for displaying the
174 |   // entity (for internal-use settings storage, for instance), you do not
175 |   // need this path entry and the callbacks it references.
176 | 
177 |   // Register for the URL that mymodule_myentity_uri() returns.
178 |   // The placeholder %entity_object in the URL is handled by the Entity
179 |   // API function entity_object_load().
180 |   $items['myentity/%entity_object'] = array(
181 |     // entity_object_load() needs to know what the entity type is.
182 |     'load arguments' => array('myentity'),
183 | 
184 |     // Use a callback for the page title, not a static title.
185 |     'title callback' => 'mymodule_myentity_page_title',
186 |     'title arguments' => array(1),
187 | 
188 |     // Callback to display the entity.
189 |     'page callback' => 'entity_ui_entity_page_view',
190 |     'page arguments' => array(1),
191 | 
192 |     // Access callback.
193 |     'access callback' => 'mymodule_myentity_access',
194 |     'access arguments' => array('view', array(1)),
195 |   );
196 | 
197 |   return $items;
198 | }
199 | 
200 | /**
201 |  * Generates page content for path 'mymodule/mypath'.
202 |  *
203 |  * Function body from "Generating paged output", in Chapter 4.
204 |  */
205 | function mymodule_page_generate() {
206 |   // Find the most recently updated nodes.
207 | 
208 |   // Note: You should really use the Views module to do this! Code is
209 |   // only here to illustrate using the PagerDefault extension to a query,
210 |   // and 'pager' theme in a render array.
211 | 
212 |   $query = db_select('node', 'n')
213 |     ->fields('n', array('title'))
214 |     ->orderBy('n.created', 'DESC')
215 |     // Be sure to check permissions, and only show published items.
216 |     ->addTag('node_access')
217 |     ->condition('n.status', 1)
218 |     // Put this last, because the return value is a new object.
219 |     ->extend('PagerDefault');
220 | 
221 |   // This only applies with the PagerDefault extension.
222 |   $query->limit(10);
223 |   $result = $query->execute();
224 | 
225 |   // Extract and sanitize the information from the query result.
226 |   $titles = array();
227 |   foreach ($result as $row) {
228 |     $titles[] = check_plain($row->title);
229 |   }
230 | 
231 |   // Make the render array for a paged list of titles.
232 |   $build = array();
233 | 
234 |   // The list of titles.
235 |   $build['items'] = array(
236 |     '#theme' => 'item_list',
237 |     '#items' => $titles,
238 |   );
239 | 
240 |   // The pager.
241 |   $build['item_pager'] = array('#theme' => 'pager');
242 | 
243 |   return $build;
244 | }
245 | 
246 | /**
247 |  * Implements hook_block_info().
248 |  *
249 |  * From "Registering a Block in Drupal 7", chapter 4.
250 |  */
251 | function mymodule_block_info() {
252 |   $blocks = array();
253 | 
254 |   // The array key is known as the block "delta" (a unique identifier
255 |   // within your module), and is used in other block hooks. Choose
256 |   // something descriptive.
257 |   $blocks['first_block'] = array(
258 |     // The name shown on the Blocks administration page.
259 |     // Be descriptive and unique across all blocks.
260 |     'info' => t('First block from My Module'),
261 |   );
262 | 
263 |   return $blocks;
264 | }
265 | 
266 | /**
267 |  * Implements hook_block_view().
268 |  *
269 |  * From "Registering a Block in Drupal 8", chapter 4.
270 |  */
271 | function mymodule_block_view($delta = '') {
272 |   if ($delta == 'first_block') {
273 |     return array(
274 |       // The block's default title.
275 |       'subject' => t('First block'),
276 |       // The block's content.
277 |       'content' => mymodule_block_generate(),
278 |     );
279 |   }
280 | }
281 | 
282 | /**
283 |  * Generates block content for mymodule_block_view().
284 |  *
285 |  * Function body from "Creating Render Arrays for Page and Block Output",
286 |  * chapter 4.
287 |  */
288 | function mymodule_block_generate() {
289 |   // Build a render array.
290 |   $output = array(
291 |     // Introductory paragraph, using the elemnt type 'markup'.
292 |     'introduction' => array(
293 |       '#type' => 'markup',
294 |       '#markup' => '<p>' . t('General information goes here.') . '</p>',
295 |     ),
296 | 
297 |     // List of items, using the theme hook 'item_list'.
298 |     'colors' => array(
299 |       '#theme' => 'item_list',
300 |       '#items' => array(t('Red'), t('Blue'), t('Green')),
301 |       '#title' => t('Colors'),
302 |     ),
303 | 
304 |     // Table, using the theme hook 'table'.
305 |     'materials' => array(
306 |       '#theme' => 'table',
307 |       '#caption' => t('Materials'),
308 |       '#header' => array(t('Material'), t('Characteristic')),
309 |       '#rows' => array(
310 |         array(t('Steel'), t('Strong')),
311 |         array(t('Aluminum'), t('Light')),
312 |       ),
313 |     ),
314 |   );
315 | 
316 |   return $output;
317 | }
318 | 
319 | /**
320 |  * Form constructor for a personal data form.
321 |  *
322 |  * From "Basic Form Generation and Processing in Drupal 7", chapter 4.
323 |  *
324 |  * Most of form array is from "Form Arrays, Form State Arrays, and
325 |  * Form State Objects", chapter 4.
326 |  *
327 |  * Auto-complete field from "Adding Auto-Complete to Forms", chapter 4.
328 |  *
329 |  * JavaScript attachment from "Creating Render Arrays for Page and Block
330 |  * Output", chapter 4.
331 |  *
332 |  * Ajax fields from "Setting Up a Form for Ajax", chapter 4.
333 |  *
334 |  * @see mymodule_permission()
335 |  * @see mymodule_personal_data_form_submit()
336 |  * @see mymodule_autocomplete()
337 |  * @see mymodule_ajax_text_callback()
338 |  * @see mymodule_ajax_button_callback()
339 |  */
340 | function mymodule_personal_data_form($form, &$form_state) {
341 |   // Define the form array.
342 | 
343 |   // Plain text input element for first name.
344 |   $form['first_name'] = array(
345 |     '#type' => 'textfield',
346 |     '#title' => t('First name'),
347 |   );
348 | 
349 |   // Plain text element for company name, only visible to some
350 |   // users.
351 |   $form['company'] = array(
352 |     '#type' => 'textfield',
353 |     '#title' => t('Company'),
354 |     // This assumes permission 'use company field' has been defined.
355 |     '#access' => user_access('use company field'),
356 |   );
357 | 
358 |   $my_information = 'stuff';
359 | 
360 |   // Some hidden information to be used later.
361 |   $form['information'] = array(
362 |     '#type' => 'value',
363 |     '#value' => $my_information,
364 |   );
365 | 
366 |   // Submit button.
367 |   $form['submit'] = array(
368 |     '#type' => 'submit',
369 |     '#value' => t('Submit'),
370 |   );
371 | 
372 |   // Attach a JavaScript file.
373 |   $form['#attached']['js'][] =
374 |     drupal_get_path('module', 'mymodule') . '/mymodule.js';
375 | 
376 |   // Attach some in-line JavaScript code.
377 |   $my_code = 'alert("Hello!");';
378 |   $form['#attached']['js'][] = array(
379 |     'type' => 'inline',
380 |     'data' => $my_code,
381 |   );
382 | 
383 |   // Auto-complete field.
384 |   $form['my_autocomplete_field'] = array(
385 |     '#type' => 'textfield',
386 |     '#title' => t('Autocomplete field'),
387 |     '#autocomplete_path' => 'mymodule/autocomplete',
388 |   );
389 | 
390 |   // Ajax elements.
391 | 
392 |   $form['ajax_output_1'] = array(
393 |     '#type' => 'markup',
394 |     '#markup' => '<div id="ajax-output-spot"></div>',
395 |   );
396 | 
397 |   $form['text_trigger'] = array(
398 |     '#type' => 'textfield',
399 |     '#title' => t('Type here to trigger Ajax'),
400 |     '#ajax' => array(
401 |       'event' => 'keyup',
402 |       'wrapper' => 'ajax-output-spot',
403 |       'callback' => 'mymodule_ajax_text_callback',
404 |     ),
405 |   );
406 | 
407 |   $form['ajax_output_2'] = array(
408 |     '#type' => 'markup',
409 |     '#markup' => '<div id="other-ajax-spot"></div>',
410 |   );
411 | 
412 |   $form['button_trigger'] = array(
413 |     '#type' => 'button',
414 |     '#value' => t('Click here to trigger Ajax'),
415 |     '#ajax' => array(
416 |       'callback' => 'mymodule_ajax_button_callback',
417 |     ),
418 |   );
419 | 
420 |   return $form;
421 | }
422 | 
423 | /**
424 |  * Form submission handler for mymodule_personal_data_form().
425 |  *
426 |  * From "Basic Form Generation and Processing in Drupal 7", chapter 4.
427 |  */
428 | function mymodule_personal_data_form_submit(&$form, &$form_state) {
429 |   // The values submitted by the user are in $form_state['values'].
430 |   $name = $form_state['values']['first_name'];
431 |   // Values you stored in the form array are also available.
432 |   $info = $form_state['values']['information'];
433 | 
434 |   // Get another value, using a method where it could be nested.
435 |   $parents = $form['company']['#array_parents'];
436 |   $company = drupal_array_get_nested_value($form_state['values'], $parents);
437 | 
438 |   // Processing code would go here. As a proxy, display a message with the
439 |   // values. Note that since the values are unsanitized, insert them
440 |   // into t() with @variable. If inserting into the database, do not
441 |   // sanitize.
442 |   if ($company) {
443 |     drupal_set_message(t('Thank you @name from @company', array('@name' => $name, '@company' => $company)));
444 |   }
445 |   else {
446 |     drupal_set_message(t('Thank you @name', array('@name' => $name)));
447 |   }
448 | 
449 |   // Make sure the form is rebuilt properly for Ajax.
450 |   $form_state['rebuild'] = TRUE;
451 | }
452 | 
453 | /**
454 |  * Generates autocompletes for path mymodule/autocomplete.
455 |  *
456 |  * From "Adding Auto-Complete to Forms", chapter 4.
457 |  *
458 |  * @see mymodule_personal_data_form()
459 |  */
460 | function mymodule_autocomplete($string = '') {
461 |   $matches = array();
462 |   if ($string) {
463 |     // Sanitize $string and find appropriate matches -- about 10 or fewer.
464 |     // Put them into $matches as $key => $visible text.
465 |     $string = check_plain($string);
466 | 
467 |     // As a proxy, just add some text to the end of the submitted text.
468 |     $additions = array('add', 'choice', 'more', 'plus', 'something');
469 |     foreach ($additions as $word) {
470 |       $choice = $string . $word;
471 |       $matches[$choice] = $choice;
472 |     }
473 |   }
474 | 
475 |   drupal_json_output($matches);
476 | }
477 | 
478 | /**
479 |  * Processes the Ajax response for the text field.
480 |  *
481 |  * From "Wrapper-based Ajax Callback Functions", chapter 4.
482 |  *
483 |  * @see mymodule_personal_data_form()
484 |  */
485 | function mymodule_ajax_text_callback($form, &$form_state) {
486 |   // Read the text from the text field.
487 |   $text = $form_state['values']['text_trigger'];
488 |   if (!$text) {
489 |     $text = t('nothing');
490 |   }
491 | 
492 |   // Set a message.
493 |   drupal_set_message(t('You have triggered Ajax'));
494 | 
495 |   // Return a render array for markup to replace the wrapper <div> contents.
496 |   return array(
497 |     '#type' => 'markup',
498 |     // Text was not sanitized, so use @variable in t() to sanitize.
499 |     // Be sure to include the wrapper div!
500 |     '#markup' => '<div id="ajax-output-spot">' . t('You typed @text', array('@text' => $text)) . '</div>',
501 |   );
502 | }
503 | 
504 | /**
505 |  * Processes the Ajax response for the button.
506 |  *
507 |  * From "Command-based Ajax Callback Functions in Drupal 7", chapter 4.
508 |  *
509 |  * @see mymodule_personal_data_form()
510 |  */
511 | function mymodule_ajax_button_callback($form, &$form_state) {
512 |   $commands = array();
513 | 
514 |   // Replace HTML markup inside the div via a selector.
515 |   $text = t('The button has been clicked');
516 |   $commands[] = ajax_command_html('div#other-ajax-spot', $text);
517 | 
518 |   // Add some CSS to the div.
519 |   $css = array('background-color' => '#ddffdd', 'color' => '#000000');
520 |   $commands[] = ajax_command_css('div#other-ajax-spot', $css);
521 | 
522 |   return array('#type' => 'ajax', '#commands' => $commands);
523 | }
524 | 
525 | /**
526 |  * Form constructor for delete confirmation form.
527 |  *
528 |  * From "Creating Confirmation Forms", chapter 4.
529 |  *
530 |  * @see mymodule_confirm_delete_submit()
531 |  */
532 | function mymodule_confirm_delete($form, $form_state, $id) {
533 |   // Save the ID for the submission function.
534 |   $form['mycontent_id'] = array(
535 |     '#type' => 'value',
536 |     '#value' => $id,
537 |   );
538 | 
539 |   return confirm_form($form,
540 |     // You could load the item and display the title here, if it
541 |     // were a real content item.
542 |     t('Are you sure you want to delete content item %id?',
543 |       array('%id' => $id)),
544 |     // The URL path to return to if the user cancels.
545 |     'mymodule/mypath');
546 | }
547 | 
548 | /**
549 |  * Form submission handler for mymodule_confirm_delete().
550 |  *
551 |  * From "Creating Confirmation Forms", chapter 4.
552 |  */
553 | function mymodule_confirm_delete_submit($form, $form_state) {
554 |   // Read the ID saved in the form.
555 |   $id = $form_state['values']['mycontent_id'];
556 |   // Sanitize.
557 |   $id = (int) $id;
558 | 
559 |   // Perform the data deletion, if it were real. As a proxy, just put up
560 |   // a message.
561 |   drupal_set_message(t('Would have deleted !id', array('!id' => $id)));
562 | 
563 |   // Redirect somewhere.
564 |   drupal_goto('mymodule/my_form_page');
565 | }
566 | 
567 | /**
568 |  * Implements hook_form_FORM_ID_alter() for user_register_form().
569 |  *
570 |  * From "Altering forms", chapter 4.
571 |  *
572 |  * @see mymodule_validate_register_email()
573 |  */
574 | function mymodule_form_user_register_form_alter(&$form, &$form_state, $form_id) {
575 |   // Change the label on the email address field.
576 |   $form['account']['mail']['#title'] = t('Company e-mail address');
577 | 
578 |   // Add a validation function.
579 |   $form['#validate'][] = 'mymodule_validate_register_email';
580 | }
581 | 
582 | /**
583 |  * Validation for mymodule_form_user_register_form_alter().
584 |  *
585 |  * From "Altering forms", chapter 4.
586 |  */
587 | function mymodule_validate_register_email($form, $form_state) {
588 |   $email = $form_state['values']['mail'];
589 | 
590 |   // Check that the email is within the company domain.
591 |   $parts = explode('@', $email);
592 |   $company = 'poplarware.com';
593 |   if (count($parts) != 2 || $parts[1] != $company) {
594 |     form_set_error('mail', t('You are not allowed to register'));
595 |   }
596 | }
597 | 
598 | /**
599 |  * Implements hook_entity_info().
600 |  *
601 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
602 |  */
603 | function mymodule_entity_info() {
604 |   $return = array();
605 | 
606 |   $return['myentity'] = array(
607 | 
608 |     // Define basic information.
609 |     'label' => t('Settings for My Module'),
610 |     'plural label' => t('Settings for My Module'),
611 |     'fieldable' => TRUE,
612 | 
613 |     // Provide information about the database table.
614 |     'base table' => 'mymodule_myentity',
615 |     'entity keys' => array(
616 |       'id' => 'myentity_id',
617 |       'label' => 'title',
618 |     ),
619 | 
620 |     // Use classes from the Entity API module.
621 |     'entity class' => 'Entity',
622 |     'controller class' => 'EntityAPIController',
623 | 
624 |     // Have Entity API set up an administrative UI.
625 |     'admin ui' => array(
626 |        'path' => 'admin/myentity',
627 |     ),
628 |     'module' => 'mymodule',
629 |     'access callback' => 'mymodule_myentity_access',
630 | 
631 |     // Normally, this would be for content-type entities only.
632 |     // For illustration purposes, we'll go ahead and define it
633 |     // anyway -- it's the URL for the page where this entity is
634 |     // displayed.
635 |     'uri callback' => 'mymodule_myentity_uri',
636 |   );
637 | 
638 |   return $return;
639 | }
640 | 
641 | /**
642 |  * Returns the URL for the entity.
643 |  *
644 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
645 |  */
646 | function mymodule_myentity_uri($entity) {
647 |   return array(
648 |     'path' => 'myentity/' . $entity->myentity_id,
649 |   );
650 | }
651 | 
652 | /**
653 |  * Title callback: Returns the title for an entity display page.
654 |  *
655 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
656 |  */
657 | function mymodule_myentity_page_title($entity) {
658 |   return $entity->title;
659 | }
660 | 
661 | /**
662 |  * Access callback: Checks entity access.
663 |  *
664 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
665 |  *
666 |  * @param string $op
667 |  *   Operation to check: 'view', 'update', 'create', etc.
668 |  * @param object|null $entity
669 |  *   Object to check access on, or NULL to check for all entities.
670 |  * @param object|null $account
671 |  *   Account to check access permissions for. NULL means "current user".
672 |  *
673 |  * @return bool
674 |  *   TRUE to allow access; FALSE to deny access.
675 |  */
676 | function mymodule_myentity_access($op, $entity, $account = NULL) {
677 |   if ($op == 'view') {
678 |     return user_access('view myentity', $account);
679 |   }
680 | 
681 |   // All other operations use the generic "administer" permission.
682 |   return user_access('administer myentity', $account);
683 | }
684 | 
685 | /**
686 |  * Form constructor for the entity edit form.
687 |  *
688 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
689 |  *
690 |  * @see myentity_form_submit()
691 |  */
692 | function myentity_form($form, $form_state, $entity) {
693 |   // Include the properties of the entity: title, language.
694 |   $form['title'] = array(
695 |     '#title' => t('Title'),
696 |     '#type' => 'textfield',
697 |     '#default_value' => isset($entity->title) ? $entity->title : '',
698 |   );
699 | 
700 |   // Build language options list.
701 |   $default = language_default();
702 |   $options = array($default->language => $default->name);
703 |   if (module_exists('locale')) {
704 |     $options = array(LANGUAGE_NONE => t('All languages')) +
705 |       locale_language_list('name');
706 |   }
707 | 
708 |   // Add language selector or value to the form.
709 |   $langcode = isset($entity->language) ? $entity->language : '';
710 |   if (count($options) > 1) {
711 |     $form['language'] = array(
712 |       '#type' => 'select',
713 |       '#title' => t('Language'),
714 |       '#options' => $options,
715 |       '#default_value' => $langcode,
716 |     );
717 |   }
718 |   else {
719 |     $form['language'] = array(
720 |       '#type' => 'value',
721 |       '#value' => $langcode,
722 |     );
723 |   }
724 | 
725 |   $form['actions'] = array('#type' => 'actions');
726 |   $form['actions']['submit'] = array(
727 |     '#type' => 'submit',
728 |     '#value' => t('Save'),
729 |     '#weight' => 999,
730 |   );
731 | 
732 |   // Let Field module handle the rest.
733 |   field_attach_form('myentity', $entity, $form, $form_state, $langcode);
734 | 
735 |   return $form;
736 | }
737 | 
738 | /**
739 |  * Form submit handler for myentity_form().
740 |  *
741 |  * From "Defining an Entity Type in Drupal 7", chapter 4.
742 |  */
743 | function myentity_form_submit($form, &$form_state) {
744 |   // Make use of Entity API class.
745 |   $entity = entity_ui_form_submit_build_entity($form, $form_state);
746 |   $entity->save();
747 | 
748 |   // Redirect to the management page.
749 |   $form_state['redirect'] = 'admin/myentity';
750 | }
751 | 
752 | /**
753 |  * Implements hook_field_widget_info().
754 |  *
755 |  * From "Defining a field widget in Drupal 7", chapter 4.
756 |  *
757 |  * @see mymodule_field_widget_form()
758 |  */
759 | function mymodule_field_widget_info() {
760 |   return array(
761 |     // Machine name of the widget.
762 |     'mymodule_mywidget' => array(
763 | 
764 |       // Label for the administrative UI.
765 |       'label' => t('Custom text input'),
766 | 
767 |       // Field types it supports.
768 |       'field types' => array('text'),
769 |     ),
770 | 
771 |     // Define additional widgets here, if desired.
772 |   );
773 | }
774 | 
775 | /**
776 |  * Implements hook_field_widget_form().
777 |  *
778 |  * From "Defining a field widget in Drupal 7", chapter 4.
779 |  *
780 |  * @see mymodule_field_widget_info()
781 |  */
782 | function mymodule_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
783 | 
784 |   // Verify the widget type. Only needed if you define more than one
785 |   // widget.
786 |   if ($instance['widget']['type'] == 'mymodule_mywidget') {
787 |     // Find the current text field value.
788 |     $value = isset($items[$delta]['value']) ? $items[$delta]['value'] : NULL;
789 | 
790 |     // Set up the editing form element. Substitute your custom
791 |     // code here, instead of using an HTML select.
792 |     $element['value'] = array(
793 |       '#type' => 'select',
794 |       '#options' => array('x_stored' => t('x label'), 'y_stored' => t('y label')),
795 |       '#default_value' => $value,
796 |     );
797 |   }
798 | 
799 |   return $element;
800 | }
801 | 
802 | /**
803 |  * Implements hook_field_formatter_info().
804 |  *
805 |  * From "Defining a field formatter in Drupal 7", chapter 4.
806 |  *
807 |  * @see mymodule_field_formatter_view()
808 |  */
809 | function mymodule_field_formatter_info() {
810 |   return array(
811 | 
812 |     // Machine name of the formatter.
813 |     'mymodule_myformatter' => array(
814 | 
815 |       // Label for the administrative UI.
816 |       'label' => t('Custom text output'),
817 | 
818 |       // Field types it supports.
819 |       'field types' => array('text'),
820 |     ),
821 | 
822 |     // Define additional formatters here.
823 |   );
824 | }
825 | 
826 | /**
827 |  * Implements hook_field_formatter_info().
828 |  *
829 |  * From "Defining a field formatter in Drupal 7", chapter 4.
830 |  *
831 |  * @see mymodule_field_formatter_info()
832 |  */
833 | function mymodule_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
834 | 
835 |   $output = array();
836 | 
837 |   // Verify the formatter type.
838 |   if ($display['type'] == 'mymodule_myformatter') {
839 | 
840 |     // Handle multi-valued fields.
841 |     foreach ($items as $delta => $item) {
842 | 
843 |       // See which option was selected.
844 |       switch ($item['value']) {
845 |         case 'x_stored':
846 |           // Output the corresponding text or icon.
847 |           $output[$delta] = array('#markup' => '<p>' . t('Predefined output text x') . '</p>');
848 |           break;
849 | 
850 |         case 'y_stored':
851 |           // Output the corresponding text or icon.
852 |           $output[$delta] = array('#markup' => '<p>' . t('Predefined output text y') . '</p>');
853 |           break;
854 | 
855 |         // Handle other options here.
856 |       }
857 |     }
858 |   }
859 | 
860 |   return $output;
861 | }
862 | 
863 | /**
864 |  * Implements hook_ctools_plugin_directory().
865 |  *
866 |  * From "Notifying CTools About Plugin Implementations" in chapter 4.
867 |  */
868 | function mymodule_ctools_plugin_directory($module, $plugin) {
869 |   // Define a directory structure for plugins, so for instance a
870 |   // 'relationships' plugin (type defined by the 'ctools' module) would
871 |   // go into directory plugins/ctools-relationships.
872 |   return 'plugins/' . $module . '-' . $plugin;
873 | }
874 | 
875 | /**
876 |  * Implements hook_ctools_plugin_api().
877 |  *
878 |  * From "Providing Default CTools Exportables", chapter 4.
879 |  */
880 | function mymodule_ctools_plugin_api() {
881 |   return array(
882 |     // The API version.
883 |     'api' => 1,
884 |   );
885 | }
886 | 
887 | /**
888 |  * Implements hook_default_panels_mini().
889 |  *
890 |  * From "Providing Default CTools Exportables", chapter 4.
891 |  */
892 | function mymodule_default_panels_mini() {
893 |   $minis = array();
894 | 
895 |   // Paste exported Mini Panel code here.
896 |   // --- Start of export ---
897 |   $mini = new stdClass();
898 |   $mini->disabled = FALSE; /* Edit this to true to make a default mini disabled initially */
899 |   $mini->api_version = 1;
900 |   $mini->name = 'mymodule_test';
901 |   $mini->category = '';
902 |   $mini->admin_title = 'My Module Test';
903 |   $mini->admin_description = '';
904 |   $mini->requiredcontexts = array();
905 |   $mini->contexts = array(
906 |     0 => array(
907 |       'identifier' => 'User',
908 |       'keyword' => 'user',
909 |       'name' => 'user',
910 |       'type' => 'current',
911 |       'uid' => '',
912 |       'id' => 1,
913 |     ),
914 |   );
915 |   $mini->relationships = array(
916 |     0 => array(
917 |       'identifier' => 'Most recent node',
918 |       'keyword' => 'node',
919 |       'name' => 'mymodule_relationship_most_recent_content',
920 |       'context' => 'context_user_1',
921 |       'id' => 1,
922 |     ),
923 |   );
924 |   $display = new panels_display();
925 |   $display->layout = 'onecol';
926 |   $display->layout_settings = array();
927 |   $display->panel_settings = array(
928 |     'style_settings' => array(
929 |       'default' => NULL,
930 |       'middle' => NULL,
931 |     ),
932 |   );
933 |   $display->cache = array();
934 |   $display->title = 'Most Recently Wrote';
935 |   $display->uuid = '521e9c79-65b2-484f-ba30-b398be1f3987';
936 |   $display->content = array();
937 |   $display->panels = array();
938 |   $pane = new stdClass();
939 |   $pane->pid = 'new-c6ad4d39-3c42-4689-a5ff-4f75594a06df';
940 |   $pane->panel = 'middle';
941 |   $pane->type = 'node_title';
942 |   $pane->subtype = 'node_title';
943 |   $pane->shown = TRUE;
944 |   $pane->access = array();
945 |   $pane->configuration = array(
946 |     'link' => 1,
947 |     'markup' => 'none',
948 |     'id' => '',
949 |     'class' => '',
950 |     'context' => 'relationship_mymodule_relationship_most_recent_content_1',
951 |     'override_title' => 0,
952 |     'override_title_text' => '',
953 |   );
954 |   $pane->cache = array();
955 |   $pane->style = array(
956 |     'settings' => NULL,
957 |   );
958 |   $pane->css = array();
959 |   $pane->extras = array();
960 |   $pane->position = 0;
961 |   $pane->locks = array();
962 |   $pane->uuid = 'c6ad4d39-3c42-4689-a5ff-4f75594a06df';
963 |   $display->content['new-c6ad4d39-3c42-4689-a5ff-4f75594a06df'] = $pane;
964 |   $display->panels['middle'][0] = 'new-c6ad4d39-3c42-4689-a5ff-4f75594a06df';
965 |   $display->hide_title = PANELS_TITLE_FIXED;
966 |   $display->title_pane = '0';
967 |   $mini->display = $display;
968 |   // --- End of export ---
969 | 
970 |   // After the export is pasted, you'll have $mini holding one exported
971 |   // mini panel. Put it into the return array.
972 |   $minis['mymodule_test'] = $mini;
973 | 
974 |   // Add additional mini panels here.
975 | 
976 |   // Return them all.
977 |   return $minis;
978 | }
979 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.rules.inc:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Rules actions.
 6 |  *
 7 |  * From "Providing Custom Actions to Rules", chapter 4.
 8 |  */
 9 | 
10 | /**
11 |  * Implements hook_rules_action_info().
12 |  *
13 |  * @see mymodule_rules_action_user_list()
14 |  */
15 | function mymodule_rules_action_info() {
16 |   $actions = array();
17 | 
18 |   // Define one action.
19 | 
20 |   // The array key is the machine name of the action, and also the
21 |   // name of the function that does the action.
22 |   $actions['mymodule_rules_action_user_list'] = array(
23 | 
24 |     // Label and group in the user interface.
25 |     'label' => t('Load a list of users related to content'),
26 |     'group' => t('My Module custom'),
27 | 
28 |     // Describe the parameters.
29 |     'parameter' => array(
30 | 
31 |       'item' => array(
32 |         'label' => t('Content item to use'),
33 |         'type' => 'node',
34 |       ),
35 | 
36 |       // You can add additional parameters here.
37 | 
38 |     ),
39 | 
40 |     // Describe the output.
41 |     'provides' => array(
42 |       'user_list' => array(
43 |         'type' => 'list<user>',
44 |         'label' => t('List of users related to content'),
45 |       ),
46 | 
47 |       // You could describe additional output here.
48 |     ),
49 |   );
50 | 
51 |   // Define other actions here.
52 | 
53 |   return $actions;
54 | }
55 | 
56 | /**
57 |  * Performs the 'mymodule_rules_action_user_list' action.
58 |  *
59 |  * @see mymodule_rules_action_info()
60 |  */
61 | function mymodule_rules_action_user_list($item) {
62 |   // Because the parameter defined for this action is a node,
63 |   // $item is a node. Do a query here to find a list of
64 |   // users related to this node.
65 | 
66 |   // As a proxy for your real code, return a list of one
67 |   // user -- the author of the content.
68 |   $ids = array($item->uid);
69 | 
70 |   // Load the users and return them to Rules.
71 |   return array('user_list' => user_load_multiple($ids));
72 | }
73 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/mymodule.rules_defaults.inc:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Default reaction rules and components.
 6 |  *
 7 |  * From "Providing Default Reaction Rules and Components", chapter 4.
 8 |  */
 9 | 
10 | /**
11 |  * Implements hook_default_rules_configuration().
12 |  */
13 | function mymodule_default_rules_configuration() {
14 |   $configs = array();
15 | 
16 |   // Read in one exported reaction rule.
17 |   $file = drupal_get_path('module', 'mymodule') . '/rules/sample_rule.txt';
18 |   $contents = file_get_contents($file);
19 |   $configs['mymodule_sample_rule'] = rules_import($contents);
20 | 
21 |   // Add other reaction rules and components here if desired.
22 | 
23 |   return $configs;
24 | }
25 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/plugins/ctools-relationships/mymodule_relationship_most_recent_content.inc:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * CTools relationship plugin for most recently authored content.
 6 |  *
 7 |  * From "Implementing CTools Plugins in Drupal 7", chapter 4.
 8 |  */
 9 | 
10 | // Plugin definition array.
11 | $plugin = array(
12 |   'title' => t('My Module context relationship plugin'),
13 |   'description' => t('Locates the most recent content item authored by a user'),
14 |   'required context' => new ctools_context_required(t('User'), 'user'),
15 |   'context' => 'mymodule_relationship_most_recent_content',
16 |   'keyword' => 'node',
17 | );
18 | 
19 | /**
20 |  * Provides a relationship from a user to the most recently authored content.
21 |  */
22 | function mymodule_relationship_most_recent_content($context = NULL, $config) {
23 |   // Read the user ID from the context. If you have multiple context inputs,
24 |   // $context will be an array of contexts. But there is only one here.
25 |   if (empty($context) || empty($context->data) || empty($context->data->uid)) {
26 |     // If there is a problem, return an empty CTools context. This is also
27 |     // used by CTools to determine the output data type of this plugin.
28 |     return ctools_context_create_empty('node', NULL);
29 |   }
30 |   $uid = $context->data->uid;
31 | 
32 |   // Locate the most recent content node created by this user.
33 |   $nid = db_select('node', 'n')
34 |     ->fields('n', array('nid'))
35 |     ->condition('uid', $uid)
36 |     ->orderBy('created', 'DESC')
37 |     ->range(0,1)
38 |     ->execute()
39 |     ->fetchField();
40 | 
41 |   // Load the node item if possible.
42 |   if (!$nid) {
43 |     return ctools_context_create_empty('node', NULL);
44 |   }
45 |   $node = node_load($nid);
46 |   if (!$node) {
47 |     return ctools_context_create_empty('node', NULL);
48 |   }
49 | 
50 |   // Return the found node in a CTools context.
51 |   return ctools_context_create('node', $node);
52 | }
53 | 
54 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/rules/sample_rule.txt:
--------------------------------------------------------------------------------
 1 | { "rules_mymodule_test" : {
 2 |     "LABEL" : "My Module Test",
 3 |     "PLUGIN" : "reaction rule",
 4 |     "OWNER" : "rules",
 5 |     "REQUIRES" : [ "mymodule", "rules" ],
 6 |     "ON" : { "node_view" : [] },
 7 |     "DO" : [
 8 |       { "mymodule_rules_action_user_list" : {
 9 |           "USING" : { "item" : [ "node" ] },
10 |           "PROVIDE" : { "user_list" : { "user_list" : "List of users related to content" } }
11 |         }
12 |       },
13 |       { "LOOP" : {
14 |           "USING" : { "list" : [ "user-list" ] },
15 |           "ITEM" : { "user" : "A user" },
16 |           "DO" : [
17 |             { "drupal_message" : { "message" : "[user:name] is related to this content." } }
18 |           ]
19 |         }
20 |       }
21 |     ]
22 |   }
23 | }
24 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mymodule/tests/mymodule.test:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Tests for the sample module and book code for Drupal 7.
  6 |  */
  7 | 
  8 | /**
  9 |  * Base class for all book code tests, with helper methods.
 10 |  */
 11 | class ProgrammersGuideTestBase extends DrupalWebTestCase {
 12 | 
 13 |   /**
 14 |    * Verbose output of a PHP variable with optional label.
 15 |    */
 16 |   public function outputVariable($var, $label = '') {
 17 |     $this->verbose(
 18 |       (($label) ? '<h2>' . $label . '</h2>' : '') .
 19 |       '<pre>' . print_r($var, TRUE), '</pre>');
 20 |   }
 21 | 
 22 |   /**
 23 |    * Verbose output of HTML code with optional label.
 24 |    */
 25 |   public function outputHTML($var, $label = '') {
 26 |     $this->verbose(
 27 |       (($label) ? '<h2>' . $label . '</h2>' : '') .
 28 |       htmlentities($var));
 29 |   }
 30 | 
 31 |   /**
 32 |    * Assert that the page title contains a string.
 33 |    *
 34 |    * Function borrowed from https://drupal.org/project/api.
 35 |    */
 36 |   protected function assertTitleContains($string, $message) {
 37 |     $title = current($this->xpath('//title'));
 38 |     $this->assertTrue(strpos($title, $string) !== FALSE, $message);
 39 |   }
 40 | 
 41 |   /**
 42 |    * Places an existing block in a region of a  theme.
 43 |    *
 44 |    * You need to have the block module enabled, and be logged in as a user
 45 |    * who has 'administer blocks' permission.
 46 |    *
 47 |    * @param string $title
 48 |    *   Title to give the block.
 49 |    * @param string $path
 50 |    *   Module/delta for the block, such as 'system/powered-by'.
 51 |    * @param string $theme
 52 |    *   Machine name of theme to use.
 53 |    * @param string $region
 54 |    *   Region to put the block in.
 55 |    */
 56 |   public function placeBlock($title, $path, $theme, $region) {
 57 |     $this->drupalPost('admin/structure/block/manage/' . $path . '/configure',
 58 |       array(
 59 |         'regions[' . $theme . ']' => $region,
 60 |         'title' => $title,
 61 |       ),
 62 |       t('Save block'));
 63 |   }
 64 | }
 65 | 
 66 | /**
 67 |  * Tests various code snippets from the book.
 68 |  */
 69 | class MyModuleSnippetsTest extends ProgrammersGuideTestBase {
 70 |   public static function getInfo() {
 71 |     return array(
 72 |       'name' => 'Book snippets',
 73 |       'description' => 'Tests various code snippets from the book.',
 74 |       'group' => 'Programmers Guide to Drupal',
 75 |     );
 76 |   }
 77 | 
 78 |   function setUp() {
 79 |     // Enable the book's module.
 80 |     parent::setUp('mymodule');
 81 |   }
 82 | 
 83 |   /**
 84 |    * Tests various code snippets.
 85 |    */
 86 |   function testSnippets() {
 87 |     // Theme snippets from section "Making Your Output Themeable" in Chapter 2.
 88 | 
 89 |     $build['hello'] = array(
 90 |       '#input1' => t('Hello World!'),
 91 |       '#theme' => 'mymodule_hookname',
 92 |     );
 93 |     $output = drupal_render($build);
 94 |     $expected = '<div>Hello World!</div>';
 95 |     $this->outputHTML($output, 'Theme template output');
 96 |     $this->assertEqual(trim($output), $expected, 'Theme template worked in render array');
 97 | 
 98 |     $data = array('input1' => t('Hello World!'));
 99 |     $output = theme('mymodule_hookname_2', $data);
100 |     $this->outputHTML($output, 'Theme function output');
101 |     $this->assertEqual(trim($output), $expected, 'Theme function worked in direct theme() call');
102 | 
103 |     // Snippets from "Internationalizing User Interface Text" section in
104 |     // chapter 2. Good code only; bad code examples are omitted.
105 | 
106 |     $button_text = t('Save');
107 |     $this->assertEqual($button_text, 'Save', 't() worked OK on simple string');
108 | 
109 |     $user_name = 'foo';
110 |     $message_string = t('Hello @user_name', array('@user_name' => $user_name));
111 |     $this->outputHTML($message_string, 't() with variables output');
112 |     $this->assertEqual($message_string, 'Hello foo', 't() worked OK on string with variable');
113 | 
114 |     // Database snippets from "Querying the Database with the Database API"
115 |     // section in Chapter 2.
116 | 
117 |     // Make a user for querying purposes.
118 |     $account = $this->drupalCreateUser();
119 | 
120 |     // Query by status 1 (active).
121 |     $desired_status = 1;
122 |     $found = FALSE;
123 |     $result = db_query('SELECT * FROM {users} u WHERE u.status = :status',
124 |       array(':status' => $desired_status));
125 |     foreach ($result as $record) {
126 |       $this->outputVariable($record, 'User database record');
127 |       if ($record->uid == $account->uid) {
128 |         $found = TRUE;
129 |       }
130 |     }
131 |     $this->assertTrue($found, 'Created user was found by status query');
132 | 
133 |     // Create a node, for query purposes.
134 |     $newnode = $this->drupalCreateNode();
135 |     // Log in as user who can access content.
136 |     $account = $this->drupalCreateUser(array('access content'));
137 |     $this->drupalLogin($account);
138 | 
139 |     $result = db_select('node', 'n')
140 |       ->addTag('node_access') // Enforce node access permissions.
141 |       ->fields('n', array('title', 'nid', 'created')) // Fields to return.
142 |       ->condition('n.status', 1) // WHERE condition.
143 |       ->execute();
144 |     $found = FALSE;
145 |     foreach ($result as $node) {
146 |       $title = $node->title;
147 |       if ($node->nid == $newnode->nid) {
148 |         $found = TRUE;
149 |         $this->verbose("Found node with title $title");
150 |       }
151 |     }
152 |     $this->assertTrue($found, "Found node in dynamic query");
153 | 
154 |     $query = db_select('node', 'n');
155 |     $query->addField('n', 'changed', 'last_updated');
156 |     $query->innerJoin('users', 'u', 'u.uid = n.uid');
157 |     $query = $query->extend('PagerDefault');
158 |     $result = $query
159 |       ->fields('n', array('title', 'nid'))
160 |       ->fields('u', array('name'))
161 |       ->addTag('node_access')
162 |       ->condition('n.status', 1)
163 |       ->limit(20)
164 |       ->execute();
165 | 
166 |     $found = FALSE;
167 |     foreach ($result as $node) {
168 |       $title = $node->title;
169 |       if ($node->nid == $newnode->nid) {
170 |         $found = TRUE;
171 |       }
172 |     }
173 |     $this->assertTrue($found, "Found node in pager query");
174 | 
175 |     // Snippets from the "Cleansing and Checking User-Provided Input"
176 |     // section in Chapter 2. Only "good" code is included.
177 | 
178 |     $text = '<h2>Text with HTML</h2>';
179 |     $plain_text = htmlentities($text);
180 |     $url = 'http://example.com';
181 | 
182 |     $output = check_plain($text);
183 |     $this->outputHTML($output, 'check_plain output');
184 |     $this->assertEqual($output, $plain_text, 'check_plain output is as expected');
185 | 
186 |     $output = l($text, $url);
187 |     $this->outputHTML($output, 'l() output');
188 |     $this->assertEqual($output, '<a href="' . $url . '">' . $plain_text . '</a>', 'l output is as expected');
189 | 
190 | 
191 |   }
192 | }
193 | 
194 | /**
195 |  * Tests install hooks.
196 |  *
197 |  * @see mymodule_enable()
198 |  */
199 | class MyModuleEnableTest extends ProgrammersGuideTestBase {
200 |   public static function getInfo() {
201 |     return array(
202 |       'name' => 'Install hooks',
203 |       'description' => 'Tests the install hooks and other basic hooks',
204 |       'group' => 'Programmers Guide to Drupal',
205 |     );
206 |   }
207 | 
208 |   function setUp() {
209 |     // Enable the book's module and Taxonomy.
210 |     parent::setUp('mymodule', 'taxonomy');
211 |   }
212 | 
213 |   /**
214 |    * Tests the enable hook.
215 |    *
216 |    * @see mymodule_enable()
217 |    */
218 |   function testEnableHook() {
219 |     // The function mymodule_enable() sets up a taxonomy vocabulary when the
220 |     // module is enabled.
221 |     cache_clear_all();
222 | 
223 |     $vid = variable_get('mymodule_vocabulary', 0);
224 |     $this->assertFalse($vid == 0, 'Vocabulary ID was saved during module enable');
225 |     $vocabulary = taxonomy_vocabulary_load($vid);
226 |     $this->outputVariable($vocabulary, 'Loaded vocabulary object');
227 |     $this->assertEqual($vocabulary->name, 'Some appropriate name', 'Vocabulary with correct name was loaded');
228 | 
229 |     // Log in as a user who can access the Taxonomy page and check if it
230 |     // is there.
231 |     $account = $this->drupalCreateUser(array('administer taxonomy'));
232 |     $this->drupalLogin($account);
233 |     $this->drupalGet('admin/structure/taxonomy');
234 |     $this->assertText('Some appropriate name', 'Vocabulary name appears on the taxonomy page');
235 |   }
236 | 
237 |   /**
238 |    * Tests the schema hook.
239 |    *
240 |    * @see mymodule_schema()
241 |    */
242 |   function testSchemaHook() {
243 |     // Add some data to the table, and then retrieve it, to verify that
244 |     // the table was created.
245 |     db_insert('mymodule_foo')
246 |       ->fields(array('bar' => 'Hello', 'baz' => 2))
247 |       ->execute();
248 |     $result = db_query('SELECT * from {mymodule_foo}');
249 |     $count = 0;
250 |     foreach ($result as $record) {
251 |       $count++;
252 |       $this->outputVariable($record, 'Database record');
253 |       $this->assertEqual($record->bar, 'Hello', 'Field bar is correct');
254 |       $this->assertEqual($record->baz, 2, 'Field baz is correct');
255 |     }
256 |     $this->assertEqual($count, 1, 'Count of records is correct');
257 |   }
258 | 
259 |   /**
260 |    * Tests the permission hook.
261 |    *
262 |    * @see mymodule_permission()
263 |    */
264 |   function testPermission() {
265 |     // Just test to see that the permission was created properly.
266 |     $account_yes = $this->drupalCreateUser(array('administer mymodule'));
267 |     $this->drupalLogin($account_yes);
268 |     $this->assertTrue(user_access('administer mymodule'), 'User has permission');
269 |   }
270 | }
271 | 
272 | /**
273 |  * Tests page generation.
274 |  *
275 |  * @see mymodule_menu()
276 |  */
277 | class MyModulePagesTest extends ProgrammersGuideTestBase {
278 |   /**
279 |    * Array of generated nodes.
280 |    *
281 |    * @var array
282 |    */
283 |   protected $nodes = array();
284 | 
285 |   public static function getInfo() {
286 |     return array(
287 |       'name' => 'Pages',
288 |       'description' => 'Tests the pages generated by the module.',
289 |       'group' => 'Programmers Guide to Drupal',
290 |     );
291 |   }
292 | 
293 |   function setUp() {
294 |     // Enable the book's module and Block, Node.
295 |     parent::setUp('mymodule', 'block', 'node');
296 | 
297 |     // Generate 15 random nodes. Ensure the created times are in order.
298 |     for ($i = 0; $i < 15; $i++ ) {
299 |       $start = REQUEST_TIME - 30;;
300 |       $this->nodes[] = $this->drupalCreateNode(array(
301 |           'changed' => $start + $i,
302 |           'created' => $start + $i,
303 |         ));
304 |     }
305 |   }
306 | 
307 |   /**
308 |    * Tests the pages generated by the module.
309 |    */
310 |   function testPages() {
311 |     $page_title = 'My page title';
312 |     $block_title = 'Overridden block title';
313 |     $text_in_block = array(
314 |       'General information goes here',
315 |       'Colors',
316 |       'Blue',
317 |       'Materials',
318 |       'Characteristic',
319 |       'Steel',
320 |       'Light',
321 |     );
322 | 
323 |     // Several pages should not allow anonymous access. Test this.
324 |     $paths = array('mymodule/mypath', 'admin/content/mycontent/delete/5', 'mymodule/autocomplete');
325 |     foreach ($paths as $path) {
326 |       $this->drupalGet($path);
327 |       $this->assertResponse('403', "Access is denied to $path while not logged in");
328 |     }
329 | 
330 |     // Test the form while not logged in. It should be visible, but the
331 |     // company field should not be visible.
332 |     $this->drupalGet('mymodule/my_form_page');
333 |     $this->assertTitleContains('Personal data form', 'Form page title is correct');
334 |     $this->assertText('First name', 'Name field is shown');
335 |     $this->assertNoText('Company', 'Company field is not shown to anonymous user');
336 |     // Submit the form.
337 |     $this->drupalPost(NULL, array('first_name' => 'Jennifer'), t('Submit'));
338 |     $this->assertText('Thank you Jennifer', 'Submit message is shown');
339 | 
340 |     // Test alteration of the user register form.
341 |     $this->drupalGet('user/register');
342 |     $this->assertText('Company e-mail address', 'Email label has been altered');
343 |     $this->drupalPost(NULL, array('name' => 'foo', 'mail' => 'test@example.com'), t('Create new account'));
344 |     $this->assertText('You are not allowed to register', 'Validation message displayed');
345 |     $this->assertNoText('Thank you for applying', 'Registration message not displayed');
346 | 
347 |     // Now log in and check the pages.
348 |     $account = $this->drupalCreateUser(array('administer mymodule', 'administer blocks', 'use company field', 'delete mycontent items'));
349 |     $this->drupalLogin($account);
350 |     $this->drupalGet('mymodule/mypath');
351 |     $this->assertResponse('200', 'Access is allowed to page while logged in');
352 |     $this->assertTitleContains($page_title, 'Page title is correct');
353 |     for($i = 5; $i < 15; $i++) {
354 |       $this->assertText($this->nodes[$i]->title, "Node title $i appears on the page");
355 |     }
356 |     for($i = 0; $i < 5; $i++) {
357 |       $this->assertNoText($this->nodes[$i]->title, "Node title $i does not appear on the page");
358 |     }
359 | 
360 |     // Now go to the second page and test output.
361 |     $this->drupalGet('mymodule/mypath', array('query' => array('page' => 1)));
362 |     $this->assertTitleContains($page_title, 'Page title is correct');
363 |     for($i = 5; $i < 15; $i++) {
364 |       $this->assertNoText($this->nodes[$i]->title, "Node title $i does not appear on the page");
365 |     }
366 |     for($i = 0; $i < 5; $i++) {
367 |       $this->assertText($this->nodes[$i]->title, "Node title $i appears on the page");
368 |     }
369 | 
370 |     // Place the module's block.
371 |     $this->placeBlock($block_title, 'mymodule/first_block', 'bartik', 'content');
372 | 
373 |     // Visit the user account page and verify it is visible.
374 |     $this->drupalGet('user');
375 |     $this->assertText($block_title, 'Block title is visible');
376 |     foreach ($text_in_block as $text) {
377 |       $this->assertText($text, "Text $text appears on the page");
378 |     }
379 | 
380 |     // Test the form.
381 |     $this->drupalGet('mymodule/my_form_page');
382 |     $this->assertTitleContains('Personal data form', 'Form page title is correct');
383 |     $this->assertText('First name', 'Name field is shown');
384 |     $this->assertText('Company', 'Company field is shown to user with permission');
385 |     // Submit the form.
386 |     $this->drupalPost(NULL, array('first_name' => 'Jennifer', 'company' => 'Poplar'), t('Submit'));
387 |     $this->assertText('Thank you Jennifer from Poplar', 'Submit message is shown');
388 |     // Test that JavaScript information is included.
389 |     $this->assertRaw('mymodule.js', 'JavaScript file is referenced');
390 |     $this->assertRaw('alert', 'In-line JavaScript is included');
391 | 
392 |     // Test the confirm delete form.
393 |     $this->drupalGet('admin/content/mycontent/delete/5');
394 |     $this->assertText('Are you sure you want to delete content item 5?', 'Question is on the confirm form page');
395 |     // Try the cancel link. Should go to mymodule/mypath.
396 |     $this->clickLink(t('Cancel'));
397 |     $this->assertTitleContains($page_title, 'Cancel went to right place');
398 |     // Try submitting the form. Should go to mymodule/my_form_page.
399 |     $this->drupalPost('admin/content/mycontent/delete/5', array(), t('Confirm'));
400 |     $this->assertTitleContains('Personal data form', 'Form submit redirected to right place');
401 |     $this->assertText('Would have deleted 5', 'Submit message is displayed');
402 | 
403 |     // Test the autocomplete path.
404 |     $this->drupalGet('mymodule/autocomplete/test');
405 |     $additions = array('add', 'choice', 'more', 'plus', 'something');
406 |     foreach ($additions as $word) {
407 |       $this->assertText('test' . $word, "Autocomplete choice for $word is in the output");
408 |     }
409 |   }
410 | }
411 | 
412 | /**
413 |  * Tests the entity type, field widget, and field formatter.
414 |  */
415 | class MyModuleEntityTest extends ProgrammersGuideTestBase {
416 |   public static function getInfo() {
417 |     return array(
418 |       'name' => 'Entity, field widget, and field formatter',
419 |       'description' => 'Tests the defined entity type, the field widget, and the field formatter.',
420 |       'group' => 'Programmers Guide to Drupal',
421 |     );
422 |   }
423 | 
424 |   function setUp() {
425 |     // Enable the book's module and Entity API.
426 |     parent::setUp('mymodule', 'entity');
427 | 
428 |     // Add a text field to the entity type, using the module's formatter
429 |     // and widget.
430 | 
431 |     // Create a plain text field for a setting.
432 |     $field = field_create_field(array(
433 |         'field_name' => 'myentity_fieldtest',
434 |         'type' => 'text',
435 |         'entity_types' => array('myentity'),
436 |         'locked' => TRUE,
437 |         'translatable' => TRUE,
438 |       ));
439 | 
440 |     // Attach the field to the entity bundle.
441 |     $instance = field_create_instance(array(
442 |         'field_name' => 'myentity_fieldtest',
443 |         'entity_type' => 'myentity',
444 |         'bundle' => 'myentity',
445 |         'label' => t('Field test'),
446 |         'required' => FALSE,
447 |         'widget' => array(
448 |           'type' => 'mymodule_mywidget',
449 |         ),
450 |         'display' => array(
451 |           'default' => array(
452 |             'label' => 'above',
453 |             'type' => 'mymodule_myformatter',
454 |           ),
455 |         ),
456 |       ));
457 |   }
458 | 
459 |   /**
460 |    * Tests the entity type, widget, and formatter.
461 |    */
462 |   function testEntity() {
463 |     $account = $this->drupalCreateUser(array('administer myentity', 'view myentity'));
464 |     $this->drupalLogin($account);
465 | 
466 |     // Entity admin page.
467 |     $this->drupalGet('admin/myentity');
468 |     $this->assertTitleContains('Settings for My Module', 'Page title on admin page is correct');
469 | 
470 |     // Add a new entity.
471 |     $this->clickLink('Add settings for my module', 0);
472 |     $this->assertTitleContains('Add settings for my module', 'Page title on add form is correct');
473 |     $this->assertText(t('Setting 1'), 'Field label is present');
474 |     $this->assertText(t('Help for this setting'), 'Field help is present');
475 |     $this->assertText(t('Title'), 'Title label is present');
476 |     $this->assertRaw(t('x label'), 'X choice label is present');
477 |     $this->assertRaw(t('y label'), 'Y choice label is present');
478 |     $this->drupalPost(NULL, array(
479 |         'title' => 'Test settings',
480 |         'myentity_setting_1[und][0][value]' => 'Value for setting',
481 |         'myentity_fieldtest[und][0][value]' => 'x_stored',
482 |       ), t('Save'));
483 |     $this->assertTitleContains('Settings for My Module', 'Went back to admin page on save');
484 |     $this->assertLink('Test settings', 0, 'Title link is present');
485 | 
486 |     // Edit this entity.
487 |     $this->clickLink('edit');
488 |     $this->drupalPost(NULL, array(
489 |         'title' => 'New title',
490 |         'myentity_setting_1[und][0][value]' => 'New value for setting',
491 |         'myentity_fieldtest[und][0][value]' => 'y_stored',
492 |       ), t('Save'));
493 |     $this->assertLink('New title', 0, 'Title link was updated');
494 | 
495 |     // View the entity.
496 |     $this->clickLink('New title');
497 |     $this->assertTitleContains('New title', 'Page title is correct');
498 |     $this->assertText('New value for setting', 'Setting field is displayed');
499 |     $this->assertText('Predefined output text y', 'Custom field is displayed with custom display');
500 | 
501 |     // Delete the entity.
502 |     $this->drupalGet('admin/myentity');
503 |     $this->clickLink('delete');
504 |     $this->assertText('Are you sure', 'Question is present');
505 |     $this->assertText('New title', 'Title is present');
506 |     $this->drupalPost(NULL, array(), t('Confirm'));
507 |     $this->assertTitleContains('Settings for My Module', 'Delete went back to admin page');
508 |     // Refresh the page and verify it is not there.
509 |     $this->drupalGet('admin/myentity');
510 |     $this->assertNoText('New title', 'Entity is not shown');
511 | 
512 |     // Now add an entity back, log out, and verify access is denied.
513 |     $this->clickLink('Add settings for my module', 0);
514 |     $this->drupalPost(NULL, array(
515 |         'title' => 'Test settings',
516 |         'myentity_setting_1[und][0][value]' => 'Value for setting'), t('Save'));
517 |     $this->drupalLogout();
518 | 
519 |     $paths = array('admin/myentity', 'myentity/2', 'admin/myentity/manage/2', 'admin/myentity/add', 'admin/myentity/manage/2/delete');
520 |     foreach ($paths as $path) {
521 |       $this->drupalGet($path);
522 |       $this->assertResponse('403', "Access is denied to $path while not logged in");
523 |     }
524 |   }
525 | }
526 | 
527 | 
528 | /**
529 |  * Tests Rules integration.
530 |  */
531 | class MyModuleRulesTest extends ProgrammersGuideTestBase {
532 |   public static function getInfo() {
533 |     return array(
534 |       'name' => 'Rules',
535 |       'description' => 'Tests Rules module integration',
536 |       'group' => 'Programmers Guide to Drupal',
537 |     );
538 |   }
539 | 
540 |   function setUp() {
541 |     // Enable the book's module and Rules and its dependencies.
542 |     parent::setUp('mymodule', 'rules', 'entity', 'entity_token');
543 |   }
544 | 
545 |   /**
546 |    * Tests Rules integration.
547 |    */
548 |   function testRules() {
549 | 
550 |     // Create a user.
551 |     $account = $this->drupalCreateUser(array('access content'));
552 |     $this->drupalLogin($account);
553 | 
554 |     // Generate a node.
555 |     $node = $this->drupalCreateNode(array('uid' => $account->uid));
556 | 
557 |     // There is a saved rule that uses a custom action. It should display
558 |     // "[username] is related to this content." on the page, where [username]
559 |     // is the author of the node.
560 |     $this->drupalGet('node/' . $node->nid);
561 |     $this->assertText($account->name . ' is related to this content.', "Rules message is displayed");
562 |   }
563 | }
564 | 
565 | /**
566 |  * Tests Ctools/Panels integration.
567 |  */
568 | class MyModulePanelsTest extends ProgrammersGuideTestBase {
569 |   public static function getInfo() {
570 |     return array(
571 |       'name' => 'Panels and CTools',
572 |       'description' => 'Tests CTools and Panels integration',
573 |       'group' => 'Programmers Guide to Drupal',
574 |     );
575 |   }
576 | 
577 |   function setUp() {
578 |     // Enable the book's module and several Panels modules.
579 |     parent::setUp('mymodule', 'ctools', 'panels', 'panels_mini', 'page_manager');
580 |   }
581 | 
582 |   /**
583 |    * Tests Panels and CTools integration.
584 |    */
585 |   function testPanels() {
586 | 
587 |     // Create a user.
588 |     $account = $this->drupalCreateUser(array('access content', 'administer blocks'));
589 |     $this->drupalLogin($account);
590 | 
591 |     // Generate a node.
592 |     $node = $this->drupalCreateNode(array('uid' => $account->uid));
593 | 
594 |     // Place the exported mini-panel block in the content section.
595 |     $this->placeBlock('Recent content', 'panels_mini/mymodule_test', 'bartik', 'content');
596 | 
597 |     // Visit the user page and verify the block is working.
598 |     $this->drupalGet('user');
599 |     $this->assertText('Recent content', 'Block is visible');
600 |     $this->assertLink($node->title, 0, 'Link to authored node is visible');
601 |   }
602 | }
603 | 
604 | /**
605 |  * Tests the theme code.
606 |  */
607 | class MyThemeTest extends ProgrammersGuideTestBase {
608 | 
609 |   public static function getInfo() {
610 |     return array(
611 |       'name' => 'Test theme',
612 |       'description' => 'Tests the theme code from the book.',
613 |       'group' => 'Programmers Guide to Drupal',
614 |     );
615 |   }
616 | 
617 |   function setUp() {
618 |     parent::setUp('block');
619 | 
620 |     // Enable the book's theme.
621 |     theme_enable(array('mytheme'));
622 |     // Set it to be default, and re-initialize various things.
623 |     variable_set('theme_default', 'mytheme');
624 |     variable_initialize();
625 |     menu_rebuild();
626 |   }
627 | 
628 |   /**
629 |    * Tests the theme.
630 |    */
631 |   function testTheme() {
632 |     // Log in.
633 |     $account = $this->drupalCreateUser(array('administer blocks'));
634 |     $this->drupalLogin($account);
635 | 
636 |     // Verify that the new region is shown on the Blocks page.
637 |     $this->drupalGet('admin/structure/block');
638 |     $this->assertText('Readable region name');
639 | 
640 |     // Place a block in the new region of this theme.
641 |     $block_title = 'This is a test.';
642 |     $this->placeBlock($block_title, 'system/powered-by', 'mytheme', 'internal_region_name');
643 | 
644 |     // Visit the user profile page. Make sure block is shown.
645 |     $this->drupalGet('user');
646 |     $this->assertText($block_title, 'Block in custom region is shown');
647 |   }
648 | }
649 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mytheme/README.txt:
--------------------------------------------------------------------------------
 1 | This directory contains the Drupal 7 theme code from the book "Programmers Guide
 2 | to Drupal", by Jennifer Hodgdon, second edition, 2014.
 3 | 
 4 | License: See book for details of license and copyright.
 5 | 
 6 | Contents:
 7 | 
 8 | - mytheme.info: Info file for theme.
 9 | 
10 | - templates/page.tpl.php: Page template file.
11 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mytheme/mytheme.info:
--------------------------------------------------------------------------------
 1 | ; Drupal 7 sample theme .info file
 2 | 
 3 | ; Comments start with ;
 4 | 
 5 | ; The name of the theme.
 6 | name = My theme
 7 | 
 8 | ; Longer description for the Themes page.
 9 | description = Sample theme for Programmers Guide to Drupal -- a Bartik sub-theme
10 | 
11 | ; Which version of Drupal this is for.
12 | core = 7.x
13 | 
14 | ; This is a derivative, using Bartik as the base theme.
15 | base theme = bartik
16 | 
17 | ; Theme regions. Only the Drupal core base regions will be automatically
18 | ; present, so make sure to include all the regions from the base theme
19 | ; .info file as well.
20 | 
21 | ; Custom region from section "Defining theme regions for block placement" in
22 | ; Chapter 3.
23 | regions[internal_region_name] = Readable region name
24 | 
25 | ; Regions from themes/bartik/bartik/bartik.info file.
26 | regions[header] = Header
27 | regions[help] = Help
28 | regions[page_top] = Page top
29 | regions[page_bottom] = Page bottom
30 | regions[highlighted] = Highlighted
31 | 
32 | regions[featured] = Featured
33 | regions[content] = Content
34 | regions[sidebar_first] = Sidebar first
35 | regions[sidebar_second] = Sidebar second
36 | 
37 | regions[triptych_first] = Triptych first
38 | regions[triptych_middle] = Triptych middle
39 | regions[triptych_last] = Triptych last
40 | 
41 | regions[footer_firstcolumn] = Footer first column
42 | regions[footer_secondcolumn] = Footer second column
43 | regions[footer_thirdcolumn] = Footer third column
44 | regions[footer_fourthcolumn] = Footer fourth column
45 | regions[footer] = Footer
46 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal7/mytheme/templates/page.tpl.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Page template file.
  4 |  *
  5 |  * This file is copied from the Drupal core Bartik theme, with an additional
  6 |  * region added called 'internal_region_name', just after the messages.
  7 |  */
  8 | ?>
  9 | <div id="page-wrapper"><div id="page">
 10 | 
 11 |   <div id="header" class="<?php print $secondary_menu ? 'with-secondary-menu': 'without-secondary-menu'; ?>"><div class="section clearfix">
 12 | 
 13 |     <?php if ($logo): ?>
 14 |       <a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home" id="logo">
 15 |         <img src="<?php print $logo; ?>" alt="<?php print t('Home'); ?>" />
 16 |       </a>
 17 |     <?php endif; ?>
 18 | 
 19 |     <?php if ($site_name || $site_slogan): ?>
 20 |       <div id="name-and-slogan"<?php if ($hide_site_name && $hide_site_slogan) { print ' class="element-invisible"'; } ?>>
 21 | 
 22 |         <?php if ($site_name): ?>
 23 |           <?php if ($title): ?>
 24 |             <div id="site-name"<?php if ($hide_site_name) { print ' class="element-invisible"'; } ?>>
 25 |               <strong>
 26 |                 <a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home"><span><?php print $site_name; ?></span></a>
 27 |               </strong>
 28 |             </div>
 29 |           <?php else: /* Use h1 when the content title is empty */ ?>
 30 |             <h1 id="site-name"<?php if ($hide_site_name) { print ' class="element-invisible"'; } ?>>
 31 |               <a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home"><span><?php print $site_name; ?></span></a>
 32 |             </h1>
 33 |           <?php endif; ?>
 34 |         <?php endif; ?>
 35 | 
 36 |         <?php if ($site_slogan): ?>
 37 |           <div id="site-slogan"<?php if ($hide_site_slogan) { print ' class="element-invisible"'; } ?>>
 38 |             <?php print $site_slogan; ?>
 39 |           </div>
 40 |         <?php endif; ?>
 41 | 
 42 |       </div> <!-- /#name-and-slogan -->
 43 |     <?php endif; ?>
 44 | 
 45 |     <?php print render($page['header']); ?>
 46 | 
 47 |     <?php if ($main_menu): ?>
 48 |       <div id="main-menu" class="navigation">
 49 |         <?php print theme('links__system_main_menu', array(
 50 |           'links' => $main_menu,
 51 |           'attributes' => array(
 52 |             'id' => 'main-menu-links',
 53 |             'class' => array('links', 'clearfix'),
 54 |           ),
 55 |           'heading' => array(
 56 |             'text' => t('Main menu'),
 57 |             'level' => 'h2',
 58 |             'class' => array('element-invisible'),
 59 |           ),
 60 |         )); ?>
 61 |       </div> <!-- /#main-menu -->
 62 |     <?php endif; ?>
 63 | 
 64 |     <?php if ($secondary_menu): ?>
 65 |       <div id="secondary-menu" class="navigation">
 66 |         <?php print theme('links__system_secondary_menu', array(
 67 |           'links' => $secondary_menu,
 68 |           'attributes' => array(
 69 |             'id' => 'secondary-menu-links',
 70 |             'class' => array('links', 'inline', 'clearfix'),
 71 |           ),
 72 |           'heading' => array(
 73 |             'text' => t('Secondary menu'),
 74 |             'level' => 'h2',
 75 |             'class' => array('element-invisible'),
 76 |           ),
 77 |         )); ?>
 78 |       </div> <!-- /#secondary-menu -->
 79 |     <?php endif; ?>
 80 | 
 81 |   </div></div> <!-- /.section, /#header -->
 82 | 
 83 |   <?php if ($messages): ?>
 84 |     <div id="messages"><div class="section clearfix">
 85 |       <?php print $messages; ?>
 86 |     </div></div> <!-- /.section, /#messages -->
 87 |   <?php endif; ?>
 88 | 
 89 |   <?php
 90 |   /* Added region from section "Defining theme regions for block placement"
 91 |    * in Chapter 3.
 92 |    */
 93 |   ?>
 94 |   <?php if ($page['internal_region_name']): ?>
 95 |     <div id="internal-region-name">
 96 |       <?php print render($page['internal_region_name']); ?>
 97 |     </div>
 98 |   <?php endif; ?>
 99 | 
100 |   <?php if ($page['featured']): ?>
101 |     <div id="featured"><div class="section clearfix">
102 |       <?php print render($page['featured']); ?>
103 |     </div></div> <!-- /.section, /#featured -->
104 |   <?php endif; ?>
105 | 
106 |   <div id="main-wrapper" class="clearfix"><div id="main" class="clearfix">
107 | 
108 |     <?php if ($breadcrumb): ?>
109 |       <div id="breadcrumb"><?php print $breadcrumb; ?></div>
110 |     <?php endif; ?>
111 | 
112 |     <?php if ($page['sidebar_first']): ?>
113 |       <div id="sidebar-first" class="column sidebar"><div class="section">
114 |         <?php print render($page['sidebar_first']); ?>
115 |       </div></div> <!-- /.section, /#sidebar-first -->
116 |     <?php endif; ?>
117 | 
118 |     <div id="content" class="column"><div class="section">
119 |       <?php if ($page['highlighted']): ?><div id="highlighted"><?php print render($page['highlighted']); ?></div><?php endif; ?>
120 |       <a id="main-content"></a>
121 |       <?php print render($title_prefix); ?>
122 |       <?php if ($title): ?>
123 |         <h1 class="title" id="page-title">
124 |           <?php print $title; ?>
125 |         </h1>
126 |       <?php endif; ?>
127 |       <?php print render($title_suffix); ?>
128 |       <?php if ($tabs): ?>
129 |         <div class="tabs">
130 |           <?php print render($tabs); ?>
131 |         </div>
132 |       <?php endif; ?>
133 |       <?php print render($page['help']); ?>
134 |       <?php if ($action_links): ?>
135 |         <ul class="action-links">
136 |           <?php print render($action_links); ?>
137 |         </ul>
138 |       <?php endif; ?>
139 |       <?php print render($page['content']); ?>
140 |       <?php print $feed_icons; ?>
141 | 
142 |     </div></div> <!-- /.section, /#content -->
143 | 
144 |     <?php if ($page['sidebar_second']): ?>
145 |       <div id="sidebar-second" class="column sidebar"><div class="section">
146 |         <?php print render($page['sidebar_second']); ?>
147 |       </div></div> <!-- /.section, /#sidebar-second -->
148 |     <?php endif; ?>
149 | 
150 |   </div></div> <!-- /#main, /#main-wrapper -->
151 | 
152 |   <?php if ($page['triptych_first'] || $page['triptych_middle'] || $page['triptych_last']): ?>
153 |     <div id="triptych-wrapper"><div id="triptych" class="clearfix">
154 |       <?php print render($page['triptych_first']); ?>
155 |       <?php print render($page['triptych_middle']); ?>
156 |       <?php print render($page['triptych_last']); ?>
157 |     </div></div> <!-- /#triptych, /#triptych-wrapper -->
158 |   <?php endif; ?>
159 | 
160 |   <div id="footer-wrapper"><div class="section">
161 | 
162 |     <?php if ($page['footer_firstcolumn'] || $page['footer_secondcolumn'] || $page['footer_thirdcolumn'] || $page['footer_fourthcolumn']): ?>
163 |       <div id="footer-columns" class="clearfix">
164 |         <?php print render($page['footer_firstcolumn']); ?>
165 |         <?php print render($page['footer_secondcolumn']); ?>
166 |         <?php print render($page['footer_thirdcolumn']); ?>
167 |         <?php print render($page['footer_fourthcolumn']); ?>
168 |       </div> <!-- /#footer-columns -->
169 |     <?php endif; ?>
170 | 
171 |     <?php if ($page['footer']): ?>
172 |       <div id="footer" class="clearfix">
173 |         <?php print render($page['footer']); ?>
174 |       </div> <!-- /#footer -->
175 |     <?php endif; ?>
176 | 
177 |   </div></div> <!-- /.section, /#footer-wrapper -->
178 | 
179 | </div></div> <!-- /#page, /#page-wrapper -->
180 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/README.txt:
--------------------------------------------------------------------------------
  1 | This directory contains the Drupal module 8 code from the book "Programmers
  2 | Guide to Drupal", by Jennifer Hodgdon, second edition, 2015.
  3 | 
  4 | License: See book for details of license and copyright.
  5 | 
  6 | Contents:
  7 | 
  8 | - mymodule.module: Module file containing code from several sections.
  9 | - mymodule.info.yml: Info file for module.
 10 | - mymodule.install: Install hooks for module, from
 11 |   "Setting up Database Tables" section, chapter 2.
 12 | 
 13 | - mymodule.js: Empty JavaScript file for inclusion in a form array.
 14 | - mymodule.libraries.yml: Libraries file from "Render Arrays in Drupal 8",
 15 |   chapter 4.
 16 | 
 17 | - mymodule.routing.yml: Routing information for module from several sections.
 18 | - mymodule.links.action.yml: Administrative action links for module, from
 19 |   several sections.
 20 | - mymodule.links.menu.yml: Administrative menu links for module, from several
 21 |   sections.
 22 | - mymodule.links.task.yml: Administrative task links for module, from several
 23 |   sections.
 24 | - mymodule.services.yml: Services provided by module, from "Event
 25 |   Subscribers in Drupal 8: Altering Routes and Providing Dynamic Routes",
 26 |   chapter 4.
 27 | - mymodule.permissions.yml: Permissions for module, from several sections.
 28 | 
 29 | - config/install/mymodule.settings.yml: Config file from section
 30 |   "Config API in Drupal 8", chapter 2.
 31 | - config/schema/mymodule.schema.yml: Config schema from several sections.
 32 | - config/optional/views.view.myentity_content_list.yml: Views config file
 33 |   used in tests.
 34 | 
 35 | - src/Controller/MyUrlController.php: Route controller providing page output,
 36 |   from several sections.
 37 | 
 38 | - src/Entity/MyEntity.php: Entity class from "Defining a Content Entity Type in
 39 |   Drupal 8", chapter 4.
 40 | - src/Entity/MyEntityInterface.php: Entity interface from "Defining a Content
 41 |   Entity Type in Drupal 8", chapter 4.
 42 | - src/Entity/MyEntityForm.php: Entity editing form from "Defining a Content
 43 |   Entity Type in Drupal 8", chapter 4.
 44 | - src/Entity/MyEntityViewsData.php: Entity views data definition from "Defining
 45 |   a Content Entity Type in Drupal 8", chapter 4.
 46 | 
 47 | - src/Entity/MyEntityType.php: Entity class from "Defining a Configuration
 48 |   Entity Type in Drupal 8", chapter 4.
 49 | - src/Entity/MyEntityTypeInterface.php: Entity interface from "Defining a
 50 |   Configuration Entity Type in Drupal 8", chapter 4.
 51 | - src/Entity/MyEntityTypeForm.php: Entity subtype editing form from "Defining a
 52 |   Configuration Entity Type in Drupal 8", chapter 4.
 53 | - src/Entity/MyEntityTypeDeleteForm.php: Entity subtype delete confirm form
 54 |   from "Defining a Configuration Entity Type in Drupal 8", chapter 4.
 55 | - src/Entity/MyEntityTypeListBuilder.php: Entity subtype admin page builder from
 56 |   "Defining a Configuration Entity Type in Drupal 8", chapter 4.
 57 | 
 58 | - src/Form/ConfirmDeleteForm.php: Delete confirm form class from "Creating
 59 |   Confirmation Forms", chapter 4.
 60 | - src/Form/PersonalDataForm.php: Personal data form class, from several
 61 |   sections.
 62 | 
 63 | - src/Plugin/Block/MyModuleFirstBlock.php: Block plugin from "Registering a
 64 |   Block in Drupal 8", chapter 4.
 65 | 
 66 | - src/Plugin/Field/FieldWidget/MyCustomText.php: Field widget from
 67 |   "Defining a field widget in Drupal 8", chapter 4.
 68 | - src/Plugin/Field/FieldFormatter/MyCustomText.php: Field formatter from
 69 |   "Defining a field formatter in Drupal 8", chapter 4.
 70 | - src/Plugin/views/wizard/MyEntityViewsWizard.php: Entity views wizard from
 71 |   "Defining a Content Entity Type in Drupal 8", chapter 4.
 72 | 
 73 | - src/Routing/MyModuleRouting.php: Event subscriber class from "Event
 74 |   Subscribers in Drupal 8: Altering Routes and Providing Dynamic Routes",
 75 |   chapter 4.
 76 | 
 77 | - src/Tests/*.php: SimpleTest tests for most of the code.
 78 | 
 79 | - templates/mymodule.html.twig: Theme template file from section "Making Your
 80 |   Output Themeable", chapter 2.
 81 | - templates/myentity.html.twig: Theme template file from section "Defining a
 82 |   Content Entity Type in Drupal 8", chapter 4.
 83 | 
 84 | Note: There is some functionality in the sample code that involves
 85 | JavaScript, and therefore cannot be tested within the SimpleTest framework.
 86 | To test it manually, you'll need to put this module in your modules
 87 | directory, enable the "My Module" module, and do the following:
 88 | 
 89 | 1. On the Personal Data Form page at example.com/mymodule/my_form_page :
 90 |    a. The field labeled "Autocomplete field" should have auto-complete behavior.
 91 |       It is set up with a proxy that just adds some fixed text after
 92 |       whatever you type in, so you should see some choices. You will need
 93 |       to have 'Use company field' permission to see the auto-complete.
 94 |    b. If you type in the field labeled "Type here to trigger Ajax", you should
 95 |       see a message saying "You have triggered Ajax", and just below that, a
 96 |       line saying "You typed [whatever you typed]".
 97 |    c. If you click the button that says "Click here to trigger Ajax", you
 98 |       should see a message saying "The button has been clicked", with a
 99 |       light green background.
100 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/config/install/mymodule.settings.yml:
--------------------------------------------------------------------------------
1 | # Default configuration for My Module, from "Config API in Drupal 8", chapter 2.
2 | 
3 | submit_button_label: 'Submit'
4 | name_field_settings:
5 |   field_label: 'Your name'
6 |   field_size: 50
7 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/config/optional/views.view.myentity_content_list.yml:
--------------------------------------------------------------------------------
  1 | langcode: en
  2 | status: true
  3 | dependencies:
  4 |   module:
  5 |     - mymodule
  6 |     - user
  7 | id: myentity_content_list
  8 | label: 'My Entity Content'
  9 | module: views
 10 | description: ''
 11 | tag: ''
 12 | base_table: myentity_field_data
 13 | base_field: eid
 14 | core: 8.x
 15 | display:
 16 |   default:
 17 |     display_plugin: default
 18 |     id: default
 19 |     display_title: Master
 20 |     position: 0
 21 |     display_options:
 22 |       access:
 23 |         type: perm
 24 |         options:
 25 |           perm: 'administer my entities'
 26 |       cache:
 27 |         type: tag
 28 |         options: {  }
 29 |       query:
 30 |         type: views_query
 31 |         options:
 32 |           disable_sql_rewrite: false
 33 |           distinct: false
 34 |           replica: false
 35 |           query_comment: ''
 36 |           query_tags: {  }
 37 |       exposed_form:
 38 |         type: basic
 39 |         options:
 40 |           submit_button: Apply
 41 |           reset_button: false
 42 |           reset_button_label: Reset
 43 |           exposed_sorts_label: 'Sort by'
 44 |           expose_sort_order: true
 45 |           sort_asc_label: Asc
 46 |           sort_desc_label: Desc
 47 |       pager:
 48 |         type: full
 49 |         options:
 50 |           items_per_page: 50
 51 |           offset: 0
 52 |           id: 0
 53 |           total_pages: null
 54 |           expose:
 55 |             items_per_page: false
 56 |             items_per_page_label: 'Items per page'
 57 |             items_per_page_options: '5, 10, 25, 50'
 58 |             items_per_page_options_all: false
 59 |             items_per_page_options_all_label: '- All -'
 60 |             offset: false
 61 |             offset_label: Offset
 62 |           tags:
 63 |             previous: '‹ previous'
 64 |             next: 'next ›'
 65 |             first: '« first'
 66 |             last: 'last »'
 67 |           quantity: 9
 68 |       style:
 69 |         type: table
 70 |       row:
 71 |         type: fields
 72 |       fields:
 73 |         title:
 74 |           id: title
 75 |           table: myentity_field_data
 76 |           field: title
 77 |           relationship: none
 78 |           group_type: group
 79 |           admin_label: ''
 80 |           label: Title
 81 |           exclude: false
 82 |           alter:
 83 |             alter_text: false
 84 |             text: ''
 85 |             make_link: false
 86 |             path: ''
 87 |             absolute: false
 88 |             external: false
 89 |             replace_spaces: false
 90 |             path_case: none
 91 |             trim_whitespace: false
 92 |             alt: ''
 93 |             rel: ''
 94 |             link_class: ''
 95 |             prefix: ''
 96 |             suffix: ''
 97 |             target: ''
 98 |             nl2br: false
 99 |             max_length: 0
100 |             word_boundary: true
101 |             ellipsis: true
102 |             more_link: false
103 |             more_link_text: ''
104 |             more_link_path: ''
105 |             strip_tags: false
106 |             trim: false
107 |             preserve_tags: ''
108 |             html: false
109 |           element_type: ''
110 |           element_class: ''
111 |           element_label_type: ''
112 |           element_label_class: ''
113 |           element_label_colon: true
114 |           element_wrapper_type: ''
115 |           element_wrapper_class: ''
116 |           element_default_classes: true
117 |           empty: ''
118 |           hide_empty: false
119 |           empty_zero: false
120 |           hide_alter_empty: true
121 |           click_sort_column: value
122 |           type: string
123 |           settings:
124 |             link_to_entity: true
125 |           group_column: value
126 |           group_columns: {  }
127 |           group_rows: true
128 |           delta_limit: 0
129 |           delta_offset: 0
130 |           delta_reversed: false
131 |           delta_first_last: false
132 |           multi_type: separator
133 |           separator: ', '
134 |           field_api_classes: false
135 |           entity_type: null
136 |           entity_field: title
137 |           plugin_id: field
138 |         subtype:
139 |           id: subtype
140 |           table: myentity
141 |           field: subtype
142 |           relationship: none
143 |           group_type: group
144 |           admin_label: ''
145 |           label: Subtype
146 |           exclude: false
147 |           alter:
148 |             alter_text: false
149 |             text: ''
150 |             make_link: false
151 |             path: ''
152 |             absolute: false
153 |             external: false
154 |             replace_spaces: false
155 |             path_case: none
156 |             trim_whitespace: false
157 |             alt: ''
158 |             rel: ''
159 |             link_class: ''
160 |             prefix: ''
161 |             suffix: ''
162 |             target: ''
163 |             nl2br: false
164 |             max_length: 0
165 |             word_boundary: true
166 |             ellipsis: true
167 |             more_link: false
168 |             more_link_text: ''
169 |             more_link_path: ''
170 |             strip_tags: false
171 |             trim: false
172 |             preserve_tags: ''
173 |             html: false
174 |           element_type: ''
175 |           element_class: ''
176 |           element_label_type: ''
177 |           element_label_class: ''
178 |           element_label_colon: true
179 |           element_wrapper_type: ''
180 |           element_wrapper_class: ''
181 |           element_default_classes: true
182 |           empty: ''
183 |           hide_empty: false
184 |           empty_zero: false
185 |           hide_alter_empty: true
186 |           click_sort_column: target_id
187 |           type: entity_reference_label
188 |           settings:
189 |             link: false
190 |           group_column: target_id
191 |           group_columns: {  }
192 |           group_rows: true
193 |           delta_limit: 0
194 |           delta_offset: 0
195 |           delta_reversed: false
196 |           delta_first_last: false
197 |           multi_type: separator
198 |           separator: ', '
199 |           field_api_classes: false
200 |           entity_type: myentity
201 |           entity_field: subtype
202 |           plugin_id: field
203 |         operations:
204 |           id: operations
205 |           table: myentity
206 |           field: operations
207 |           relationship: none
208 |           group_type: group
209 |           admin_label: ''
210 |           label: Operations
211 |           exclude: false
212 |           alter:
213 |             alter_text: false
214 |             text: ''
215 |             make_link: false
216 |             path: ''
217 |             absolute: false
218 |             external: false
219 |             replace_spaces: false
220 |             path_case: none
221 |             trim_whitespace: false
222 |             alt: ''
223 |             rel: ''
224 |             link_class: ''
225 |             prefix: ''
226 |             suffix: ''
227 |             target: ''
228 |             nl2br: false
229 |             max_length: 0
230 |             word_boundary: true
231 |             ellipsis: true
232 |             more_link: false
233 |             more_link_text: ''
234 |             more_link_path: ''
235 |             strip_tags: false
236 |             trim: false
237 |             preserve_tags: ''
238 |             html: false
239 |           element_type: ''
240 |           element_class: ''
241 |           element_label_type: ''
242 |           element_label_class: ''
243 |           element_label_colon: true
244 |           element_wrapper_type: ''
245 |           element_wrapper_class: ''
246 |           element_default_classes: true
247 |           empty: ''
248 |           hide_empty: false
249 |           empty_zero: false
250 |           hide_alter_empty: true
251 |           destination: true
252 |           entity_type: myentity
253 |           plugin_id: entity_operations
254 |       filters:
255 |         subtype:
256 |           id: subtype
257 |           table: myentity_field_data
258 |           field: subtype
259 |           relationship: none
260 |           group_type: group
261 |           admin_label: ''
262 |           operator: in
263 |           value: {  }
264 |           group: 1
265 |           exposed: true
266 |           expose:
267 |             operator_id: subtype_op
268 |             label: Subtype
269 |             description: ''
270 |             use_operator: false
271 |             operator: subtype_op
272 |             identifier: subtype
273 |             required: false
274 |             remember: false
275 |             multiple: false
276 |             remember_roles:
277 |               authenticated: authenticated
278 |               anonymous: '0'
279 |               administrator: '0'
280 |             reduce: false
281 |           is_grouped: false
282 |           group_info:
283 |             label: ''
284 |             description: ''
285 |             identifier: ''
286 |             optional: true
287 |             widget: select
288 |             multiple: false
289 |             remember: false
290 |             default_group: All
291 |             default_group_multiple: {  }
292 |             group_items: {  }
293 |           entity_type: myentity
294 |           entity_field: subtype
295 |           plugin_id: bundle
296 |       sorts: {  }
297 |       title: 'My Entity Content'
298 |       header: {  }
299 |       footer: {  }
300 |       empty:
301 |         area:
302 |           id: area
303 |           table: views
304 |           field: area
305 |           relationship: none
306 |           group_type: group
307 |           admin_label: ''
308 |           empty: true
309 |           tokenize: false
310 |           content:
311 |             value: 'There is no My Entity content matching your filter choices.'
312 |             format: basic_html
313 |           plugin_id: text
314 |       relationships: {  }
315 |       arguments: {  }
316 |       display_extenders: {  }
317 |     cache_metadata:
318 |       contexts:
319 |         - 'languages:language_content'
320 |         - 'languages:language_interface'
321 |         - url
322 |         - 'url.query_args.pagers:0'
323 |         - user.permissions
324 |       cacheable: false
325 |   page_1:
326 |     display_plugin: page
327 |     id: page_1
328 |     display_title: Page
329 |     position: 1
330 |     display_options:
331 |       display_extenders: {  }
332 |       path: admin/my-entity-content
333 |     cache_metadata:
334 |       contexts:
335 |         - 'languages:language_content'
336 |         - 'languages:language_interface'
337 |         - url
338 |         - 'url.query_args.pagers:0'
339 |         - user.permissions
340 |       cacheable: false
341 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/config/schema/mymodule.schema.yml:
--------------------------------------------------------------------------------
 1 | # Schema for My Module configuration, from "Config API in Drupal 8", chapter 2.
 2 | 
 3 | mymodule.settings:
 4 |   type: config_object
 5 |   label: 'My module settings'
 6 |   mapping:
 7 |     submit_button_label:
 8 |       type: label
 9 |       label: 'Label for submit button'
10 |     name_field_settings:
11 |       type: mapping
12 |       label: 'Settings for name field'
13 |       mapping:
14 |         field_label:
15 |           type: label
16 |           label: 'Label for name field'
17 |         field_size:
18 |           type: integer
19 |           label: 'Size of name field'
20 | 
21 | # Schema for entity bundles of My Entity entites, from "Defining a Configuration
22 | # Entity Type in Drupal 8", chapter 4.
23 | 
24 | mymodule.myentity_type.*:
25 |   type: config_entity
26 |   label: 'My entity subtype'
27 |   mapping:
28 |     id:
29 |       type: string
30 |       label: 'Machine-readable name'
31 |     label:
32 |       type: label
33 |       label: 'Name'
34 |     description:
35 |       type: text
36 |       label: 'Description'
37 |     settings:
38 |       label: 'Settings'
39 |       type: mymodule.settings.myentity
40 | 
41 | mymodule.settings.myentity:
42 |   type: mapping
43 |   label: 'My entity subtype settings'
44 |   mapping:
45 |     default_status:
46 |       type: boolean
47 |       label: 'Published by default'
48 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.info.yml:
--------------------------------------------------------------------------------
 1 | # Drupal 8 sample module .info.yml file
 2 | 
 3 | # Comments start with #
 4 | 
 5 | # The name displayed on the Modules list page.
 6 | name: 'My Module'
 7 | 
 8 | # The longer description displayed on the Modules list.
 9 | description: Sample module from Programmers Guide to Drupal
10 | 
11 | # A required line telling Drupal this is a module.
12 | type: module
13 | 
14 | # The Drupal core version this module is compatible with.
15 | core: 8.x
16 | 
17 | # Dependencies on other modules.
18 | dependencies:
19 |   - user
20 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.install:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Install hooks for sample module.
 6 |  */
 7 | 
 8 | use Drupal\Core\Database\Database;
 9 | 
10 | /**
11 |  * Implements hook_schema().
12 |  *
13 |  * From "Setting up Database Tables" section in Chapter 2.
14 |  */
15 | function mymodule_schema() {
16 |   $schema = array();
17 |   $schema['mymodule_foo'] = array(
18 |     'description' => 'Untranslated description of this table',
19 |     'fields' => array(
20 |       'bar' => array(
21 |         'description' => 'Untranslated description of this field',
22 |         'type' => 'varchar',
23 |         'length' => 50,
24 |         'default' => '',
25 |       ),
26 |       'baz' => array(
27 |         'description' => 'Untranslated description of this field',
28 |         'type' => 'int',
29 |         'unsigned' => TRUE,
30 |         'default' => 0,
31 |       ),
32 |     ),
33 |     'primary key' => array('baz'),
34 |   );
35 |   return $schema;
36 | }
37 | 
38 | /**
39 |  * Make one field wider and add a new field in the mymodule_foo table.
40 |  *
41 |  * From "Setting up Database Tables" section in Chapter 2.
42 |  *
43 |  * Note: If you actually want to run this update, change the function name
44 |  * to remove the "not_", and then visit example.com/update.php.
45 |  */
46 | function not_mymodule_update_8001() {
47 |   $schema = Database::getConnection()->schema();
48 |   $schema->changeField('mymodule_foo', 'bar', 'bar', array(
49 |     'description' => 'Untranslated description of this field',
50 |     'type' => 'varchar',
51 |     'length' => 150,
52 |     'default' => '',
53 |   ));
54 |   $schema->addField('mymodule_foo', 'bay', array(
55 |     'description' => 'Untranslated description of this field',
56 |     'type' => 'varchar',
57 |     'length' => 50,
58 |     'default' => '',
59 |   ));
60 | 
61 | }
62 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.js:
--------------------------------------------------------------------------------
1 | // JavaScript file (empty) for this module.
2 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.libraries.yml:
--------------------------------------------------------------------------------
1 | myjslib:
2 |   version: 1.x
3 |   js:
4 |     mymodule.js : {}
5 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.links.action.yml:
--------------------------------------------------------------------------------
1 | # Local action from "Defining a Configuration Entity Type in Drupal 8",
2 | # chapter 4.
3 | 
4 | entity.myentity_type.add_form:
5 |   route_name: entity.myentity_type.add_form
6 |   title: 'Add my entity subtype'
7 |   appears_on:
8 |     - mymodule.myentity_type.list
9 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.links.menu.yml:
--------------------------------------------------------------------------------
 1 | # Menu link from "Providing administrative links", chapter 4.
 2 | 
 3 | # First line gives the machine name for the link.
 4 | # Often it matches the route machine name given below.
 5 | mymodule.mydescription:
 6 |   # Link title and description.
 7 |   title: 'Configure My Module'
 8 |   description: 'Longer description goes here'
 9 |   # Machine name for the parent link, from a *.links.menu.yml file.
10 |   parent: system.admin_structure
11 |   # Route machine name for this link.
12 |   route_name: mymodule.mydescription
13 | 
14 | # Menu link from "Defining a Configuration Entity Type in Drupal 8", chapter 4.
15 | 
16 | mymodule.myentity_type.list:
17 |   title: My entity subtypes
18 |   description: Manage my entity subtypes and their fields, display, etc.
19 |   route_name: mymodule.myentity_type.list
20 |   parent: system.admin_structure
21 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.links.task.yml:
--------------------------------------------------------------------------------
 1 | # Tasks from "Defining a Content Entity Type in Drupal 8", chapter 4.
 2 | 
 3 | entity.myentity.canonical:
 4 |   title: 'View'
 5 |   route_name: entity.myentity.canonical
 6 |   base_route: entity.myentity.canonical
 7 | 
 8 | entity.myentity.edit_form:
 9 |   title: 'Edit'
10 |   route_name: entity.myentity.edit_form
11 |   base_route: entity.myentity.canonical
12 | 
13 | 
14 | # Task from "Defining a Configuration Entity Type in Drupal 8", chapter 4.
15 | 
16 | entity.myentity_type.edit_form:
17 |   title: 'Edit'
18 |   route_name: entity.myentity_type.edit_form
19 |   base_route: entity.myentity_type.edit_form
20 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.module:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Sample module for Drupal 8.
  6 |  */
  7 | 
  8 | use Drupal\Core\Form\FormStateInterface;
  9 | use Drupal\Core\Render\Element;
 10 | 
 11 | /**
 12 |  * Implements hook_theme().
 13 |  *
 14 |  * To use the first theme hook in a render array:
 15 |  * @code
 16 |  * $build['hello'] = array(
 17 |  *   '#input1' => t('Hello World!'),
 18 |  *   '#theme' => 'mymodule_hookname',
 19 |  * );
 20 |  * @endcode
 21 |  *
 22 |  * @see mymodule-hookname.html.twig
 23 |  */
 24 | function mymodule_theme($existing, $type, $theme, $path) {
 25 |   return array(
 26 |     // Theme hook from section "Making Your Output Themeable" in Chapter 2.
 27 | 
 28 |     // The array keys are names of the theme hooks you are defining.
 29 |     'mymodule_hookname' => array(
 30 |       // Input variables.
 31 |       'variables' => array(
 32 |         // These are passed as an array to the rendering system, which
 33 |         // passes them on to your theme template. Here, provide default values.
 34 |         'input1' => '',
 35 |       ),
 36 |       // Name of the template file (without .html.twig extension).
 37 |       'template' => 'mymodule-hookname',
 38 |     ),
 39 | 
 40 |     // Theme hook for entity from "Defining a Content Entity Type in Drupal
 41 |     // 8", chapter 4.
 42 |     'myentity' => array(
 43 |       'render element' => 'elements',
 44 |       'template' => 'myentity',
 45 |     ),
 46 |   );
 47 | }
 48 | 
 49 | /**
 50 |  * Implements hook_form_FORM_ID_alter() for user_register_form().
 51 |  *
 52 |  * From "Altering forms", chapter 4.
 53 |  *
 54 |  * @see mymodule_validate_register_email()
 55 |  */
 56 | function mymodule_form_user_register_form_alter(&$form, FormStateInterface $form_state, $form_id) {
 57 | 
 58 |   // Change the label on the email address field.
 59 |   $form['account']['mail']['#title'] = t('Company e-mail address');
 60 | 
 61 |   // Add a validation function.
 62 |   $form['#validate'][] = 'mymodule_validate_register_email';
 63 | }
 64 | 
 65 | /**
 66 |  * Validation for mymodule_form_user_register_form_alter().
 67 |  *
 68 |  * From "Altering forms", chapter 4.
 69 |  */
 70 | function mymodule_validate_register_email($form, FormStateInterface $form_state) {
 71 |   $values = $form_state->getValues();
 72 |   $email = $values['mail'];
 73 | 
 74 |   // Check that the email is within the company domain.
 75 |   $parts = explode('@', $email);
 76 |   $company = 'poplarware.com';
 77 |   if (count($parts) != 2 || $parts[1] != $company) {
 78 |     $form_state->setErrorByName('mail', t('You are not allowed to register'));
 79 |   }
 80 | }
 81 | 
 82 | /**
 83 |  * Preprocesses My Entity entities.
 84 |  *
 85 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
 86 |  */
 87 | function template_preprocess_myentity(&$variables) {
 88 |   $variables['view_mode'] = $variables['elements']['#view_mode'];
 89 |   $entity = $variables['elements']['#myentity'];
 90 |   $variables['entity'] = $entity;
 91 |   $variables['title'] = $variables['entity']->getTitle();
 92 | 
 93 |   // See if the entity is being viewed on its own page.
 94 |   $route_match = \Drupal::routeMatch();
 95 |   $page = FALSE;
 96 |   if ($variables['view_mode'] == 'full' &&
 97 |       $route_match->getRouteName() == 'entity.myentity.canonical') {
 98 |     $page_entity = $route_match->getParameter('myentity');
 99 |     if ($page_entity && $page_entity->id() == $entity->id()) {
100 |       $page = TRUE;
101 |     }
102 |   }
103 |   $variables['page'] = $page;
104 | 
105 |   // Set up content variable for templates.
106 |   $variables += array('content' => array());
107 |   foreach (Element::children($variables['elements']) as $key) {
108 |     $variables['content'][$key] = $variables['elements'][$key];
109 |   }
110 | 
111 |   // Set up attributes.
112 |   $variables['attributes']['class'][] = 'myentity';
113 | }
114 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.permissions.yml:
--------------------------------------------------------------------------------
 1 | # Sample permission from "Drupal core's main permission system" section
 2 | # in Chapter 2.
 3 | administer mymodule:
 4 |   title: 'Administer My Module settings'
 5 |   description: 'Longer description only if it is really necessary.'
 6 | 
 7 | # Permission for \Drupal\mymodule\Form\PersonalDataForm.
 8 | use company field:
 9 |   title: 'Use the Company field'
10 | 
11 | # Permission for route mymodule.delete_confirm.
12 | delete mycontent items:
13 |   title: 'Delete ficticious content items'
14 | 
15 | # Permission for the entity from "Defining a Content Entity in Drupal 8",
16 | # chapter 4.
17 | administer my entities:
18 |   title: 'Administer my entities'
19 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.routing.yml:
--------------------------------------------------------------------------------
 1 | # Route defined in "Registering for a URL in Drupal 8", chapter 4.
 2 | 
 3 | # First line gives the machine name (route identifier) for the route.
 4 | mymodule.mydescription:
 5 |   # URL path you are registering for.
 6 |   path: '/mymodule/mypath'
 7 |   defaults:
 8 |     # Class method that generates the page.
 9 |     _controller: '\Drupal\mymodule\Controller\MyUrlController::generateMyPage'
10 |     # Title of the page.
11 |     _title: 'My page title'
12 |   requirements:
13 |     # Permission needed to access the page.
14 |     _permission: 'administer mymodule'
15 | 
16 | # Route from "Basic Form Generation and Processing in Drupal 8", chapter 4.
17 | 
18 | mymodule.personal_data_form:
19 |   path: '/mymodule/my_form_page'
20 |   defaults:
21 |     _form: '\Drupal\mymodule\Form\PersonalDataForm'
22 |     _title: 'Personal data form'
23 |   requirements:
24 |     _access: 'TRUE'
25 | 
26 | # Route from "Creating Confirmation Forms", chapter 4.
27 | 
28 | mymodule.delete_confirm:
29 |   path: '/admin/content/mycontent/delete/{id}'
30 |   defaults:
31 |     _form: '\Drupal\mymodule\Form\ConfirmDeleteForm'
32 |     _title: 'Delete content item?'
33 |   requirements:
34 |     _permission: 'delete mycontent items'
35 | 
36 | # Route from "Adding Auto-Complete to Forms", chapter 4.
37 | 
38 | mymodule.autocomplete:
39 |   path: '/mymodule/autocomplete'
40 |   defaults:
41 |     _controller: '\Drupal\mymodule\Controller\MyUrlController::autocomplete'
42 |   requirements:
43 |     _permission: 'use company field'
44 | 
45 | # Routes from "Defining a Configuration Entity Type in Drupal 8", chapter 4.
46 | 
47 | mymodule.myentity_type.list:
48 |   path: '/admin/structure/myentity_type'
49 |   defaults:
50 |     _entity_list: 'myentity_type'
51 |     _title: 'My entity subtypes'
52 |   requirements:
53 |     _permission: 'administer my entities'
54 | 
55 | entity.myentity_type.add_form:
56 |   path: '/admin/structure/myentity_type/add'
57 |   defaults:
58 |     _entity_form: 'myentity_type.add'
59 |     _title: 'Add my entity subtype'
60 |   requirements:
61 |     _entity_create_access: 'myentity_type'
62 | 
63 | entity.myentity_type.edit_form:
64 |   path: '/admin/structure/myentity_type/manage/{myentity_type}'
65 |   defaults:
66 |     _entity_form: 'myentity_type.edit'
67 |     _title: 'Edit my entity subtype'
68 |   requirements:
69 |     _entity_access: 'myentity_type.edit'
70 | 
71 | entity.myentity_type.delete_form:
72 |   path: '/admin/structure/myentity_type/delete/{myentity_type}'
73 |   defaults:
74 |     _entity_form: 'myentity_type.delete'
75 |     _title: 'Delete my entity subtype'
76 |   requirements:
77 |     _entity_access: 'myentity_type.delete'
78 | 
79 | mymodule.myentity.add:
80 |   path: '/myentity/add/{myentity_type}'
81 |   defaults:
82 |     _controller: '\Drupal\mymodule\Controller\MyUrlController::addEntityPage'
83 |     _title: 'Add new my entity'
84 |   requirements:
85 |     _entity_create_access: 'myentity'
86 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/mymodule.services.yml:
--------------------------------------------------------------------------------
 1 | # Service definitions for module.
 2 | services:
 3 | 
 4 |   # From "Event Subscribers in Drupal 8: Altering Routes and Providing
 5 |   # Dynamic Routes", chapter 4.
 6 | 
 7 |   # Machine name of the service.
 8 |   mymodule.subscriber:
 9 |     # Class providing the service.
10 |     class: Drupal\mymodule\Routing\MyModuleRouting
11 |     # Service tags. This service is an event subscriber.
12 |     tags:
13 |     - { name: event_subscriber }
14 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Controller/MyUrlController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains \Drupal\mymodule\Controller\MyUrlController.
  6 |  */
  7 | 
  8 | namespace Drupal\mymodule\Controller;
  9 | 
 10 | use Drupal\Core\Controller\ControllerBase;
 11 | use Drupal\Core\Database\Connection;
 12 | use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
 13 | use Drupal\mymodule\Entity\MyEntityTypeInterface;
 14 | use Symfony\Component\DependencyInjection\ContainerInterface;
 15 | use Symfony\Component\HttpFoundation\JsonResponse;
 16 | use Symfony\Component\HttpFoundation\Request;
 17 | use Drupal\Component\Utility\Html;
 18 | 
 19 | /**
 20 |  * Provides route responses for the sample module.
 21 |  *
 22 |  * From "Registering for a URL in Drupal 8", chapter 4, except for methods
 23 |  * noted below.
 24 |  */
 25 | class MyUrlController extends ControllerBase {
 26 | 
 27 |   /**
 28 |    * The database service, obtained through dependency injection.
 29 |    *
 30 |    * @var \Drupal\Core\Database\Connection
 31 |    */
 32 |   protected $database;
 33 | 
 34 |   /**
 35 |    * Creates a new controller object.
 36 |    */
 37 |   public static function create(ContainerInterface $container) {
 38 |     return new static($container->get('database'));
 39 |   }
 40 | 
 41 |   /**
 42 |    * Constructs a controller object.
 43 |    *
 44 |    * @param Connection $database
 45 |    *   A database connection.
 46 |    */
 47 |   public function __construct(Connection $database) {
 48 |     $this->database = $database;
 49 |   }
 50 | 
 51 |   /**
 52 |    * Generates a sample content page.
 53 |    *
 54 |    * Function body from "Generating paged output", in Chapter 4.
 55 |    */
 56 |   public function generateMyPage() {
 57 |     // Note: You should really use the Views module to do this! Code is
 58 |     // only here to illustrate using PagerSelectExtender on a query,
 59 |     // and 'pager' item in a render array.
 60 | 
 61 |     $query = $this->database->select('node', 'n');
 62 |     $query->innerJoin('node_field_data', 'nd', 'n.nid = nd.nid AND n.vid = nd.vid');
 63 |     $query = $query
 64 |       ->extend('Drupal\Core\Database\Query\PagerSelectExtender') // Add pager.
 65 |       ->addMetaData('base_table', 'node') // Necessary for join queries.
 66 |       ->limit(10) // 10 items per page.
 67 |       ->fields('nd', array('title', 'nid')) // Get the title field.
 68 |       ->orderBy('nd.created', 'DESC') // Sort by last updated.
 69 |       ->addTag('node_access') // Enforce node access.
 70 |       ->condition('nd.status', 1);
 71 | 
 72 |     $result = $query->execute();
 73 | 
 74 |     // Extract the information from the query result.
 75 |     $titles = array();
 76 |     foreach ($result as $row) {
 77 |       $titles[] = $row->title;
 78 |     }
 79 | 
 80 |     // Make the render array for a paged list of titles.
 81 |     $build = array();
 82 |     $build['items'] = array(
 83 |       '#theme' => 'item_list',
 84 |       '#items' => $titles,
 85 |     );
 86 | 
 87 |     // Add the pager.
 88 |     $build['item_pager'] = array('#type' => 'pager');
 89 | 
 90 |     return $build;
 91 |   }
 92 | 
 93 |   /**
 94 |    * Generates autocompletes for path mymodule/autocomplete.
 95 |    *
 96 |    * From "Adding Auto-Complete to Forms", chapter 4.
 97 |    */
 98 |   public function autocomplete(Request $request) {
 99 |     $string = $request->query->get('q');
100 |     // This is being output as JSON, so it needs to be sanitized.
101 |     $string = Html::escape($string);
102 | 
103 |     $matches = array();
104 | 
105 |     if ($string) {
106 |       // Find appropriate matches -- about 10 or fewer.
107 |       // Put them into $matches as items, each an array with
108 |       // 'value' and 'label' elements.
109 | 
110 |       // As a proxy, just add some text to the end of the submitted text.
111 |       $additions = array('add', 'choice', 'more', 'plus', 'something');
112 |       foreach ($additions as $word) {
113 |         $choice = $string . $word;
114 |         $matches[] = array(
115 |           'value' => $choice,
116 |           'label' => $choice,
117 |         );
118 |       }
119 |     }
120 | 
121 |     return new JsonResponse($matches);
122 |   }
123 | 
124 |   /**
125 |    * Generates a form for adding a new My Entity entity object.
126 |    *
127 |    * @param \Drupal\mymodule\Entity\MyEntityTypeInterface $myentity_type
128 |    *   The subtype (bundle) to use.
129 |    *
130 |    * From "Defining a Content Entity Type in Drupal 8", chapter 4.
131 |    *
132 |    * @return array
133 |    *   The form array for the page.
134 |    */
135 |   public function addEntityPage(MyEntityTypeInterface $myentity_type) {
136 |     // Create a stub entity of this type.
137 |     $entity = $this->entityTypeManager()
138 |       ->getStorage('myentity')
139 |       ->create(array('subtype' => $myentity_type->id()));
140 | 
141 |     // You might want to set other values on the stub entity.
142 | 
143 |     // Return the entity editing form for the stub entity.
144 |     return $this->entityFormBuilder()->getForm($entity);
145 |   }
146 | }
147 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntity.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Contains \Drupal\mymodule\Entity\MyEntity.
  5 |  */
  6 | 
  7 | namespace Drupal\mymodule\Entity;
  8 | 
  9 | use Drupal\mymodule\Entity\MyEntityInterface;
 10 | use Drupal\Core\Entity\ContentEntityBase;
 11 | use Drupal\Core\Entity\EntityTypeInterface;
 12 | use Drupal\Core\Field\BaseFieldDefinition;
 13 | 
 14 | /**
 15 |  * Represents a MyEntity entity object.
 16 |  *
 17 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
 18 |  *
 19 |  * @ContentEntityType(
 20 |  *   id = "myentity",
 21 |  *   label = @Translation("My entity"),
 22 |  *   bundle_label = @Translation("My entity subtype"),
 23 |  *   fieldable = TRUE,
 24 |  *   handlers = {
 25 |  *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 26 |  *     "list_builder" = "Drupal\Core\Entity\EntityListBuilder",
 27 |  *     "views_data" = "Drupal\mymodule\Entity\MyEntityViewsData",
 28 |  *     "translation" = "Drupal\content_translation\ContentTranslationHandler",
 29 |  *     "route_provider" = {
 30 |  *       "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
 31 |  *     },
 32 |  *     "form" = {
 33 |  *       "default" = "Drupal\mymodule\Entity\MyEntityForm",
 34 |  *       "edit" = "Drupal\mymodule\Entity\MyEntityForm",
 35 |  *       "delete" = "Drupal\Core\Entity\ContentEntityDeleteForm",
 36 |  *     }
 37 |  *   },
 38 |  *   admin_permission = "administer my entities",
 39 |  *   base_table = "myentity",
 40 |  *   data_table = "myentity_field_data",
 41 |  *   translatable = TRUE,
 42 |  *   entity_keys = {
 43 |  *     "id" = "eid",
 44 |  *     "bundle" = "subtype",
 45 |  *     "label" = "title",
 46 |  *     "langcode" = "langcode",
 47 |  *     "uuid" = "uuid",
 48 |  *   },
 49 |  *   links = {
 50 |  *     "canonical" = "/myentity/{myentity}",
 51 |  *     "delete-form" = "/myentity/{myentity}/delete",
 52 |  *     "edit-form" = "/myentity/{myentity}/edit",
 53 |  *   },
 54 |  *   field_ui_base_route = "entity.myentity_type.edit_form",
 55 |  *   bundle_entity_type = "myentity_type",
 56 |  * )
 57 |  */
 58 | class MyEntity extends ContentEntityBase implements MyEntityInterface {
 59 | 
 60 |   /**
 61 |    * {@inheritdoc}
 62 |    */
 63 |   public function getTitle() {
 64 |     return $this->get('title')->value;
 65 |   }
 66 | 
 67 |   /**
 68 |    * {@inheritdoc}
 69 |    */
 70 |   public function setTitle($title) {
 71 |     $this->set('title', $title);
 72 |     return $this;
 73 |   }
 74 | 
 75 |   /**
 76 |    * {@inheritdoc}
 77 |    */
 78 |   public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
 79 |     // Define base fields for the items in the entity_keys
 80 |     // annotation. Note that as this is a static method, you cannot use
 81 |     // $this->t() here; use t() for translation instead.
 82 |     // Also note that the reason for the redundant descriptions is that
 83 |     // Views displays errors if they are missing.
 84 |     $fields['eid'] = BaseFieldDefinition::create('integer')
 85 |       ->setLabel(t('My entity ID'))
 86 |       ->setDescription(t('My entity ID'))
 87 |       ->setReadOnly(TRUE)
 88 |       ->setSetting('unsigned', TRUE);
 89 | 
 90 |     $fields['subtype'] = BaseFieldDefinition::create('entity_reference')
 91 |       ->setLabel(t('Subtype'))
 92 |       ->setDescription(t('Subtype'))
 93 |       ->setSetting('target_type', 'myentity_type');
 94 | 
 95 |     // Add a language code field so the entity can be translated.
 96 |     $fields['langcode'] = BaseFieldDefinition::create('language')
 97 |       ->setLabel(t('Language'))
 98 |       ->setDescription(t('Language code'))
 99 |       ->setTranslatable(TRUE)
100 |       ->setDisplayOptions('view', array(
101 |         'type' => 'hidden',
102 |       ))
103 |       ->setDisplayOptions('form', array(
104 |         'type' => 'language_select',
105 |         'weight' => 2,
106 |       ));
107 | 
108 |     // The title field is the only editable field in the base
109 |     // data. Set it up to be configurable in Manage Form Display
110 |     // and Manage Display.
111 |     $fields['title'] = BaseFieldDefinition::create('string')
112 |       ->setLabel(t('Title'))
113 |       ->setDescription(t('Title'))
114 |       ->setTranslatable(TRUE)
115 |       ->setRequired(TRUE)
116 |       ->setDisplayOptions('view', array(
117 |           'label' => 'hidden',
118 |           'type' => 'string',
119 |           'weight' => 5,
120 |         ))
121 |       ->setDisplayConfigurable('view', TRUE)
122 |       ->setDisplayOptions('form', array(
123 |           'type' => 'string_textfield',
124 |           'weight' => 5,
125 |         ))
126 |       ->setDisplayConfigurable('form', TRUE);
127 | 
128 |     $fields['uuid'] = BaseFieldDefinition::create('uuid')
129 |       ->setLabel(t('UUID'))
130 |       ->setDescription(t('Universally Unique ID'))
131 |       ->setReadOnly(TRUE);
132 | 
133 |     return $fields;
134 |   }
135 | }
136 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityDeleteForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityForm.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Entity\ContentEntityConfirmFormBase;
10 | use Drupal\Core\Form\FormStateInterface;
11 | use Drupal\Core\Url;
12 | 
13 | /**
14 |  * Provides a confirmation form for deleting My Entity entities.
15 |  *
16 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
17 |  */
18 | class MyEntityDeleteForm extends ContentEntityConfirmFormBase {
19 | 
20 |   /**
21 |    * {@inheritdoc}
22 |    */
23 |   public function getQuestion() {
24 |     return $this->t('Are you sure you want to delete the My Entity %title?', array('%title' => $this->entity->getTitle()));
25 |   }
26 | 
27 |   /**
28 |    * Defines where to go on cancel (the view page).
29 |    */
30 |   public function getCancelUrl() {
31 |     return new Url('entity.myentity.canonical', array('myentity' => $this->entity->id()));
32 |   }
33 | 
34 |   /**
35 |    * {@inheritdoc}
36 |    */
37 |   public function submitForm(array &$form, FormStateInterface $form_state) {
38 |     $title = $this->entity->getTitle();
39 |     $this->entity->delete();
40 | 
41 |     drupal_set_message($this->t('Deleted the My Entity %title', array('%title' => $title)));
42 | 
43 |     // Redirect to the site home page.
44 |     $form_state->setRedirect('<front>');
45 |   }
46 | }
47 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityForm.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Entity\ContentEntityForm;
10 | use Drupal\Core\Form\FormStateInterface;
11 | use Drupal\Core\Url;
12 | 
13 | /**
14 |  * Provides an entity form for My Entity entities.
15 |  *
16 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
17 |  */
18 | class MyEntityForm extends ContentEntityForm {
19 | 
20 |   /**
21 |    * Saves the entity; note that ContentEntityForm does most of the work.
22 |    */
23 |   public function save(array $form, FormStateInterface $form_state) {
24 |     $entity = $this->entity;
25 |     $entity->save();
26 | 
27 |     // You could do some logging here, set a message, etc.
28 | 
29 |     // Redirect to the entity display page.
30 |     $form_state->setRedirect('entity.myentity.canonical', array('myentity' => $entity->id()));
31 | 
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityInterface.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Entity\ContentEntityInterface;
10 | 
11 | /**
12 |  * Defines an interface for My Entity entities.
13 |  *
14 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
15 |  */
16 | interface MyEntityInterface extends ContentEntityInterface {
17 | 
18 |   /**
19 |    * Returns the entity title.
20 |    *
21 |    * @return string
22 |    *   The title.
23 |    *
24 |    * @see \Drupal\mymodule\Entity\MyEntityInterface::setTitle()
25 |    */
26 |   public function getTitle();
27 | 
28 |   /**
29 |    * Sets the entity title.
30 |    *
31 |    * @param string $title
32 |    *   The title to set.
33 |    *
34 |    * @return $this
35 |    *
36 |    * @see \Drupal\mymodule\Entity\MyEntityInterface::getTitle()
37 |    */
38 |   public function setTitle($title);
39 | }
40 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityType.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Config\ConfigException;
10 | use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
11 | use Drupal\Core\Entity\EntityStorageInterface;
12 | use Drupal\mymodule\Entity\MyEntityTypeInterface;
13 | 
14 | /**
15 |  * Defines the My Entity bundle configuration entity.
16 |  *
17 |  * From "Defining a Configuration Entity Type in Drupal 8", chapter 4.
18 |  *
19 |  * @ConfigEntityType(
20 |  *   id = "myentity_type",
21 |  *   label = @Translation("My entity subtype"),
22 |  *   handlers = {
23 |  *     "form" = {
24 |  *       "add" = "Drupal\mymodule\Entity\MyEntityTypeForm",
25 |  *       "edit" = "Drupal\mymodule\Entity\MyEntityTypeForm",
26 |  *       "delete" = "Drupal\mymodule\Entity\MyEntityTypeDeleteForm",
27 |  *     },
28 |  *     "list_builder" = "Drupal\mymodule\Entity\MyEntityTypeListBuilder",
29 |  *   },
30 |  *   admin_permission = "administer my entities",
31 |  *   bundle_of = "myentity",
32 |  *   entity_keys = {
33 |  *     "id" = "id",
34 |  *     "label" = "label",
35 |  *   },
36 |  *   links = {
37 |  *     "add-form" = "/admin/structure/myentity_type/add",
38 |  *     "edit-form" = "/admin/structure/myentity_type/manage/{myentity_type}",
39 |  *     "delete-form" = "/admin/structure/myentity_type/delete/{myentity_type}",
40 |  *   }
41 |  * )
42 |  */
43 | class MyEntityType extends ConfigEntityBundleBase implements MyEntityTypeInterface {
44 |   /**
45 |    * Machine name or ID of the entity bundle.
46 |    *
47 |    * @var string
48 |    */
49 |   public $id;
50 | 
51 |   /**
52 |    * Human-readable name of the entity bundle.
53 |    *
54 |    * @var string
55 |    */
56 |   public $label;
57 | 
58 |   /**
59 |    * Description of the entity bundle.
60 |    *
61 |    * @var string
62 |    */
63 |   public $description;
64 | 
65 |   /**
66 |    * Settings for the entity bundle.
67 |    *
68 |    * @var array
69 |    */
70 |   public $settings = array();
71 | 
72 |   /**
73 |    * {@inheritdoc}
74 |    */
75 |   public function getDescription() {
76 |     return $this->description;
77 |   }
78 | 
79 |   /**
80 |    * Disallows changing the machine name, during pre-save.
81 |    *
82 |    * If the machine name of the bundle was changed, all of the
83 |    * existing entities with that bundle would be invalid.
84 |    */
85 |   public function preSave(EntityStorageInterface $storage) {
86 |     parent::preSave($storage);
87 | 
88 |     if (!$this->isNew() && ($this->getOriginalId() != $this->id())) {
89 |       throw new ConfigException('Cannot change machine name');
90 |     }
91 |   }
92 | }
93 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityTypeDeleteForm.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Contains \Drupal\mymodule\Entity\MyEntityTypeDeleteForm.
  5 |  */
  6 | 
  7 | namespace Drupal\mymodule\Entity;
  8 | 
  9 | use Drupal\Core\Entity\EntityConfirmFormBase;
 10 | use Drupal\Core\Entity\EntityTypeManagerInterface;
 11 | use Drupal\Core\Entity\Query\QueryFactory;
 12 | use Drupal\Core\Form\FormStateInterface;
 13 | use Drupal\Core\Url;
 14 | use Symfony\Component\DependencyInjection\ContainerInterface;
 15 | 
 16 | /**
 17 |  * Provides a confirmation form for deleting bundles of My Entity.
 18 |  *
 19 |  * From "Defining a Configuration Entity Type in Drupal 8", chapter 4.
 20 |  */
 21 | class MyEntityTypeDeleteForm extends EntityConfirmFormBase {
 22 | 
 23 |   /**
 24 |    * The entity manager class.
 25 |    *
 26 |    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
 27 |    */
 28 |   protected $manager;
 29 | 
 30 |   /**
 31 |    * The entity query factory class.
 32 |    *
 33 |    * @var \Drupal\Core\Entity\Query\QueryFactory
 34 |    */
 35 |   protected $queryFactory;
 36 | 
 37 |   /**
 38 |    * Constructs the delete confirm form, using dependency injection.
 39 |    */
 40 |   public function __construct(QueryFactory $query_factory, EntityTypeManagerInterface $manager) {
 41 |     $this->queryFactory = $query_factory;
 42 |     $this->manager = $manager;
 43 |   }
 44 | 
 45 |   /**
 46 |    * {@inheritdoc}
 47 |    */
 48 |   public static function create(ContainerInterface $container) {
 49 |     return new static(
 50 |       $container->get('entity.query'),
 51 |       $container->get('entity_type.manager')
 52 |     );
 53 |   }
 54 | 
 55 |   /**
 56 |    * Defines the question to show on the screen.
 57 |    */
 58 |   public function getQuestion() {
 59 |     return $this->t('Are you sure you want to delete %label?',
 60 |       array('%label' => $this->entity->label()));
 61 |   }
 62 | 
 63 |   /**
 64 |    * Adds a description.
 65 |    */
 66 |   public function getDescription() {
 67 |     return $this->t('All entities of this type will also be deleted!');
 68 |   }
 69 | 
 70 |   /**
 71 |    * Defines where to go on cancel (the admin page for these bundles).
 72 |    */
 73 |   public function getCancelUrl() {
 74 |     return new Url('mymodule.myentity_type.list');
 75 |   }
 76 | 
 77 |   /**
 78 |    * Carries out entity bundle deletion and deletes entities of this type.
 79 |    */
 80 |   public function submitForm(array &$form, FormStateInterface $form_state) {
 81 | 
 82 |     // Find all the entities of this type, using an entity query.
 83 |     $query = $this->queryFactory->get('myentity');
 84 |     $query->condition('subtype', $this->entity->id());
 85 |     $ids = $query->execute();
 86 | 
 87 |     // Delete the found entities, using the storage controller.
 88 |     // You may actually need to use a batch here, if there could be
 89 |     // many entities.
 90 |     $storage = $this->manager->getStorage('myentity');
 91 |     $entities = $storage->loadMultiple($ids);
 92 |     $storage->delete($entities);
 93 | 
 94 |     // Delete the bundle entity itself.
 95 |     $this->entity->delete();
 96 | 
 97 |     $form_state->setRedirectUrl($this->getCancelUrl());
 98 |   }
 99 | }
100 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityTypeForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityTypeForm.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Entity\EntityForm;
10 | use Drupal\Core\Form\FormStateInterface;
11 | use Drupal\Core\Url;
12 | 
13 | /**
14 |  * Defines the edit form for the My Entity bundle configuration entity.
15 |  *
16 |  * From "Defining a Configuration Entity Type in Drupal 8", chapter 4.
17 |  */
18 | class MyEntityTypeForm extends EntityForm {
19 |   /**
20 |    * Builds an editing form.
21 |    */
22 |   public function form(array $form, FormStateInterface $form_state) {
23 |     $form = parent::form($form, $form_state);
24 | 
25 |     $form['id'] = array(
26 |       '#title' => $this->t('Machine-readable name'),
27 |       '#type' => 'textfield',
28 |       '#required' => TRUE,
29 |     );
30 | 
31 |     // If we are editing an existing entity, show the current ID and
32 |     // do not allow it to be changed.
33 |     if ($this->entity->id()) {
34 |       $form['id']['#default_value'] = $this->entity->id();
35 |       $form['id']['#disabled'] = TRUE;
36 |     }
37 | 
38 |     $form['label'] = array(
39 |       '#title' => $this->t('Label'),
40 |       '#type' => 'textfield',
41 |       '#default_value' => $this->entity->label,
42 |     );
43 | 
44 |     $form['description'] = array(
45 |       '#title' => $this->t('Description'),
46 |       '#type' => 'textfield',
47 |       '#default_value' => $this->entity->description,
48 |     );
49 | 
50 |     $form['settings'] = array(
51 |       '#type' => 'details',
52 |       '#title' => $this->t('Settings'),
53 |       '#open' => TRUE,
54 |       '#tree' => TRUE,
55 |     );
56 | 
57 |     $settings = $this->entity->settings;
58 |     $form['settings']['default_status'] = array(
59 |       '#title' => $this->t('Published by default'),
60 |       '#type' => 'checkbox',
61 |       '#default_value' => !empty($settings['default_status']),
62 |     );
63 | 
64 |     return $form;
65 |   }
66 | 
67 |   /**
68 |    * Validates the values.
69 |    */
70 |   public function validateForm(array &$form, FormStateInterface $form_state) {
71 |     parent::validateForm($form, $form_state);
72 | 
73 |     $values = $form_state->getValues();
74 | 
75 |     // Require non-empty ID.
76 |     $id = trim($values['id']);
77 |     if (empty($id)) {
78 |       $form_state->setErrorByName('id', $this->t('Subtype names must not be empty'));
79 |     }
80 |   }
81 | 
82 |   /**
83 |    * Saves the entity when the form is submitted.
84 |    */
85 |   public function save(array $form, FormStateInterface $form_state) {
86 |     $type = $this->entity;
87 |     $type->save();
88 |     // You could do some logging here, set a message, etc.
89 | 
90 |     // Redirect to admin page.
91 |     $form_state->setRedirect('mymodule.myentity_type.list');
92 |   }
93 | }
94 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityTypeInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityTypeInterface.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Config\Entity\ConfigEntityInterface;
10 | 
11 | /**
12 |  * Defines an interface for My Entity bundle configuration entities.
13 |  *
14 |  * From "Defining a Configuration Entity Type in Drupal 8", chapter 4.
15 |  */
16 | interface MyEntityTypeInterface extends ConfigEntityInterface {
17 |   /**
18 |    * Returns the description of the bundle.
19 |    *
20 |    * @return string
21 |    *   The bundle description.
22 |    */
23 |   public function getDescription();
24 | }
25 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityTypeListBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityTypeListBuilder.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
10 | use Drupal\Core\Entity\EntityInterface;
11 | use Drupal\Core\Url;
12 | use Drupal\Component\Utility\Xss;
13 | 
14 | /**
15 |  * Defines a list builder class for My Entity bundle configuration entities.
16 |  *
17 |  * From "Defining a Configuration Entity Type in Drupal 8", chapter 4.
18 |  */
19 | class MyEntityTypeListBuilder extends ConfigEntityListBuilder {
20 | 
21 |   /**
22 |    * Defines the header of the list in the UI.
23 |    */
24 |   public function buildHeader() {
25 |     $header['label'] = $this->t('Label');
26 | 
27 |     $header['description'] = array(
28 |       'data' => $this->t('Description'),
29 |     );
30 | 
31 |     return $header + parent::buildHeader();
32 |   }
33 | 
34 |   /**
35 |    * Defines how to display an entity in a row in the list.
36 |    */
37 |   public function buildRow(EntityInterface $entity) {
38 |     $row['label'] = array(
39 |       'data' => $this->getLabel($entity),
40 |     );
41 | 
42 |     $row['description'] = Xss::filterAdmin($entity->description);
43 | 
44 |     return $row + parent::buildRow($entity);
45 |   }
46 | 
47 |   /**
48 |    * Defines the default operations.
49 |    */
50 |   public function getDefaultOperations(EntityInterface $entity) {
51 |     $operations = parent::getDefaultOperations($entity);
52 | 
53 |     // Add an operation for adding a new entity object of this type.
54 |     $url = new Url('mymodule.myentity.add', array('myentity_type' => $entity->id()));
55 |     $operations['add_new'] = array(
56 |       'title' => $this->t('Add new My Entity'),
57 |       'weight' =>  11,
58 |       'url' => $url,
59 |     );
60 | 
61 |     return $operations;
62 |   }
63 | }
64 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Entity/MyEntityViewsData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Entity\MyEntityViewsData.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Entity;
 8 | 
 9 | use Drupal\views\EntityViewsData;
10 | 
11 | /**
12 |  * Provides views data for My Entity entities.
13 |  *
14 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
15 |  */
16 | class MyEntityViewsData extends EntityViewsData {
17 | 
18 |   /**
19 |    * Returns the Views data for the entity.
20 |    */
21 |   public function getViewsData() {
22 |     // Start with the Views information provided by the base class.
23 |     $data = parent::getViewsData();
24 | 
25 |     // Define a wizard.
26 |     $data['myentity_field_data']['table']['wizard_id'] = 'myentity';
27 | 
28 |     // You could also override labels or put in a custom field
29 |     // or filter handler.
30 | 
31 |     return $data;
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Form/ConfirmDeleteForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Form\ConfirmDeleteForm.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Form;
 9 | 
10 | use Drupal\Core\Form\ConfirmFormBase;
11 | use Drupal\Core\Form\FormStateInterface;
12 | use Drupal\Core\Url;
13 | 
14 | /**
15 |  * Presents a delete confirm form for ficticious content.
16 |  *
17 |  * From "Creating Confirmation Forms", chapter 4.
18 |  */
19 | class ConfirmDeleteForm extends ConfirmFormBase {
20 | 
21 |   /**
22 |    * Stores the ID of the item being deleted.
23 |    *
24 |    * @var int
25 |    */
26 |   protected $to_delete_id;
27 | 
28 |   /**
29 |    * Returns the chosen form ID, which must be unique.
30 |    */
31 |   public function getFormId() {
32 |     return 'mymodule_confirm_delete';
33 |   }
34 | 
35 |   /**
36 |    * Builds the form array.
37 |    *
38 |    * Note that when adding arguments to buildForm(), you need to give
39 |    * them default values, to avoid PHP errors.
40 |    */
41 |   public function buildForm(array $form, FormStateInterface $form_state, $id = '') {
42 |     // Sanitize and save the ID.
43 |     $id = (int) $id;
44 |     $this->to_delete_id = $id;
45 | 
46 |     $form = parent::buildForm($form, $form_state);
47 |     return $form;
48 |   }
49 | 
50 |   /**
51 |    * Defines the question for confirmation.
52 |    */
53 |   public function getQuestion() {
54 |     return  $this->t('Are you sure you want to delete content item %id?',
55 |       array('%id' => $this->to_delete_id));
56 |   }
57 | 
58 |   /**
59 |    * Defines the URL to go to if the user cancels.
60 |    */
61 |   public function getCancelUrl() {
62 |     return new Url('mymodule.mydescription');
63 |   }
64 | 
65 |   /**
66 |    * Processes form submissions.
67 |    */
68 |   public function submitForm(array &$form, FormStateInterface $form_state) {
69 |     $id = $this->to_delete_id;
70 | 
71 |     // Perform the data deletion, if it were real. As a proxy, just put up
72 |     // a message.
73 |     drupal_set_message($this->t('Would have deleted @id', array('@id' => $id)));
74 | 
75 |     // Redirect somewhere.
76 |     $form_state->setRedirect('mymodule.personal_data_form');
77 |   }
78 | }
79 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Form/PersonalDataForm.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains \Drupal\mymodule\Form\PersonalDataForm.
  6 |  */
  7 | 
  8 | namespace Drupal\mymodule\Form;
  9 | 
 10 | use Drupal\Component\Utility\NestedArray;
 11 | use Drupal\Core\Ajax\AjaxResponse;
 12 | use Drupal\Core\Ajax\HtmlCommand;
 13 | use Drupal\Core\Ajax\CssCommand;
 14 | use Drupal\Core\Form\FormBase;
 15 | use Drupal\Core\Form\FormStateInterface;
 16 | 
 17 | /**
 18 |  * Presents a personal data form.
 19 |  *
 20 |  * From "Basic Form Generation and Processing in Drupal 8", chapter 4.
 21 |  */
 22 | class PersonalDataForm extends FormBase {
 23 | 
 24 |   /**
 25 |    * Returns the chosen form ID, which must be unique.
 26 |    */
 27 |   public function getFormId() {
 28 |     return 'mymodule_personal_data_form';
 29 |   }
 30 | 
 31 |   /**
 32 |    * Builds the form array.
 33 |    *
 34 |    * Form array in function body from "Form Arrays, Form State Arrays, and
 35 |    * Form State Objects", chapter 4.
 36 |    *
 37 |    * JavaScript attachment from "Creating Render Arrays for Page and Block
 38 |    * Output", chapter 4.
 39 |    *
 40 |    * Auto-complete field from "Adding Auto-Complete to Forms", chapter 4.
 41 |    *
 42 |    * Ajax fields from "Setting Up a Form for Ajax", chapter 4.
 43 |    *
 44 |    * @see mymodule_permission()
 45 |    */
 46 |   public function buildForm(array $form, FormStateInterface $form_state) {
 47 |     // Plain text input element for first name.
 48 |     $form['first_name'] = array(
 49 |       '#type' => 'textfield',
 50 |       '#title' => $this->t('First name'),
 51 |     );
 52 | 
 53 |     // Plain text element for company name, only visible to some
 54 |     // users.
 55 |     $form['company'] = array(
 56 |       '#type' => 'textfield',
 57 |       '#title' => $this->t('Company'),
 58 |       // This assumes permission 'use company field' has been defined.
 59 |       '#access' => $this->currentUser()->hasPermission('use company field'),
 60 |     );
 61 | 
 62 |     $my_information = 'stuff';
 63 | 
 64 |     // Some hidden information to be used later.
 65 |     $form['information'] = array(
 66 |       '#type' => 'value',
 67 |       '#value' => $my_information,
 68 |     );
 69 | 
 70 |     // Submit button.
 71 |     $form['submit'] = array(
 72 |       '#type' => 'submit',
 73 |       '#value' => $this->t('Submit'),
 74 |     );
 75 | 
 76 |     // Attach a JavaScript file, which is in a library.
 77 |     $form['#attached']['library'][] = 'mymodule/myjslib';
 78 | 
 79 |     // Auto-complete field.
 80 |     $form['my_autocomplete_field'] = array(
 81 |       '#type' => 'textfield',
 82 |       '#title' => $this->t('Autocomplete field'),
 83 |       '#autocomplete_route_name' => 'mymodule.autocomplete',
 84 |     );
 85 | 
 86 |     // Ajax elements.
 87 | 
 88 |     $form['ajax_output_1'] = array(
 89 |       '#type' => 'markup',
 90 |       '#markup' => '<div id="ajax-output-spot"></div>',
 91 |     );
 92 | 
 93 |     $form['text_trigger'] = array(
 94 |       '#type' => 'textfield',
 95 |       '#title' => $this->t('Type here to trigger Ajax'),
 96 |       '#ajax' => array(
 97 |         'event' => 'keyup',
 98 |         'wrapper' => 'ajax-output-spot',
 99 |         'callback' => 'Drupal\mymodule\Form\PersonalDataForm::ajaxTextCallback',
100 |       ),
101 |     );
102 | 
103 |     $form['ajax_output_2'] = array(
104 |       '#type' => 'markup',
105 |       '#markup' => '<div id="other-ajax-spot"></div>',
106 |     );
107 | 
108 |     $form['button_trigger'] = array(
109 |       '#type' => 'button',
110 |       '#value' => $this->t('Click here to trigger Ajax'),
111 |       '#ajax' => array(
112 |         'callback' => 'Drupal\mymodule\Form\PersonalDataForm::ajaxButtonCallback',
113 |       ),
114 |     );
115 | 
116 |     return $form;
117 |   }
118 | 
119 | 
120 |   /**
121 |    * Processes form submissions.
122 |    *
123 |    * From "Basic Form Generation and Processing in Drupal 8", chapter 4.
124 |    */
125 |   public function submitForm(array &$form, FormStateInterface $form_state) {
126 |     // Extract the values submitted by the user.
127 |     $values = $form_state->getValues();
128 |     $name = $values['first_name'];
129 |     // Values you stored in the form array are also available.
130 |     $info = $values['information'];
131 | 
132 |     // Get another value, using a method where it could be nested.
133 |     $parents = $form['company']['#array_parents'];
134 |     $company = NestedArray::getValue($values, $parents);
135 | 
136 |     // Processing code would go here. As a proxy, display a message with the
137 |     // values. Note that since the values are not sanitized, insert them
138 |     // into t() with @variable. If inserting into the database, do not
139 |     // sanitize.
140 |     if ($company) {
141 |       drupal_set_message($this->t('Thank you @name from @company', array('@name' => $name, '@company' => $company)));
142 |     }
143 |     else {
144 |       drupal_set_message($this->t('Thank you @name', array('@name' => $name)));
145 |     }
146 | 
147 |     // Make sure the form is rebuilt properly for Ajax.
148 |     $form_state->setRebuild();
149 |   }
150 | 
151 |   /**
152 |    * Processes the Ajax response for the text field.
153 |    *
154 |    * From "Wrapper-based Ajax Callback Functions", chapter 4.
155 |    */
156 |   public static function ajaxTextCallback(array $form, FormStateInterface $form_state) {
157 |     // Read the text from the text field.
158 |     $text = $form_state->getValues()['text_trigger'];
159 |     if (!$text) {
160 |       // This is a static function, so it cannot call $this->t().
161 |       $text = t('nothing');
162 |     }
163 | 
164 |     // Set a message.
165 |     drupal_set_message(t('You have triggered Ajax'));
166 | 
167 |     // Return a render array for markup to replace the wrapper <div> contents.
168 |     return array(
169 |       '#type' => 'markup',
170 |       // Text was not sanitized, so use @variable in t() to sanitize.
171 |       // Be sure to include the wrapper div!
172 |       '#markup' => '<div id="ajax-output-spot">' .
173 |       t('You typed @text', array('@text' => $text)) . '</div>',
174 |     );
175 |   }
176 | 
177 |   /**
178 |    * Processes the Ajax response for the button.
179 |    *
180 |    * From "Command-based Ajax Callback Functions in Drupal 8", chapter 4.
181 |    */
182 |   public static function ajaxButtonCallback(array $form, FormStateInterface $form_state) {
183 |     $response = new AjaxResponse();
184 | 
185 |     // Replace HTML markup inside the div via a selector.
186 |     $text = t('The button has been clicked');
187 |     $response->addCommand(
188 |       new HtmlCommand('div#other-ajax-spot', $text));
189 | 
190 |     // Add some CSS to the div.
191 |     $css = array('background-color' => '#ddffdd', 'color' => '#000000');
192 |     $response->addCommand(
193 |       new CssCommand('div#other-ajax-spot', $css));
194 | 
195 |     return $response;
196 |   }
197 | 
198 | }
199 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Plugin/Block/MyModuleFirstBlock.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Plugin\Block\MyModuleFirstBlock.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Plugin\Block;
 9 | 
10 | use Drupal\Core\Block\BlockBase;
11 | 
12 | /**
13 |  * Provides a sample block.
14 |  *
15 |  * From "Registering a Block in Drupal 8", chapter 4.
16 |  *
17 |  * @Block(
18 |  *   id = "mymodule_first_block",
19 |  *   admin_label = @Translation("First block from My Module"),
20 |  * )
21 |  */
22 | class MyModuleFirstBlock extends BlockBase {
23 | 
24 |   /**
25 |    * Returns the content of the block.
26 |    *
27 |    * Function body is from "Creating Render Arrays for Page and Block Output",
28 |    * chapter 4.
29 |    */
30 |   public function build() {
31 |     // Build a render array.
32 |     $output = array(
33 |       // Introductory paragraph, using the elemnt type 'markup'.
34 |       'introduction' => array(
35 |         '#type' => 'markup',
36 |         '#markup' => '<p>' . $this->t('General information goes here.') . '</p>',
37 |       ),
38 | 
39 |       // List of items, using the theme hook 'item_list'.
40 |       'colors' => array(
41 |         '#theme' => 'item_list',
42 |         '#items' => array($this->t('Red'), $this->t('Blue'), $this->t('Green')),
43 |         '#title' => $this->t('Colors'),
44 |       ),
45 | 
46 |       // Table, using the theme hook 'table'.
47 |       'materials' => array(
48 |         '#theme' => 'table',
49 |         '#caption' => $this->t('Materials'),
50 |         '#header' => array($this->t('Material'), $this->t('Characteristic')),
51 |         '#rows' => array(
52 |           array($this->t('Steel'), $this->t('Strong')),
53 |           array($this->t('Aluminum'), $this->t('Light')),
54 |         ),
55 |       ),
56 |     );
57 | 
58 |     return $output;
59 |   }
60 | }
61 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Plugin/Field/FieldFormatter/MyCustomText.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Plugin\Field\FieldFormatter\MyCustomText.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Plugin\Field\FieldFormatter;
 9 | 
10 | use Drupal\Core\Field\FormatterBase;
11 | use Drupal\Core\Field\FieldItemListInterface;
12 | 
13 | /**
14 |  * Custom text field formatter.
15 |  *
16 |  * From "Defining a field formatter in Drupal 8", chapter 4.
17 |  *
18 |  * @FieldFormatter(
19 |  *   id = "mymodule_myformatter",
20 |  *   label = @Translation("Custom text output"),
21 |  *   field_types = {
22 |  *     "string",
23 |  *   }
24 |  * )
25 |  */
26 | class MyCustomText extends FormatterBase {
27 | 
28 |   /**
29 |    * {@inheritdoc}
30 |    */
31 |   public function viewElements(FieldItemListInterface $items, $langcode) {
32 |     $output = array();
33 | 
34 |     foreach ($items as $delta => $item) {
35 |       // See which option was selected.
36 |       switch ($item->value) {
37 | 
38 |         case 'x_stored':
39 |           // Output the corresponding text or icon.
40 |           $output[$delta] = array('#markup' => '<p>' . $this->t('Predefined output text x') . '</p>');
41 |           break;
42 | 
43 |         case 'y_stored':
44 |           // Output the corresponding text or icon.
45 |           $output[$delta] = array('#markup' => '<p>' . $this->t('Predefined output text y') . '</p>');
46 |           break;
47 | 
48 |         // Handle other options here.
49 |       }
50 |     }
51 |     return $output;
52 |   }
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Plugin/Field/FieldWidget/MyCustomText.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Plugin\Field\FieldWidget\MyCustomText.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Plugin\Field\FieldWidget;
 9 | 
10 | use Drupal\Core\Field\WidgetBase;
11 | use Drupal\Core\Field\FieldItemListInterface;
12 | use Drupal\Core\Form\FormStateInterface;
13 | 
14 | /**
15 |  * Custom widget for choosing an option from a map.
16 |  *
17 |  * From "Defining a field widget in Drupal 8", chapter 4.
18 |  *
19 |  * @FieldWidget(
20 |  *   id = "mymodule_mywidget",
21 |  *   label = @Translation("Custom text input"),
22 |  *   field_types = {
23 |  *     "string"
24 |  *   }
25 |  * )
26 |  */
27 | class MyCustomText extends WidgetBase {
28 | 
29 |   /**
30 |    * {@inheritdoc}
31 |    */
32 |   public function formElement(FieldItemListInterface $items, $delta,
33 |     array $element, array &$form, FormStateInterface $form_state) {
34 | 
35 |     $value = isset($items[$delta]->value) ? $items[$delta]->value : NULL;
36 | 
37 |     // Set up the editing form element. Substitute your custom
38 |     // code here, instead of using an HTML select.
39 |     $element['value'] = $element + array(
40 |       '#type' => 'select',
41 |       '#options' => array(
42 |         'x_stored' => $this->t('x label'),
43 |         'y_stored' => $this->t('y label'),
44 |       ),
45 |       '#default_value' => $value,
46 |     );
47 | 
48 |     return $element;
49 |   }
50 | }
51 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Plugin/views/wizard/MyEntityViewsWizard.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Contains \Drupal\mymodule\Plugin\views\wizard\MyEntityViewsWizard.
 5 |  */
 6 | 
 7 | namespace Drupal\mymodule\Plugin\views\wizard;
 8 | 
 9 | use Drupal\Core\Form\FormStateInterface;
10 | use Drupal\views\Plugin\views\wizard\WizardPluginBase;
11 | 
12 | /**
13 |  * Provides a views wizard for My Entity entities.
14 |  *
15 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4.
16 |  *
17 |  * @ViewsWizard(
18 |  *   id = "myentity",
19 |  *   base_table = "myentity_field_data",
20 |  *   title = @Translation("My Entity")
21 |  * )
22 |  */
23 | class MyEntityViewsWizard extends WizardPluginBase {
24 | }
25 | 
26 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Routing/MyModuleRouting.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Routing\MyModuleRouting.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Routing;
 9 | 
10 | use Symfony\Component\Routing\Route;
11 | use Symfony\Component\Routing\RouteCollection;
12 | use Drupal\Core\Routing\RouteSubscriberBase;
13 | 
14 | /**
15 |  * Provides dynamic route and route alter.
16 |  *
17 |  * From "Event Subscribers in Drupal 8: Altering Routes and Providing
18 |  * Dynamic Routes" in Chapter 4.
19 |  */
20 | class MyModuleRouting extends RouteSubscriberBase {
21 |   /**
22 |    * {@inheritdoc}
23 |    */
24 |   protected function alterRoutes(RouteCollection $collection) {
25 |     // Alter the title of the People administration page (admin/people).
26 |     $route = $collection->get('entity.user.collection');
27 |     $route->setDefault('_title', 'User accounts');
28 |     // Make sure that the title text is translatable.
29 |     $foo = t('User accounts');
30 | 
31 |     // Add a dynamic route at admin/people/mymodule, which could have been
32 |     // a static route in this case.
33 |     $path = $route->getPath();
34 |     // Constructor parameters: path, defaults, requirements, as you would have
35 |     // in a routing.yml file.
36 |     $newroute = new Route($path . '/mymodule', array(
37 |         '_controller' => '\Drupal\mymodule\Controller\MyUrlController::generateMyPage',
38 |         '_title' => 'New page title',
39 |       ), array(
40 |         '_permission' => 'administer mymodule',
41 |       ));
42 |     // Make sure that the title text is translatable.
43 |     $foo = t('New page title');
44 |     $collection->add('mymodule.newroutename', $newroute);
45 |   }
46 | }
47 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/MyModuleEnableTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Tests\MyModuleEnableTest.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Tests;
 9 | 
10 | use Drupal\Core\Database\Database;
11 | 
12 | /**
13 |  * Tests module enable hooks and other basic functionality.
14 |  *
15 |  * @group Programmers Guide to Drupal
16 |  */
17 | class MyModuleEnableTest extends ProgrammersGuideTestBase {
18 | 
19 |   /**
20 |    * Modules to enable (the book's module).
21 |    *
22 |    * @var array
23 |    */
24 |   public static $modules = array('mymodule', 'node');
25 | 
26 |   /**
27 |    * Tests the schema hook.
28 |    *
29 |    * @see mymodule_schema()
30 |    */
31 |   function testSchemaHook() {
32 |     $connection = Database::getConnection();
33 | 
34 |     // Add some data to the table, and then retrieve it, to verify that
35 |     // the table was created.
36 |     $connection->insert('mymodule_foo')
37 |       ->fields(array('bar' => 'Hello', 'baz' => 2))
38 |       ->execute();
39 |     $result = $connection->query('SELECT * from {mymodule_foo}');
40 |     $count = 0;
41 |     foreach ($result as $record) {
42 |       $count++;
43 |       $this->outputVariable($record, 'Database record');
44 |       $this->assertEqual($record->bar, 'Hello', 'Field bar is correct');
45 |       $this->assertEqual($record->baz, 2, 'Field baz is correct');
46 |     }
47 |     $this->assertEqual($count, 1, 'Count of records is correct');
48 |   }
49 | 
50 |   /**
51 |    * Tests the permission hook.
52 |    *
53 |    * @see mymodule_permission()
54 |    */
55 |   function testPermission() {
56 |     $account_yes = $this->drupalCreateUser(array('administer mymodule'));
57 |     $account_no = $this->drupalCreateUser(array('access content'));
58 | 
59 |     $this->drupalLogin($account_yes);
60 |     $current = \Drupal::currentUser();
61 |     $this->assertTrue($current->hasPermission('administer mymodule'), 'First user has permission');
62 | 
63 |     $this->drupalLogin($account_no);
64 |     $current = \Drupal::currentUser();
65 |     $this->assertFalse($current->hasPermission('administer mymodule'), 'Second user does not have permission');
66 | 
67 |   }
68 | }
69 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/MyModuleEntityTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains \Drupal\mymodule\Tests\MyModuleEntityTest.
  6 |  */
  7 | 
  8 | namespace Drupal\mymodule\Tests;
  9 | 
 10 | /**
 11 |  * Tests entity and field code.
 12 |  *
 13 |  * @group Programmers Guide to Drupal
 14 |  */
 15 | class MyModuleEntityTest extends ProgrammersGuideTestBase {
 16 | 
 17 |   /**
 18 |    * Modules to enable (the book's module, plus Field UI and Text).
 19 |    *
 20 |    * @var array
 21 |    */
 22 |   public static $modules = array('mymodule', 'field', 'field_ui', 'text', 'filter', 'views', 'views_ui', 'block');
 23 | 
 24 |   protected function setUp() {
 25 |     parent::setUp();
 26 | 
 27 |     // Make sure local tasks, actions, and page title are showing.
 28 |     $this->drupalPlaceBlock('local_tasks_block');
 29 |     $this->drupalPlaceBlock('local_actions_block');
 30 |     $this->drupalPlaceBlock('page_title_block');
 31 |   }
 32 | 
 33 |   /**
 34 |    * Tests the defined entity type, field formatter, field widget, and views.
 35 |    *
 36 |    * @see \Drupal\mymodule\Entity\MyEntity
 37 |    * @see \Drupal\mymodule\Entity\MyEntitytype
 38 |    * @see \Drupal\mymodule\Plugin\Field\FieldFormatter\MyCustomText
 39 |    * @see \Drupal\mymodule\Plugin\Field\FieldWidget\MyCustomText
 40 |    */
 41 |   function testEntityAndField() {
 42 |     // Log in.
 43 |     $account = $this->drupalCreateUser(array('administer my entities', 'access administration pages', 'administer myentity fields', 'administer myentity form display', 'administer myentity display', 'administer views'));
 44 |     $this->drupalLogin($account);
 45 | 
 46 |     // Verify that the admin link is on the Structure page.
 47 |     $this->drupalGet('admin/structure');
 48 |     $this->assertLink('My entity subtypes', 0, 'Admin link is shown on Structure');
 49 |     $this->assertText('Manage my entity subtypes and their fields', 'Admin description is shown on Structure');
 50 | 
 51 |     // Create an entity sub-type/bundle.
 52 |     $this->clickLink('My entity subtypes');
 53 |     $this->assertTitleContains('My entity subtypes', 'Admin page title is correct');
 54 |     $this->clickLink('Add my entity subtype');
 55 |     $this->assertText('Machine-readable name', 'Machine name label is present');
 56 |     $this->assertText('Label', 'Label label is present');
 57 |     $this->assertText('Description', 'Description label is present');
 58 |     $this->assertText('Settings', 'Settings fieldset label is present');
 59 |     $this->assertText('Published by default', 'Published label is present');
 60 |     $this->drupalPostForm(NULL, array(
 61 |         'id' => 'test',
 62 |         'label' => 'My subtype',
 63 |         'description' => 'This is the description',
 64 |       ), t('Save'));
 65 |     $this->assertText('My subtype', 'Label is shown');
 66 |     $this->assertText('This is the description', 'Description is shown');
 67 | 
 68 |     // Add a text field.
 69 |     $this->clickLink('Manage fields');
 70 |     $this->assertLink('Edit', 0, 'Edit link is present');
 71 |     $this->assertLink('Manage form display', 0, 'Form link is present');
 72 |     $this->assertLink('Manage display', 0, 'Display link is present');
 73 | 
 74 |     $this->clickLink('Add field');
 75 |     $this->drupalPostForm(NULL, array(
 76 |         'new_storage_type' => 'string',
 77 |         'label' => 'The field label',
 78 |         'field_name' => 'abcdef',
 79 |       ), t('Save and continue'));
 80 |     $this->drupalPostForm(NULL, array(), t('Save field settings'));
 81 |     $this->drupalPostForm(NULL, array(
 82 |         'description' => 'Some kind of a description',
 83 |       ), t('Save settings'));
 84 | 
 85 |     // Set up the widget.
 86 |     $this->drupalPostForm('admin/structure/myentity_type/manage/test/form-display', array(
 87 |         'fields[field_abcdef][type]' => 'mymodule_mywidget',
 88 |       ), t('Save'));
 89 | 
 90 |     // Set up the formatter.
 91 |     $this->drupalPostForm('admin/structure/myentity_type/manage/test/display', array(
 92 |         'fields[field_abcdef][type]' => 'mymodule_myformatter',
 93 |       ), t('Save'));
 94 | 
 95 |     // Add an entity item.
 96 |     $this->drupalGet('admin/structure/myentity_type');
 97 |     $this->clickLink('Add new My Entity');
 98 |     $this->assertTitleContains('Add new my entity', 'Title is correct');
 99 |     $this->assertText('Title', 'Label for title field is present');
100 |     $this->assertText('The field label', 'Label for custom field is present');
101 |     $this->assertText('Some kind of a description', 'Description for custom field is present');
102 |     $this->assertRaw(t('x label'), 'X choice label is present from widget');
103 |     $this->assertRaw(t('y label'), 'Y choice label is present from widget');
104 |     $this->drupalPostForm(NULL, array(
105 |         'title[0][value]' => 'My title goes here',
106 |         'field_abcdef[0][value]' => 'x_stored',
107 |       ), t('Save'));
108 | 
109 |     // Test text/link on entity page.
110 |     $this->assertTitleContains('My title goes here', 'Entity object title is correct');
111 |     $this->assertText('Predefined output text x', 'Custom field is displayed with custom display');
112 |     $this->assertText(t('View'), 'View tab is there');
113 | 
114 |     // Edit the entity.
115 |     $this->clickLink(t('Edit'));
116 |     $this->assertTitleContains('Edit My title goes here', 'Title is correct');
117 |     $this->assertLink(t('Delete'), 0, 'Delete link is present');
118 |     $this->drupalPostForm(NULL, array(
119 |         'title[0][value]' => 'My new title',
120 |       ), t('Save'));
121 |     $this->assertTitleContains('My new title', 'Entity edited title is correct');
122 |     // At this point, test Views integration, by using the wizard.
123 |     $this->drupalGet('admin/structure/views/add');
124 |     $this->assertRaw('My Entity');
125 |     $this->drupalPostForm(NULL, array(
126 |         'show[wizard_key]' => 'myentity',
127 |         'label' => 'Foo Bar',
128 |         'id' => 'foo_bar',
129 |       ), t('Save and edit'));
130 |     // Do some reality checks to verify we created a view.
131 |     $this->assertText('Foo Bar');
132 |     $this->assertText('My entity');
133 |     $this->assertText('Master');
134 |     $this->assertText('Displays');
135 |     // Click the add fields link and verify that the field is available,
136 |     // as well as the default fields for this entity.
137 |     $this->drupalGet('admin/structure/views/nojs/add-handler/foo_bar/default/field');
138 |     $this->assertText('My entity');
139 |     $this->assertText('The field label');
140 |     $this->assertText('My entity ID');
141 |     $this->assertText('Subtype');
142 |     $this->assertNoText('Error: missing help');
143 | 
144 |     // Visit the page of the default view that is included in this module.
145 |     // Verify that this entity is listed.
146 |     $this->drupalGet('admin/my-entity-content');
147 |     $this->assertText('My Entity Content');
148 |     $this->assertLink('My new title');
149 |     $this->assertText('My subtype');
150 |     $this->assertLink('Edit');
151 |     $this->assertLink('Delete');
152 | 
153 |     // Add another entity item and delete it.
154 |     $this->drupalGet('admin/structure/myentity_type');
155 |     $this->clickLink('Add new My Entity');
156 |     $this->drupalPostForm(NULL, array(
157 |         'title[0][value]' => 'whatever',
158 |       ), t('Save'));
159 |     $this->drupalPostForm('myentity/2/delete', array(), t('Delete'));
160 |     $this->drupalget('myentity/2');
161 |     $this->assertResponse('404', 'After deleting, page does not exist');
162 | 
163 |     // Delete the entity subtype completely.
164 |     $this->drupalGet('admin/structure/myentity_type');
165 |     $this->clickLink('Delete');
166 |     $this->assertTitleContains('Are you sure you want to delete', 'Delete page title is correct');
167 |     $this->assertText('All entities of this type will also be deleted', 'Delete explanation is present');
168 |     $this->drupalPostForm(NULL, array(), t('Confirm'));
169 |     $this->assertTitleContains('My entity subtypes', 'Went back to the right page');
170 |     $this->assertNoText('This is the description', 'Entity subtype is gone');
171 |     $this->drupalGet('myentity/1');
172 |     $this->assertResponse('404', 'After deleting subtype, page does not exist');
173 | 
174 |   }
175 | }
176 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/MyModulePageTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains \Drupal\mymodule\Tests\MyModulePageTest.
  6 |  */
  7 | 
  8 | namespace Drupal\mymodule\Tests;
  9 | 
 10 | /**
 11 |  * Tests page output.
 12 |  *
 13 |  * @group Programmers Guide to Drupal
 14 |  */
 15 | class MyModulePageTest extends ProgrammersGuideTestBase {
 16 | 
 17 |   /**
 18 |    * Modules to enable (the book's module, plus User, Block, Node).
 19 |    *
 20 |    * @var array
 21 |    */
 22 |   public static $modules = array('mymodule', 'user', 'block', 'node');
 23 | 
 24 |   /**
 25 |    * Array of generated nodes.
 26 |    *
 27 |    * @var array
 28 |    */
 29 |   protected $nodes = array();
 30 | 
 31 |   function setUp() {
 32 |     parent::setUp();
 33 | 
 34 |     // Generate 15 random nodes. Ensure the created times are in order.
 35 |     for ($i = 0; $i < 15; $i++ ) {
 36 |       $start = REQUEST_TIME - 30;;
 37 |       $this->nodes[] = $this->drupalCreateNode(array(
 38 |           'changed' => $start + $i,
 39 |           'created' => $start + $i,
 40 |         ));
 41 |     }
 42 | 
 43 |     // Make sure local tasks and page title are showing.
 44 |     $this->drupalPlaceBlock('local_tasks_block');
 45 |     $this->drupalPlaceBlock('page_title_block');
 46 |   }
 47 | 
 48 |   /**
 49 |    * Tests the pages and blocks generated by the module.
 50 |    *
 51 |    * @see mymodule.routing.yml
 52 |    * @see mymodule.links.menu.yml
 53 |    * @see \Drupal\mymodule\Routing\MyModuleRouting
 54 |    * @see \Drupal\mymodule\Controller\MyUrlController
 55 |    * @see \Drupal\mymodule\Plugin\Block\MyModuleFirstBlock
 56 |    */
 57 |   function testPages() {
 58 |     $page_title = 'My page title';
 59 |     $dynamic_page_title = 'New page title';
 60 |     $block_title = 'This is a test';
 61 |     $text_in_block = array(
 62 |       'General information goes here',
 63 |       'Colors',
 64 |       'Blue',
 65 |       'Materials',
 66 |       'Characteristic',
 67 |       'Steel',
 68 |       'Light',
 69 |     );
 70 | 
 71 |     // Several pages should not allow anonymous access. Test this.
 72 |     $paths = array('mymodule/mypath', 'admin/people/mymodule', 'admin/content/mycontent/delete/5', 'mymodule/autocomplete');
 73 |     foreach ($paths as $path) {
 74 |       $this->drupalGet($path);
 75 |       $this->assertResponse('403', "Access is denied to $path while not logged in");
 76 |     }
 77 | 
 78 |     // Test the form while not logged in. It should be visible, but the
 79 |     // company field should not be visible.
 80 |     $this->drupalGet('mymodule/my_form_page');
 81 |     $this->assertTitleContains('Personal data form', 'Form page title is correct');
 82 |     $this->assertText('First name', 'Name field is shown');
 83 |     $this->assertNoText('Company', 'Company field is not shown to anonymous user');
 84 |     // Submit the form.
 85 |     $this->drupalPostForm(NULL, array('first_name' => 'Jennifer'), t('Submit'));
 86 |     $this->assertText('Thank you Jennifer', 'Submit message is shown');
 87 | 
 88 |     // Test alteration of the user register form.
 89 |     $this->drupalGet('user/register');
 90 |     $this->assertText('Company e-mail address', 'Email label has been altered');
 91 |     $this->drupalPostForm(NULL, array('name' => 'foo', 'mail' => 'test@example.com'), t('Create new account'));
 92 |     $this->assertText('You are not allowed to register', 'Validation message displayed');
 93 |     $this->assertNoText('Thank you for applying', 'Registration message not displayed');
 94 | 
 95 |     // Log in.
 96 |     $account = $this->drupalCreateUser(array('administer mymodule', 'access administration pages', 'administer users', 'use company field', 'delete mycontent items'));
 97 |     $this->drupalLogin($account);
 98 | 
 99 |     // Check title and text on page in mymodule.routing.yml file.
100 |     $this->drupalGet('mymodule/mypath');
101 |     $this->assertResponse('200', 'Access is allowed to page while logged in');
102 |     $this->assertTitleContains($page_title, 'Page title is shown');
103 |     for($i = 5; $i < 15; $i++) {
104 |       $this->assertText($this->nodes[$i]->label(), "Node title $i appears on the page");
105 |     }
106 |     for($i = 0; $i < 5; $i++) {
107 |       $this->assertNoText($this->nodes[$i]->label(), "Node title $i does not appear on the page");
108 |     }
109 | 
110 |     // Go to second page of paged output and test.
111 |     $this->drupalGet('mymodule/mypath', array('query' => array('page' => 1)));
112 |     $this->assertTitleContains($page_title, 'Page title is correct');
113 |     for($i = 5; $i < 15; $i++) {
114 |       $this->assertNoText($this->nodes[$i]->label(), "Node title $i does not appear on the page");
115 |     }
116 |     for($i = 0; $i < 5; $i++) {
117 |       $this->assertText($this->nodes[$i]->label(), "Node title $i appears on the page");
118 |     }
119 | 
120 |     // Verify that the link from mymodule.links.menu.yml works.
121 |     $this->drupalGet('admin/structure');
122 |     $this->assertLink('Configure My Module', 0, 'Link is present on admin/structure');
123 |     $this->assertText('Longer description goes here', 'Description is present on admin/structure');
124 |     $this->clickLink('Configure My Module');
125 |     $this->assertTitleContains($page_title, 'Link click went to the right page');
126 |     for($i = 5; $i < 15; $i++) {
127 |       $this->assertText($this->nodes[$i]->label(), "Node title $i appears on the page");
128 |     }
129 |     for($i = 0; $i < 5; $i++) {
130 |       $this->assertNoText($this->nodes[$i]->label(), "Node title $i does not appear on the page");
131 |     }
132 | 
133 |     // Check the MyModuleRouting class.
134 |     // Normally the page title on admin/people is "People", but it's been
135 |     // altered to be "User accounts".
136 |     $this->drupalGet('admin/people');
137 |     $this->assertTitleContains('User accounts', 'Title was altered');
138 |     // Test the dynamic route.
139 |     $this->drupalGet('admin/people/mymodule');
140 |     $this->assertTitleContains($dynamic_page_title, 'admin/people/mymodule has right title');
141 |     for($i = 5; $i < 15; $i++) {
142 |       $this->assertText($this->nodes[$i]->label(), "Node title $i appears on the page");
143 |     }
144 |     for($i = 0; $i < 5; $i++) {
145 |       $this->assertNoText($this->nodes[$i]->label(), "Node title $i does not appear on the page");
146 |     }
147 | 
148 |     // Place the block and test it.
149 |     $this->drupalPlaceBlock('mymodule_first_block', array(
150 |         'region' => 'content',
151 |         'label' => $block_title,
152 |       ));
153 |     $this->drupalGet('user');
154 |     $this->assertText($block_title, 'Block title is shown on page');
155 |     foreach ($text_in_block as $text) {
156 |       $this->assertText($text, "Text $text appears on the page");
157 |     }
158 | 
159 |     // Test the form.
160 |     $this->drupalGet('mymodule/my_form_page');
161 |     $this->assertTitleContains('Personal data form', 'Form page title is correct');
162 |     $this->assertText('First name', 'Name field is shown');
163 |     $this->assertText('Company', 'Company field is shown to user with permission');
164 |     // Submit the form.
165 |     $this->drupalPostForm(NULL, array('first_name' => 'Jennifer', 'company' => 'Poplar'), t('Submit'));
166 |     $this->assertText('Thank you Jennifer from Poplar', 'Submit message is shown');
167 |     // Test that JavaScript information is included.
168 |     $this->assertRaw('mymodule.js', 'JavaScript file is referenced');
169 | 
170 |     // Test the confirm delete form.
171 |     $this->drupalGet('admin/content/mycontent/delete/5');
172 |     $this->assertText('Are you sure you want to delete content item 5?', 'Question is on the confirm form page');
173 |     // Try the cancel link. Should go to mymodule/mypath.
174 |     $this->clickLink(t('Cancel'));
175 |     $this->assertTitleContains($page_title, 'Cancel went to right place');
176 |     // Try submitting the form. Should go to mymodule/my_form_page.
177 |     $this->drupalPostForm('admin/content/mycontent/delete/5', array(), t('Confirm'));
178 |     $this->assertTitleContains('Personal data form', 'Form submit redirected to right place');
179 |     $this->assertText('Would have deleted 5', 'Submit message is displayed');
180 | 
181 |     // Test the autocomplete path.
182 |     $this->drupalGet('mymodule/autocomplete', array('query' => array('q' => 'test')));
183 |     $additions = array('add', 'choice', 'more', 'plus', 'something');
184 |     foreach ($additions as $word) {
185 |       $this->assertText('test' . $word, "Autocomplete choice for $word is in the output");
186 |     }
187 | 
188 |   }
189 | }
190 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/MyModuleSnippetsTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains \Drupal\mymodule\Tests\MyModuleSnippetsTest.
  6 |  */
  7 | 
  8 | namespace Drupal\mymodule\Tests;
  9 | 
 10 | use Drupal;
 11 | use Drupal\Core\Cache\CacheBackendInterface;
 12 | use Drupal\Core\Cache\Cache;
 13 | use Drupal\Core\Database\Database;
 14 | use Drupal\Core\StringTranslation\TranslatableMarkup;
 15 | use Drupal\Core\Url;
 16 | 
 17 | /**
 18 |  * Tests various code snippets from the book.
 19 |  *
 20 |  * @group Programmers Guide to Drupal
 21 |  */
 22 | class MyModuleSnippetsTest extends ProgrammersGuideTestBase {
 23 | 
 24 |   /**
 25 |    * Modules to enable (the book's module).
 26 |    *
 27 |    * @var array
 28 |    */
 29 |   public static $modules = array('mymodule', 'block', 'node', 'field', 'filter');
 30 | 
 31 |   function setUp() {
 32 |     parent::setUp();
 33 |   }
 34 | 
 35 |   /**
 36 |    * Tests various code snippets.
 37 |    */
 38 |   function testSnippets() {
 39 |     $container = \Drupal::getContainer();
 40 | 
 41 |     // Cache snippets from section "The Drupal Cache" in Chapter 1.
 42 | 
 43 |     // Make up some test data.
 44 |     $bin = 'default';
 45 |     $cid = 'my_cid';
 46 |     $data = 'my_data';
 47 |     $nid = 5;
 48 |     $tags = array('node:' . $nid);
 49 | 
 50 |     // Cache the data. Get the class in two different ways.
 51 |     $cache_class = \Drupal::cache($bin);
 52 |     $this->assertTrue($cache_class, 'Cache class is not null');
 53 |     $cache_class = $container->get('cache.' . $bin);
 54 | 
 55 |     $cache_class->set($cid, $data, CacheBackendInterface::CACHE_PERMANENT, $tags);
 56 | 
 57 |     // Check that we can retrieve data from the cache.
 58 |     $out = $cache_class->get($cid);
 59 |     $this->outputVariable($out, 'Cache get method output');
 60 |     $this->assertEqual($data, $out->data, 'Cached data could be retrieved');
 61 | 
 62 |     // Invalidate the data and check that it cannot be retrieved.
 63 |     Cache::invalidateTags($tags);
 64 |     $out = $cache_class->get($cid);
 65 |     $this->assertFalse($out, 'After invalidating tags, cached data cannot be retrieved');
 66 | 
 67 |     // Theme snippets from section "Making Your Output Themeable" in Chapter 2.
 68 | 
 69 |     $build['hello'] = array(
 70 |       '#input1' => t('Hello World!'),
 71 |       '#theme' => 'mymodule_hookname',
 72 |     );
 73 |     // This call to drupal_render_root() is just for testing purposes (to
 74 |     // verify that the theme snippet works). Calling this function directly is
 75 |     // definitely not recommended!
 76 |     $output = drupal_render_root($build);
 77 |     $expected = '<div>Hello World!</div>';
 78 |     $this->outputHTML($output, 'Theme template output');
 79 |     $this->assertEqual(trim($output), $expected, 'Theme template worked in render array');
 80 | 
 81 |     // Config API snippets from "Configuration API in Drupal 8" section in
 82 |     // chapter 2.
 83 | 
 84 |     // Test reading the settings several different ways.
 85 | 
 86 |     $config = \Drupal::config('mymodule.settings');
 87 |     $this->assertTrue($config, 'Config class is not null');
 88 |     $config = $container->get('config.factory')->getEditable('mymodule.settings');
 89 | 
 90 |     $all = $config->get();
 91 |     $this->outputVariable($all, 'Full configuration output');
 92 | 
 93 |     $button_label = $all['submit_button_label'];
 94 |     $this->assertEqual($button_label, 'Submit', 'Read correct button label from overall get');
 95 | 
 96 |     $button_label = $config->get('submit_button_label');
 97 |     $this->assertEqual($button_label, 'Submit', 'Read correct button label with specific get');
 98 | 
 99 |     $name_field_info = $all['name_field_settings'];
100 |     $name_label = $name_field_info['field_label'];
101 |     $this->assertEqual($name_label, 'Your name', 'Read correct name field label from overall get');
102 | 
103 |     $name_field_info = $config->get('name_field_settings');
104 |     $this->outputVariable($name_field_info, 'Name field configuration output');
105 |     $name_label = $name_field_info['field_label'];
106 |     $this->assertEqual($name_label, 'Your name', 'Read correct name field label from field settings get');
107 | 
108 |     $name_label = $config->get('name_field_settings.field_label');
109 |     $this->assertEqual($name_label, 'Your name', 'Read correct name field label from specific get');
110 | 
111 |     // Change the submit label.
112 |     $new_label = "Save";
113 |     $config->set('submit_button_label', $new_label);
114 |     $config->save();
115 | 
116 |     // Get a new config object, to make sure it was really saved.
117 |     $new_config = \Drupal::config('mymodule.settings');
118 |     $button_label = $new_config->get('submit_button_label');
119 |     $this->assertEqual($button_label, 'Save', 'Read correct button label after save');
120 | 
121 |     // State API snippets from "State API in Drupal 8" section in chapter 2.
122 | 
123 |     // Get $state in two ways.
124 |     $state = \Drupal::state();
125 |     $this->assertTrue($state, 'State is not null');
126 |     $state = $container->get('state');
127 | 
128 |     $value = 'Some test data';
129 |     $state->set('mymodule.my_state_variable_name', $value);
130 |     $new_value = $state->get('mymodule.my_state_variable_name');
131 |     $this->assertEqual($value, $new_value, 'State get worked correctly');
132 | 
133 |     $state->delete('mymodule.my_state_variable_name');
134 |     $new_value = $state->get('mymodule.my_state_variable_name');
135 |     $this->assertNull($new_value, 'After delete, could not retrieve state value');
136 | 
137 |     // Snippets from "Internationalizing User Interface Text" section in
138 |     // chapter 2. Good code only; bad code examples are omitted.
139 |     $button_text = t('Save');
140 |     $this->assertEqual($button_text, 'Save', 't() worked OK on simple string');
141 |     // Use the TranslatableMarkup class.
142 |     $button_text = new TranslatableMarkup('Save');
143 |     $this->assertEqual((string) $button_text, 'Save', 'TranslatableMarkup class worked OK on simple string');
144 | 
145 |     $user_name = 'foo';
146 |     $message_string = t('Hello @user_name', array('@user_name' => $user_name));
147 |     $this->outputHTML($message_string, 't() with variables output');
148 |     $this->assertEqual($message_string, 'Hello foo', 't() worked OK on string with variable');
149 | 
150 |     $test = (object) array();
151 |     $foo = ($test instanceof MyClass);
152 | 
153 |     // Database snippets from "Querying the Database with the Database API"
154 |     // section in Chapter 2.
155 | 
156 |     // Make a blocked user for querying purposes.
157 |     $account = $this->drupalCreateUser(array());
158 |     $account->status = 0;
159 |     $account->save();
160 | 
161 |     // Query by status 0 (blocked).
162 |     $desired_status = 0;
163 |     $found = FALSE;
164 |     $connection = Database::getConnection();
165 |     $result = $connection->query('SELECT * FROM {users_field_data} u WHERE u.status = :status',
166 |       array(':status' => $desired_status));
167 |     foreach ($result as $record) {
168 |       $this->outputVariable($record, 'User database record');
169 |       if ($record->uid == $account->id()) {
170 |         $found = TRUE;
171 |       }
172 |     }
173 |     $this->assertTrue($found, 'Created user was found by status query');
174 | 
175 |     // Test the ability to query by user name.
176 |     $found = FALSE;
177 |     $result = $connection->query('SELECT * FROM {users_field_data} u WHERE u.name = :name',
178 |       array(':name' => $account->getUsername()));
179 |     foreach ($result as $record) {
180 |       if ($record->uid == $account->id()) {
181 |         $found = TRUE;
182 |       }
183 |     }
184 |     $this->assertTrue($found, 'Created user was found by name query');
185 | 
186 |     // Create a node, for query purposes.
187 |     $newnode = $this->drupalCreateNode();
188 |     // Log in as user who can access content.
189 |     $account = $this->drupalCreateUser(array('access content'));
190 |     $this->drupalLogin($account);
191 | 
192 |     $query = $connection->select('node', 'n');
193 |     $query->innerJoin('node_field_data', 'nd', 'n.nid = nd.nid AND n.vid = nd.vid');
194 |     $query->innerJoin('users_field_data', 'u', 'u.uid = nd.uid');
195 |     $query->addField('nd', 'changed', 'last_updated');
196 |     $query
197 |       ->extend('Drupal\Core\Database\Query\PagerSelectExtender')
198 |       ->limit(20)
199 |       ->fields('nd', array('title', 'nid'))
200 |       ->fields('u', array('name'))
201 |       ->addTag('node_access')
202 |       ->condition('nd.status', 1);
203 |     $result = $query->execute();
204 |     $found = FALSE;
205 |     foreach ($result as $node) {
206 |       $title = $node->title;
207 |       if ($node->nid == $newnode->id()) {
208 |         $found = TRUE;
209 |         $this->verbose("Found node with title $title");
210 |       }
211 |     }
212 |     $this->assertTrue($found, "Found node in query");
213 | 
214 |     // Snippets from the "Cleansing and Checking User-Provided Input"
215 |     // section in Chapter 2. Only "good" code is included.
216 | 
217 |     $text = '<h2>Text with HTML</h2>';
218 |     $plain_text = htmlentities($text);
219 |     $url = 'http://example.com';
220 | 
221 |     $url_object = Url::fromUri($url);
222 |     $output = Drupal::l($text, $url_object);
223 |     $this->outputHTML($output, 'l() output');
224 |     $this->assertEqual($output, '<a href="' . $url . '">' . $plain_text . '</a>', 'l output is as expected');
225 | 
226 |     // Form builder snippet from "Basic Form Generation and Processing in
227 |     // Drupal 8", chapter 4.
228 |     $my_render_array['personal_data_form'] =
229 |       \Drupal::formBuilder()->getForm('Drupal\mymodule\Form\PersonalDataForm');
230 |     $this->outputVariable($my_render_array, 'Personal data form array');
231 |     $this->assertTrue(isset($my_render_array['personal_data_form']['first_name']), 'First name field is present in form array');
232 | 
233 |     $builder = $container->get('form_builder');
234 |     $my_render_array['personal_data_form'] =
235 |       $builder->getForm('Drupal\mymodule\Form\PersonalDataForm');
236 |     $this->assertTrue(isset($my_render_array['personal_data_form']['first_name']), 'First name field is present in form array');
237 | 
238 |     // Entity query snippets from "Querying and Loading Entities in Drupal 8",
239 |     // chapter 4.
240 | 
241 |     // Try various methods for retrieving the query.
242 |     $query = \Drupal::entityQuery('node');
243 |     $this->assertTrue($query, 'Query is not null');
244 |     $query = \Drupal::entityQueryAggregate('node');
245 |     $this->assertTrue($query, 'Query is not null');
246 | 
247 |     $query_service = $container->get('entity.query');
248 |     $query = $query_service->getAggregate('node');
249 |     $this->assertTrue($query, 'Query is not null');
250 | 
251 |     // Try an actual query.
252 |     $query = $query_service->get('node');
253 |     $query->condition('type', $newnode->getType());
254 |     $ids = $query->execute();
255 | 
256 |     // Try different methods of getting storage manager.
257 |     $storage = \Drupal::entityTypeManager()->getStorage('node');
258 |     $this->assertTrue($storage, 'Storage is not null');
259 | 
260 |     // Load the entities and verify.
261 |     $storage = $container->get('entity_type.manager')->getStorage('node');
262 |     $entities = $storage->loadMultiple($ids);
263 |     $this->assertEqual(count($entities), 1, 'One node was found');
264 |     $first = reset($entities);
265 |     $this->assertEqual($first->getTitle(), $newnode->getTitle(), 'Correct node was found');
266 |   }
267 | 
268 |   /**
269 |    * Tests that classes, interfaces, functions, etc. still exist.
270 |    *
271 |    * At the time of the first release of this book, Drupal 8 was still in
272 |    * flux. This tests for the existence of Drupal 8 classes, interfaces,
273 |    * functions, etc. mentioned in the book. If their names change or they
274 |    * vanish, this test will fail and the book can be corrected.
275 |    */
276 |   function testExistence() {
277 |     $interfaces = array(
278 |       '\Drupal\Core\Ajax\CommandInterface',
279 |       '\Drupal\Core\Block\BlockPluginInterface',
280 |       '\Drupal\Core\Cache\CacheBackendInterface',
281 |       '\Drupal\Core\Config\Entity\ConfigEntityInterface',
282 |       '\Drupal\Core\Config\ConfigFactoryInterface',
283 |       '\Drupal\Core\Datetime\DateFormatInterface',
284 |       '\Drupal\Core\DependencyInjection\ServiceModifierInterface',
285 |       '\Drupal\Core\Entity\ContentEntityInterface',
286 |       '\Drupal\Core\Entity\EntityInterface',
287 |       '\Drupal\Core\Entity\EntityTypeManagerInterface',
288 |       '\Drupal\Core\Entity\EntityStorageInterface',
289 |       '\Drupal\Core\Entity\EntityTypeInterface',
290 |       '\Drupal\Core\Entity\Query\QueryInterface',
291 |       '\Drupal\Core\Entity\Query\QueryAggregateInterface',
292 |       '\Drupal\Core\Entity\Routing\EntityRouteProviderInterface',
293 |       '\Drupal\Core\Extension\ModuleHandlerInterface',
294 |       '\Drupal\Core\Field\FieldItemInterface',
295 |       '\Drupal\Core\Field\FieldItemListInterface',
296 |       '\Drupal\Core\Field\FormatterInterface',
297 |       '\Drupal\Core\Field\WidgetInterface',
298 |       '\Drupal\Core\Form\FormStateInterface',
299 |       '\Drupal\Core\Language\LanguageInterface',
300 |       '\Drupal\Core\Render\Element\FormElementInterface',
301 |       '\Drupal\Core\Render\Element\ElementInterface',
302 |       '\Drupal\Core\Routing\RouteMatchInterface',
303 |       '\Drupal\Core\Session\AccountInterface',
304 |       '\Drupal\Core\Session\AccountProxyInterface',
305 |       '\Drupal\Core\State\StateInterface',
306 |       '\Symfony\Component\DependencyInjection\ContainerInterface',
307 |       '\Symfony\Component\EventDispatcher\EventSubscriberInterface',
308 |     );
309 |     foreach ($interfaces as $interface) {
310 |       $this->assertTrue(interface_exists($interface), "Interface $interface exists");
311 |       $file = $this->classToFile($interface);
312 |       if ($file) {
313 |         $this->assertNoDeprecated($file);
314 |       }
315 |     }
316 | 
317 |     $classes = array(
318 |       '\Drupal',
319 |       '\Drupal\Component\Datetime\DateTimePlus',
320 |       '\Drupal\Component\Utility\Html',
321 |       '\Drupal\Component\Utility\Unicode',
322 |       '\Drupal\Core\Access\AccessResult',
323 |       '\Drupal\Core\Ajax\AjaxResponse',
324 |       '\Drupal\Core\Annotation\Translation',
325 |       '\Drupal\Core\Block\Annotation\Block',
326 |       '\Drupal\Core\Block\BlockBase',
327 |       '\Drupal\Core\Block\BlockManager',
328 |       '\Drupal\Core\Cache\Cache',
329 |       '\Drupal\Core\Config\Config',
330 |       '\Drupal\Core\DependencyInjection\ContainerBuilder',
331 |       '\Drupal\Core\Entity\Annotation\ConfigEntityType',
332 |       '\Drupal\Core\Entity\EntityForm',
333 |       '\Drupal\Core\Config\Entity\ConfigEntityBase',
334 |       '\Drupal\Core\Config\Entity\ConfigEntityListBuilder',
335 |       '\Drupal\Core\Controller\ControllerBase',
336 |       '\Drupal\Core\Database\Connection',
337 |       '\Drupal\Core\Database\Database',
338 |       '\Drupal\Core\Database\Query\PagerSelectExtender',
339 |       '\Drupal\Core\Database\Schema',
340 |       '\Drupal\Core\Datetime\Entity\DateFormat',
341 |       '\Drupal\Core\DrupalKernel',
342 |       '\Drupal\Core\Entity\Annotation\ContentEntityType',
343 |       '\Drupal\Core\Entity\ContentEntityBase',
344 |       '\Drupal\Core\Entity\ContentEntityConfirmFormBase',
345 |       '\Drupal\Core\Entity\ContentEntityForm',
346 |       '\Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider',
347 |       '\Drupal\Core\Entity\Routing\AdminHtmlRouteProvider',
348 |       '\Drupal\Core\Field\FieldItemBase',
349 |       '\Drupal\Core\Field\FormatterBase',
350 |       '\Drupal\Core\Field\WidgetBase',
351 |       '\Drupal\Core\Field\Annotation\FieldType',
352 |       '\Drupal\Core\Field\Annotation\FieldFormatter',
353 |       '\Drupal\Core\Field\Annotation\FieldWidget',
354 |       '\Drupal\Core\Form\ConfigFormBase',
355 |       '\Drupal\Core\Form\FormBase',
356 |       '\Drupal\Core\Language\Language',
357 |       '\Drupal\Core\Link',
358 |       '\Drupal\Core\Path\AliasManager',
359 |       '\Drupal\Core\Plugin\DefaultPluginManager',
360 |       '\Drupal\Core\Render\Annotation\FormElement',
361 |       '\Drupal\Core\Render\Annotation\RenderElement',
362 |       '\Drupal\Core\Render\Element',
363 |       '\Drupal\Core\Routing\RouteSubscriberBase',
364 |       '\Drupal\Core\Site\Settings',
365 |       '\Drupal\Core\StringTranslation\TranslatableMarkup',
366 |       '\Drupal\Core\Url',
367 |       '\Drupal\KernelTests\KernelTestBase',
368 |       '\Drupal\Tests\UnitTestCase',
369 |       '\Drupal\block_content\Plugin\Block\BlockContentBlock',
370 |       '\Drupal\field\Entity\FieldStorageConfig',
371 |       '\Drupal\language\Entity\ConfigurableLanguage',
372 |       '\Drupal\migrate\MigrateExecutable',
373 |       '\Drupal\node\Form\NodeTypeDeleteConfirm',
374 |       '\Drupal\node\Entity\NodeRouteProvider',
375 |       '\Drupal\node\Entity\Node',
376 |       '\Drupal\simpletest\WebTestBase',
377 |       '\Drupal\system\DateFormatListBuilder',
378 |       '\Drupal\system\Form\DateFormatEditForm',
379 |       '\Drupal\system\Form\DateFormatDeleteForm',
380 |       '\Drupal\block\Controller\CategoryAutocompleteController',
381 |       '\Drupal\views\Plugin\views\field\FieldPluginBase',
382 |       '\Drupal\views\Annotation\ViewsArgument',
383 |       '\Drupal\views\Annotation\ViewsField',
384 |       '\Drupal\views\Annotation\ViewsRow',
385 |       '\Drupal\views\Annotation\ViewsStyle',
386 |       '\Drupal\views\Plugin\views\field\FieldPluginBase',
387 |       '\Drupal\views\Plugin\views\row\RowPluginBase',
388 |       '\Drupal\views\Plugin\views\style\StylePluginBase',
389 |       '\Drupal\views\Views',
390 |       '\Symfony\Component\DependencyInjection\Container',
391 |       '\Symfony\Component\EventDispatcher\Event',
392 |       '\Symfony\Component\HttpFoundation\Request',
393 |       '\Symfony\Component\HttpFoundation\Response',
394 |       '\Symfony\Component\HttpKernel\HttpKernel',
395 |       '\Symfony\Component\Routing\Route',
396 |       '\Symfony\Component\Routing\RouteCollection',
397 |     );
398 |     foreach ($classes as $class) {
399 |       $this->assertTrue(class_exists($class), "Class $class exists");
400 |       $file = $this->classToFile($class);
401 |       if ($file) {
402 |         $this->assertNoDeprecated($file);
403 |       }
404 |     }
405 | 
406 |     $traits = array(
407 |       '\Drupal\Core\StringTranslation\StringTranslationTrait',
408 |     );
409 |     foreach ($traits as $trait) {
410 |       $this->assertTrue(trait_exists($trait), "Trait $trait exists");
411 |       $file = $this->classToFile($trait);
412 |       if ($file) {
413 |         $this->assertNoDeprecated($file);
414 |       }
415 |     }
416 | 
417 |     $methods = array(
418 |       '\Drupal' => array('config', 'currentUser', 'formBuilder',
419 |         'getContainer', 'service'),
420 |       '\Drupal\Core\Ajax\AjaxResponse' => 'addCommand',
421 |       '\Drupal\Core\Block\BlockBase' => array('access', 'build'),
422 |       '\Drupal\Core\Block\BlockManager' => array('clearCachedDefinitions', 'getSortedDefinitions'),
423 |       '\Drupal\Core\Cache\CacheBackendInterface' => array('get',
424 |         'invalidate',
425 |         'set'),
426 |       '\Drupal\Core\Config\Config' => array('get', 'save', 'set'),
427 |       '\Drupal\Core\Database\Database' => 'getConnection',
428 |       '\Drupal\Core\Database\Connection' => array('select', 'query'),
429 |       '\Drupal\Core\DependencyInjection\ServiceModifierInterface' => 'alter',
430 |       '\Drupal\Core\DrupalKernel' => array('discoverServiceProviders', 'handle', 'preHandle'),
431 |       '\Drupal\Core\Entity\ContentEntityForm' => array(
432 |         'buildEntity',
433 |         'form',
434 |         'save',
435 |         'validateForm',
436 |       ),
437 |       '\Drupal\Core\Entity\ContentEntityInterface' => 'baseFieldDefinitions',
438 |       '\Drupal\Core\Entity\Entity' => 'access',
439 |       '\Drupal\Core\Entity\EntityForm' => array(
440 |         'form',
441 |         'save',
442 |         'validateForm',
443 |       ),
444 |       '\Drupal\Core\Entity\Query\QueryInterface' => 'condition',
445 |       '\Drupal\Core\Field\FieldItemInterface' => array(
446 |         'propertyDefinitions',
447 |         'schema',
448 |       ),
449 |       '\Drupal\Core\Field\FormatterInterface' => 'viewElements',
450 |       '\Drupal\Core\Field\WidgetInterface' => 'formElement',
451 |       '\Drupal\Core\Form\FormBase' => 't',
452 |       '\Drupal\Core\Form\FormBuilderInterface' => 'getForm',
453 |       '\Drupal\Core\Form\FormStateInterface' => array(
454 |         'get',
455 |         'getValues',
456 |         'set',
457 |         'setErrorByName',
458 |         'setRebuild',
459 |       ),
460 |       '\Drupal\Core\Link' => 'fromTextAndUrl',
461 |       '\Drupal\Core\Render\Element\ElementInterface' => 'getInfo',
462 |       '\Drupal\Core\Session\AccountProxyInterface' => 'hasPermission',
463 |       '\Drupal\block\BlockListBuilder' => array('buildForm', 'createInstance'),
464 |       '\Drupal\block\BlockViewBuilder' => 'viewMultiple',
465 |       '\Drupal\block\Controller\CategoryAutocompleteController' => 'autocomplete',
466 |       '\Symfony\Component\DependencyInjection\ContainerInterface' => 'get',
467 |       '\Symfony\Component\EventDispatcher\EventDispatcherInterface' => 'dispatch',
468 |       '\Symfony\Component\EventDispatcher\EventSubscriberInterface' => 'getSubscribedEvents',
469 |       '\Symfony\Component\HttpFoundation\Response' => 'send',
470 |       '\Symfony\Component\HttpKernel\HttpKernel' => 'handle',
471 | 
472 |     );
473 |     foreach ($methods as $class => $methods) {
474 |       if (!is_array($methods)) {
475 |         $methods = array($methods);
476 |       }
477 |       foreach ($methods as $method) {
478 |         $this->assertTrue(method_exists($class, $method), "Method $class::$method exists");
479 |       }
480 |       $file = $this->classToFile($class);
481 |       if ($file) {
482 |         $this->assertNoDeprecated($file);
483 |       }
484 |     }
485 | 
486 |     $functions = array(
487 |       'drupal_flush_all_caches',
488 |       't',
489 |     );
490 |     foreach ($functions as $function) {
491 |       $this->assertTrue(function_exists($function), "Function $function() exists");
492 |     }
493 | 
494 |     $services = array(
495 |       'cache.default',
496 |       'current_user',
497 |       'database',
498 |       'entity.query',
499 |       'entity.manager',
500 |       'event_dispatcher',
501 |       'path.alias_manager',
502 |       'plugin.manager.block',
503 |       'string_translation',
504 |     );
505 |     foreach ($services as $service) {
506 |       $this->assertTrue(\Drupal::hasService($service), "Service $service exists");
507 |     }
508 | 
509 |     $files = array(
510 |       'core/config/schema/core.data_types.schema.yml',
511 |       'core/core.services.yml',
512 |       'core/includes/database.inc',
513 |       'core/includes/bootstrap.inc',
514 |       'core/lib/Drupal/Component/Datetime/DateTimePlus.php',
515 |       'core/lib/Drupal/Core/Ajax',
516 |       'core/modules',
517 |       'core/modules/block/block.services.yml',
518 |       'core/modules/block/block.routing.yml',
519 |       'core/modules/block/block.links.contextual.yml',
520 |       'core/modules/filter/filter.permissions.yml',
521 |       'core/modules/filter/src/FilterPermissions.php',
522 |       'core/modules/system/system.routing.yml',
523 |       'core/modules/system/config/schema/system.schema.yml',
524 |       'core/modules/taxonomy/taxonomy.routing.yml',
525 |       'core/modules/user/user.routing.yml',
526 |       'core/modules/user/user.links.action.yml',
527 |       'core/modules/user/user.links.task.yml',
528 |       'core/modules/views/src/Plugin/views',
529 |       'core/modules/views/src/Plugin/views/argument',
530 |       'core/modules/views/src/Plugin/views/field',
531 |       'core/modules/views/src/Plugin/views/row',
532 |       'core/modules/views/src/Plugin/views/style',
533 |       'vendor/symfony/dependency-injection/Container.php',
534 |     );
535 | 
536 |     foreach ($files as $file) {
537 |       $this->assertTrue(file_exists(DRUPAL_ROOT . '/' . $file), "File $file exists");
538 |     }
539 |   }
540 | 
541 |   /**
542 |    * Asserts that a file does not include the deprecated tag anywhere.
543 |    */
544 |   function assertNoDeprecated($file) {
545 |     $text = file_get_contents($file);
546 |     $this->assertFalse(strpos($text, '@deprecated'), $file . ' does not contain @deprecated anywhere');
547 |   }
548 | 
549 |   /**
550 |    * Converts a namespaced class name to a file name.
551 |    *
552 |    * @param string $class
553 |    *   Name of a class to find the filename of.
554 |    *
555 |    * @return string
556 |    *   File name of the class, or '' if it cannot be determined. This is
557 |    *   a heuristic, so it may not work for all files, and in particular,
558 |    *   it doesn't work for vendor files.
559 |    */
560 |   function classToFile($class) {
561 |     $parts = explode('\\', trim($class, '\\'));
562 |     if ($parts[0] != 'Drupal') {
563 |       return '';
564 |     }
565 |     if (count($parts) == 1) {
566 |       return DRUPAL_ROOT . '/core/lib/Drupal.php';
567 |     }
568 |     if ($parts[1] == 'Core' || $parts[1] == 'Component') {
569 |       return DRUPAL_ROOT . '/core/lib/' . implode('/', $parts) . '.php';
570 |     }
571 |     if ($parts[1] == 'Tests' || $parts[1] == 'KernelTests') {
572 |       return DRUPAL_ROOT . '/core/tests/' . implode('/', $parts) . '.php';
573 |     }
574 |     array_shift($parts);
575 |     $module = array_shift($parts);
576 |     return DRUPAL_ROOT . '/core/modules/' . $module . '/src/' . implode('/', $parts) . '.php';
577 |   }
578 | }
579 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/MyThemeTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Tests\MyThemeTest.
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Tests;
 9 | 
10 | use Drupal;
11 | 
12 | /**
13 |  * Tests the theme code.
14 |  *
15 |  * @group Programmers Guide to Drupal
16 |  */
17 | class MyThemeTest extends ProgrammersGuideTestBase {
18 | 
19 |   /**
20 |    * Modules to enable (Block).
21 |    *
22 |    * @var array
23 |    */
24 |   public static $modules = array('block');
25 | 
26 |   function setUp() {
27 |     parent::setUp();
28 | 
29 |     // Switch to the book's theme.
30 |     $theme_service = Drupal::service('theme_handler');
31 |     $theme_service->install(array('mytheme'));
32 |     $theme_service->setDefault('mytheme');
33 |   }
34 | 
35 |   /**
36 |    * Tests the theme.
37 |    */
38 |   function testTheme() {
39 |     // Place a block in the custom region of this theme.
40 |     $block_title = 'This is a test.';
41 |     $this->drupalPlaceBlock('system_powered_by_block', array(
42 |         'region' => 'internal_region_name',
43 |         'label' => $block_title,
44 |         'label_display' => TRUE,
45 |       ));
46 | 
47 |     // Place a block in one of the regular regions.
48 |     $block_title_2 = 'Another title';
49 |     $this->drupalPlaceBlock('system_powered_by_block', array(
50 |         'region' => 'content',
51 |         'label' => $block_title_2,
52 |         'label_display' => TRUE,
53 |       ));
54 | 
55 |     // Log in.
56 |     $account = $this->drupalCreateUser(array('administer blocks'));
57 |     $this->drupalLogin($account);
58 | 
59 |     // Verify that the new region is shown on the Blocks page.
60 |     $this->drupalGet('admin/structure/block');
61 |     $this->assertText('Readable region name');
62 | 
63 |     // Visit the user profile page. Make sure both blocks are shown.
64 |     $this->drupalGet('user');
65 |     $this->assertText($block_title, 'Block in custom region is shown');
66 |     $this->assertText($block_title_2, 'Block in standard region is shown');
67 |   }
68 | }
69 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/src/Tests/ProgrammersGuideTestBase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @file
 5 |  * Contains \Drupal\mymodule\Tests\ProgrammersGuideTestBase
 6 |  */
 7 | 
 8 | namespace Drupal\mymodule\Tests;
 9 | 
10 | use Drupal\simpletest\WebTestBase;
11 | 
12 | /**
13 |  * Base class for all book code tests, with helper methods.
14 |  */
15 | abstract class ProgrammersGuideTestBase extends WebTestBase {
16 | 
17 |   /**
18 |    * Verbose output of a PHP variable with optional label.
19 |    */
20 |   public function outputVariable($var, $label = '') {
21 |     $this->verbose(
22 |       (($label) ? '<h2>' . $label . '</h2>' : '') .
23 |       '<pre>' . print_r($var, TRUE), '</pre>');
24 |   }
25 | 
26 |   /**
27 |    * Verbose output of HTML code with optional label.
28 |    */
29 |   public function outputHTML($var, $label = '') {
30 |     $this->verbose(
31 |       (($label) ? '<h2>' . $label . '</h2>' : '') .
32 |       htmlentities($var));
33 |   }
34 | 
35 |   /**
36 |    * Assert that the page title contains a string.
37 |    *
38 |    * Function borrowed from https://drupal.org/project/api.
39 |    */
40 |   protected function assertTitleContains($string, $message) {
41 |     $title = current($this->xpath('//title'));
42 |     $this->assertTrue(strpos($title, $string) !== FALSE, $message);
43 |   }
44 | }
45 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/templates/myentity.html.twig:
--------------------------------------------------------------------------------
 1 | {#
 2 | /**
 3 |  * @file
 4 |  * Template for rendering an entity
 5 |  *
 6 |  * From "Defining a Content Entity Type in Drupal 8", chapter 4
 7 |  *
 8 |  * Available variables:
 9 |  * - myentity: My Entity entity.
10 |  *   - eid: Entity ID.
11 |  *   - subtype: Entity subtype.
12 |  *   - title: Entity title.
13 |  * - attributes: HTML attributes for the containing element.
14 |  * - page: TRUE if this is on its own page.
15 |  * - title: Title of the entity.
16 |  * - title_attributes: Attributes for the title element.
17 |  * - content: Content of the entity.
18 |  * - content_attributes: Attributes for the content attribute.
19 | 
20 |  * @see mymodule_theme()
21 |  * @see template_preprocess_myentity()
22 |  */
23 | #}
24 | <article{{ attributes }}>
25 |   {% if not page %}
26 |     <h2{{ title_attributes }}>
27 |       <a href="{{ url }}" rel="bookmark">{{ title }}</a>
28 |     </h2>
29 |   {% endif %}
30 | 
31 |   <div {{ content_attributes }}>
32 |     {{ content }}
33 |   </div>
34 | 
35 | </article>
36 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mymodule/templates/mymodule-hookname.html.twig:
--------------------------------------------------------------------------------
 1 | {#
 2 | /**
 3 |  * @file
 4 |  * Sample theme template.
 5 |  *
 6 |  * From "Making Your Output Themeable", chapter 2.
 7 |  *
 8 |  * @see mymodule_theme()
 9 |  */
10 | #}
11 | <div>{{ input1 }}</div>
12 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mytheme/README.txt:
--------------------------------------------------------------------------------
 1 | This directory contains the Drupal 8 theme code from the book "Programmers Guide
 2 | to Drupal", by Jennifer Hodgdon, second edition, 2014.
 3 | 
 4 | License: See book for details of license and copyright.
 5 | 
 6 | Contents:
 7 | 
 8 | - mytheme.info.yml: Info file for theme.
 9 | 
10 | - templates/page.html.twig: Page template file.
11 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mytheme/mytheme.info.yml:
--------------------------------------------------------------------------------
 1 | # Drupal 8 sample theme .info.yml file
 2 | 
 3 | # Comments start with #
 4 | 
 5 | # The name of the theme.
 6 | name: My theme
 7 | 
 8 | # Required line telling Drupal this is a theme.
 9 | type: theme
10 | 
11 | # Longer description for the Themes page.
12 | description: Sample theme for Programmers Guide to Drupal -- a Bartik sub-theme
13 | 
14 | # Which version of Drupal this is for.
15 | core: 8.x
16 | 
17 | # This is a derivative, using Bartik as the base theme.
18 | base theme: bartik
19 | 
20 | # Theme regions. Only the Drupal core base regions will be automatically
21 | # present, so make sure to include all the regions from the base theme
22 | # .info file as well.
23 | regions:
24 |   # Custom region from section "Defining theme regions for block placement" in
25 |   # Chapter 3.
26 |   internal_region_name: 'Readable region name'
27 |   # Regions from core/themes/bartik/bartik.info.yml file.
28 |   header: Header
29 |   help: Help
30 |   page_top: 'Page top'
31 |   page_bottom: 'Page bottom'
32 |   highlighted: Highlighted
33 |   featured: Featured
34 |   content: Content
35 |   sidebar_first: 'Sidebar first'
36 |   sidebar_second: 'Sidebar second'
37 |   triptych_first: 'Triptych first'
38 |   triptych_middle: 'Triptych middle'
39 |   triptych_last: 'Triptych last'
40 |   footer_firstcolumn: 'Footer first column'
41 |   footer_secondcolumn: 'Footer second column'
42 |   footer_thirdcolumn: 'Footer third column'
43 |   footer_fourthcolumn: 'Footer fourth column'
44 |   footer: Footer
45 | 


--------------------------------------------------------------------------------
/code_2nd_ed/drupal8/mytheme/templates/page.html.twig:
--------------------------------------------------------------------------------
  1 | {#
  2 | /**
  3 |  * Page template file.
  4 |  *
  5 |  * This file is copied from the Drupal core Bartik theme, with an additional
  6 |  * region added called 'internal_region_name', just after the messages.
  7 |  */
  8 | #}
  9 | <div id="page-wrapper"><div id="page">
 10 | 
 11 |   <header id="header" class="{{ secondary_menu ? 'with-secondary-menu' : 'without-secondary-menu' }}" role="banner" aria-label="{{ 'Site header'|t}}"><div class="section clearfix">
 12 |    {% if secondary_menu %}
 13 |       <nav id="secondary-menu" class="navigation" role="navigation"  aria-labelledby="links__system_secondary_menu">
 14 |         {{ secondary_menu }}
 15 |       </nav> <!-- /#secondary-menu -->
 16 |     {% endif %}
 17 | 
 18 |     {% if logo %}
 19 |       <a href="{{ front_page }}" title="{{ 'Home'|t }}" rel="home" id="logo">
 20 |         <img src="{{ logo }}" alt="{{ 'Home'|t }}" />
 21 |       </a>
 22 |     {% endif %}
 23 | 
 24 |     {% if site_name or site_slogan %}
 25 |       <div id="name-and-slogan"{% if hide_site_name and hide_site_slogan %} class="visually-hidden"{% endif %}>
 26 |         {% if site_name %}
 27 |           {% if title %}
 28 |             <div id="site-name"{% if hide_site_name %} class="visually-hidden"{% endif %}>
 29 |               <strong>
 30 |                 <a href="{{ front_page }}" title="{{ 'Home'|t }}" rel="home"><span>{{ site_name }}</span></a>
 31 |               </strong>
 32 |             </div>
 33 |           {# Use h1 when the content title is empty #}
 34 |           {% else %}
 35 |             <h1 id="site-name"{% if hide_site_name %} class="visually-hidden" {% endif %}>
 36 |               <a href="{{ front_page }}" title="{{ 'Home'|t }}" rel="home"><span>{{ site_name }}</span></a>
 37 |             </h1>
 38 |           {% endif %}
 39 |         {% endif %}
 40 | 
 41 |         {% if site_slogan %}
 42 |           <div id="site-slogan"{% if hide_site_slogan %} class="visually-hidden"{% endif %}>
 43 |             {{ site_slogan }}
 44 |           </div>
 45 |         {% endif %}
 46 |       </div><!-- /#name-and-slogan -->
 47 |     {% endif %}
 48 | 
 49 |     {{ page.header }}
 50 | 
 51 |     {% if main_menu %}
 52 |       <nav id ="main-menu" class="navigation" role="navigation" aria-labelledby="links__system_main_menu">
 53 |         <div id="nav"></div>
 54 |         <div id="no-nav"></div>
 55 |         <a class="main-menu-reveal" href="#nav">{{ 'Menu'|t }}</a>
 56 |         <a class="main-menu-reveal main-menu-reveal--hide" href="#no-nav">{{ 'Menu'|t }}</a>
 57 |         {{ main_menu }}
 58 |       </nav> <!-- /#main-menu -->
 59 |     {% endif %}
 60 |   </div></header> <!-- /.section, /#header-->
 61 | 
 62 |   {% if messages %}
 63 |     <div id="messages"><div class="section clearfix">
 64 |       {{ messages }}
 65 |     </div></div> <!-- /.section, /#messages -->
 66 |   {% endif %}
 67 | 
 68 |   {#
 69 |   /* Added region from section "Defining theme regions for block placement"
 70 |    * in Chapter 3.
 71 |    */
 72 |   #}
 73 |   {% if page.internal_region_name %}
 74 |     <div id="internal-region-name">
 75 |       {{ page.internal_region_name }}
 76 |     </div>
 77 |   {% endif %}
 78 | 
 79 | 
 80 |   {% if page.featured %}
 81 |     <aside id="featured"><div class="section clearfix">
 82 |       {{ page.featured }}
 83 |     </div></aside> <!-- /.section, /#featured -->
 84 |   {% endif %}
 85 | 
 86 |   <div id="main-wrapper" class="clearfix"><div id="main" class="clearfix">
 87 |     {{ breadcrumb }}
 88 | 
 89 |     <main id="content" class="column" role="main"><section class="section">
 90 |       {% if page.highlighted %}<div id="highlighted">{{ page.highlighted }}</div>{% endif %}
 91 |       <a id="main-content" tabindex="-1"></a>
 92 |       {{ title_prefix }}
 93 |         {% if title %}
 94 |           <h1 class="title" id="page-title">
 95 |             {{ title }}
 96 |           </h1>
 97 |         {% endif %}
 98 |       {{ title_suffix }}
 99 |         {% if tabs %}
100 |           <nav class="tabs" role="navigation" aria-label="{{ 'Tabs'|t }}">
101 |             {{ tabs }}
102 |           </nav>
103 |         {% endif %}
104 |       {{ page.help }}
105 |         {% if action_links %}
106 |           <ul class="action-links">
107 |             {{ action_links }}
108 |           </ul>
109 |         {% endif %}
110 |       {{ page.content }}
111 |       {{ feed_icons }}
112 |     </section></main> <!-- /.section, /#content -->
113 | 
114 |     {% if page.sidebar_first %}
115 |       <div id="sidebar-first" class="column sidebar"><aside class="section">
116 |         {{ page.sidebar_first }}
117 |       </aside></div><!-- /.section, /#sidebar-first -->
118 |     {% endif %}
119 | 
120 |     {% if page.sidebar_second %}
121 |       <div id="sidebar-second" class="column sidebar"><aside class="section">
122 |         {{ page.sidebar_second }}
123 |       </aside></div><!-- /.section, /#sidebar-second -->
124 |     {% endif %}
125 | 
126 |   </div></div><!-- /#main, /#main-wrapper -->
127 | 
128 |   {% if page.triptych_first or page.triptych_middle or page.triptych_last %}
129 |     <div id="triptych-wrapper"><aside id="triptych" class="clearfix">
130 |       {{ page.triptych_first }}
131 |       {{ page.triptych_middle }}
132 |       {{ page.triptych_last }}
133 |     </aside></div><!-- /#triptych, /#triptych-wrapper -->
134 |   {% endif %}
135 | 
136 |   <div id="footer-wrapper"><footer class="section">
137 | 
138 |     {% if page.footer_firstcolumn or page.footer_secondcolumn or page.footer_thirdcolumn or page.footer_fourthcolumn %}
139 |       <div id="footer-columns" class="clearfix">
140 |         {{ page.footer_firstcolumn }}
141 |         {{ page.footer_secondcolumn }}
142 |         {{ page.footer_thirdcolumn }}
143 |         {{ page.footer_fourthcolumn }}
144 |       </div><!-- /#footer-columns -->
145 |     {% endif %}
146 | 
147 |     {% if page.footer %}
148 |       <div id="footer" role="contentinfo" class="clearfix">
149 |         {{ page.footer }}
150 |       </div> <!-- /#footer -->
151 |    {% endif %}
152 | 
153 |   </footer></div> <!-- /.section, /#footer-wrapper -->
154 | 
155 | </div></div> <!-- /#page, /#page-wrapper -->
156 | 
157 | 
158 | 


--------------------------------------------------------------------------------