diff --git a/block_example/block_example.module b/block_example/block_example.module index 54d1e2b..3e12d87 100644 --- a/block_example/block_example.module +++ b/block_example/block_example.module @@ -4,6 +4,7 @@ * @file * Module file for block_example. */ + /** * @defgroup block_example Example: Block * @ingroup examples diff --git a/block_example/lib/Drupal/block_example/Controller/BlockExampleController.php b/block_example/lib/Drupal/block_example/Controller/BlockExampleController.php index a366f74..46c92fc 100644 --- a/block_example/lib/Drupal/block_example/Controller/BlockExampleController.php +++ b/block_example/lib/Drupal/block_example/Controller/BlockExampleController.php @@ -15,7 +15,7 @@ class BlockExampleController { /** * A simple controller method to explain what the block example is about. */ - function description() { + public function description() { $build = array( '#markup' => t('The Block Example provides two sample blocks which demonstrate the various block APIs. To experiment with the blocks, enable and configure them on the block admin page.', array('@url' => url('admin/structure/block'))), ); diff --git a/block_example/lib/Drupal/block_example/Tests/BlockExampleTest.php b/block_example/lib/Drupal/block_example/Tests/BlockExampleTest.php index 5ff9bb9..5ed296c 100644 --- a/block_example/lib/Drupal/block_example/Tests/BlockExampleTest.php +++ b/block_example/lib/Drupal/block_example/Tests/BlockExampleTest.php @@ -17,8 +17,12 @@ class BlockExampleTest extends WebTestBase { * @var array */ public static $modules = array('block', 'search', 'block_example'); - protected $web_user; + protected $WebUser; + + /** + * {@inheritdoc} + */ public static function getInfo() { return array( 'name' => 'Block example functionality', @@ -30,19 +34,19 @@ class BlockExampleTest extends WebTestBase { /** * Enable modules and create user with specific permissions. */ - function setUp() { + public function setUp() { parent::setUp(); // Create user. Search content permission granted for the search block to // be shown. - $this->web_user = $this->drupalCreateUser(array('administer blocks', 'search content')); + $this->WebUser = $this->drupalCreateUser(array('administer blocks', 'search content')); } /** * Tests block_example functionality. */ - function testBlockExampleBasic() { + public function testBlockExampleBasic() { // Login the admin user. - $this->drupalLogin($this->web_user); + $this->drupalLogin($this->WebUser); $theme_name = config('system.theme')->get('default'); // Verify the blocks are listed to be added. diff --git a/cache_example/lib/Drupal/cache_example/Forms/CacheExampleForm.php b/cache_example/lib/Drupal/cache_example/Forms/CacheExampleForm.php index a746db3..be66c79 100644 --- a/cache_example/lib/Drupal/cache_example/Forms/CacheExampleForm.php +++ b/cache_example/lib/Drupal/cache_example/Forms/CacheExampleForm.php @@ -47,10 +47,9 @@ class CacheExampleForm extends FormBase { // Recursively get all files from Drupal's folder. $files_count = count(file_scan_directory('.', '/.*/')); - - // Since we have recalculated, we now need to store the new data into cache. - // Complex data types will be automatically serialized before being saved - // into cache. + // Since we have recalculated, we now need to store the new data into + // cache. Complex data types will be automatically serialized before + // being saved into cache. // Here we use the default setting and create an unexpiring cache item. // See below for an example that creates an expiring cache item. \Drupal::cache()->set('cache_example_files_count', $files_count, CacheBackendInterface::CACHE_PERMANENT); @@ -59,7 +58,6 @@ class CacheExampleForm extends FormBase { $end_time = microtime(TRUE); $duration = $end_time - $start_time; - // Format intro message. $intro_message = '

' . t('This example will search the entire drupal folder and display a count of the files in it.') . ' '; $intro_message .= t('This can take a while, since there are a lot of files to be searched.') . ' '; @@ -124,7 +122,7 @@ class CacheExampleForm extends FormBase { 300 => t('5 minutes from form submission'), ), '#default_value' => -10, - '#description' => t('Any cache item can be set to only expire when explicitly cleared, or to expire at a given time.') + '#description' => t('Any cache item can be set to only expire when explicitly cleared, or to expire at a given time.'), ); $form['expiration_demo']['create_cache_item'] = array( '#type' => 'submit', @@ -162,7 +160,8 @@ class CacheExampleForm extends FormBase { * Submit handler that explicitly clears cache_example_files_count from cache. */ public function expireFiles($form, &$form_state) { - // Clear cached data. This function will delete cached object from cache bin. + // Clear cached data. This function will delete cached object from cache + // bin. // // The first argument is cache id to be deleted. Since we've provided it // explicitly, it will be removed whether or not it has an associated @@ -181,7 +180,7 @@ class CacheExampleForm extends FormBase { public function createExpiringItem($form, &$form_state) { $tags = array( - 'cache_example' => array(1) + 'cache_example' => array(1), ); $interval = $form_state['values']['expiration']; @@ -193,8 +192,9 @@ class CacheExampleForm extends FormBase { $expiration = time() + $interval; $expiration_friendly = format_date($expiration); } - // Set the expiration to the actual Unix timestamp of the end of the required - // interval. Also add a tag to it to be able to clear caches more precise. + // Set the expiration to the actual Unix timestamp of the end of the + // required interval. Also add a tag to it to be able to clear caches more + // precise. \Drupal::cache()->set('cache_example_expiring_item', $expiration_friendly, $expiration, $tags); drupal_set_message(t('cache_example_expiring_item was set to expire at %time', array('%time' => $expiration_friendly))); } @@ -205,20 +205,24 @@ class CacheExampleForm extends FormBase { public function cacheClearing($form, &$form_state) { switch ($form_state['values']['cache_clear_type']) { case 'expire': - // Here we'll remove all cache keys in the 'cache' bin that have expired. + // Here we'll remove all cache keys in the 'cache' bin that have + // expired. \Drupal::cache()->garbageCollection(); drupal_set_message(t('\Drupal::cache()->garbageCollection() was called, removing any expired cache items.')); break; + case 'remove_all': // This removes all keys in a bin using a super-wildcard. This // has nothing to do with expiration. It's just brute-force removal. \Drupal::cache()->deleteAll(); drupal_set_message(t('ALL entries in the "cache" bin were removed with \Drupal::cache()->deleteAll().')); break; - case 'remove_tag': - // This removes cache entries with the tag "cache_example" set to 1 in the "cache". + + case 'remove_tag': + // This removes cache entries with the tag "cache_example" set to 1 in + // the "cache". $tags = array( - 'cache_example' => array(1) + 'cache_example' => array(1), ); \Drupal::cache()->deleteTags($tags); drupal_set_message(t('Cache entries with the tag "cache_example" set to 1 in the "cache" bin were removed with \Drupal::cache()->deleteTags($tags).')); diff --git a/cache_example/lib/Drupal/cache_example/Tests/CacheExampleTestCase.php b/cache_example/lib/Drupal/cache_example/Tests/CacheExampleTestCase.php index 4de04d8..6f20947 100644 --- a/cache_example/lib/Drupal/cache_example/Tests/CacheExampleTestCase.php +++ b/cache_example/lib/Drupal/cache_example/Tests/CacheExampleTestCase.php @@ -1,4 +1,5 @@ 'Cache example functionality', @@ -23,16 +30,19 @@ class CacheExampleTestCase extends WebTestBase { } /** - * Load cache example page and test if displaying uncached version. Reload once again and test - * if displaying cached version. Find reload link and click on it. Clear cache at the end and - * test if displaying uncached version again. + * Load cache example page and test if displaying uncached version. + * + * Reload once again and test if displaying cached version. Find reload link + * and click on it. Clear cache at the end and test if displaying uncached + * version again. */ - function testCacheExampleBasic() { + public function testCacheExampleBasic() { // We need administrative privileges to clear the cache. $admin_user = $this->drupalCreateUser(array('administer site configuration')); $this->drupalLogin($admin_user); - // Get uncached output of cache example page and assert some things to be sure. + // Get uncached output of cache example page and assert some things to be + // sure. $this->drupalGet('examples/cache_example'); $this->assertText('Source: actual file search'); // Reload the page; the number should be cached. @@ -46,22 +56,22 @@ class CacheExampleTestCase extends WebTestBase { // Create a cached item. First make sure it doesn't already exist. $this->assertText('Cache item does not exist'); $this->drupalPostForm('examples/cache_example', array('expiration' => -10), t('Create a cache item with this expiration')); - // We should now have an already-expired item + // We should now have an already-expired item. $this->assertText('Cache item exists and is set to expire'); - // Now do the expiration operation + // Now do the expiration operation. $this->drupalPostForm('examples/cache_example', array('cache_clear_type' => 'expire'), t('Clear or expire cache')); // And verify that it was removed. $this->assertText('Cache item does not exist'); // Create a cached item. This time we'll make it not expire. $this->drupalPostForm('examples/cache_example', array('expiration' => 'never_remove'), t('Create a cache item with this expiration')); - // We should now have an never-remove item + // We should now have an never-remove item. $this->assertText('Cache item exists and is set to expire at Never expires'); - // Now do the expiration operation + // Now do the expiration operation. $this->drupalPostForm('examples/cache_example', array('cache_clear_type' => 'expire'), t('Clear or expire cache')); // And verify that it was not removed. $this->assertText('Cache item exists and is set to expire at Never expires'); - // Now do full removal + // Now do full removal. $this->drupalPostForm('examples/cache_example', array('cache_clear_type' => 'remove_tag'), t('Clear or expire cache')); // And verify that it was removed. $this->assertText('Cache item does not exist'); diff --git a/phpunit_example/tests/Drupal/phpunit_example/Tests/Reflection_ProtectedPrivatesTest.php b/phpunit_example/tests/Drupal/phpunit_example/Tests/Reflection_ProtectedPrivatesTest.php index 34de53c..179b669 100644 --- a/phpunit_example/tests/Drupal/phpunit_example/Tests/Reflection_ProtectedPrivatesTest.php +++ b/phpunit_example/tests/Drupal/phpunit_example/Tests/Reflection_ProtectedPrivatesTest.php @@ -125,7 +125,7 @@ class Reflection_ProtectedPrivatesTest extends UnitTestCase { $pp = new ProtectedPrivates(); // Use the reflection to invoke on the object. // This should throw an exception. - $sum = $privateMethod->invokeArgs($pp, array($a, $b)); + $privateMethod->invokeArgs($pp, array($a, $b)); } /** diff --git a/tour_example/config/tour.tour.tour-example.yml b/tour_example/config/tour.tour.tour-example.yml index c4c18e7..b998e74 100644 --- a/tour_example/config/tour.tour.tour-example.yml +++ b/tour_example/config/tour.tour.tour-example.yml @@ -35,9 +35,9 @@ # label: The lable for the tip. This will be rendered in an h3 element. # body: The body of the tip. HTML markup is allowed. # weight: Tips within a tour are ordered by weight, beginning with the -# lowest number. Negative values are acceptible. +# lowest number. Negative values are acceptable. # location: Defines the location of the tip, relative to its target. -# Acceptible values include: top, bottom, left, & right. If the +# Acceptable values include: top, bottom, left, & right. If the # location is not defined, the default value (bottom) will be # used. # attributes: Attributes provdied to the tip for various purposes. Use the