Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\block_content\Tests;
Chris@0: 
Chris@18: @trigger_error(__NAMESPACE__ . '\BlockContentTestBase is deprecated for removal before Drupal 9.0.0. Use Drupal\Tests\block_content\Functional\BlockContentTestBase instead. See https://www.drupal.org/node/2999939', E_USER_DEPRECATED);
Chris@18: 
Chris@0: use Drupal\block_content\Entity\BlockContent;
Chris@0: use Drupal\block_content\Entity\BlockContentType;
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Sets up block content types.
Chris@0:  *
Chris@0:  * @deprecated Scheduled for removal in Drupal 9.0.0.
Chris@0:  *   Use \Drupal\Tests\block_content\Functional\BlockContentTestBase instead.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/node/2999939
Chris@0:  */
Chris@0: abstract class BlockContentTestBase extends WebTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Profile to use.
Chris@12:    *
Chris@12:    * @var string
Chris@0:    */
Chris@0:   protected $profile = 'testing';
Chris@0: 
Chris@0:   /**
Chris@0:    * Admin user
Chris@0:    *
Chris@0:    * @var \Drupal\user\UserInterface
Chris@0:    */
Chris@0:   protected $adminUser;
Chris@0: 
Chris@0:   /**
Chris@0:    * Permissions to grant admin user.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $permissions = [
Chris@17:     'administer blocks',
Chris@0:   ];
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['block', 'block_content'];
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether or not to auto-create the basic block type during setup.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $autoCreateBasicBlockType = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the test up.
Chris@0:    */
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0:     if ($this->autoCreateBasicBlockType) {
Chris@0:       $this->createBlockContentType('basic', TRUE);
Chris@0:     }
Chris@0: 
Chris@0:     $this->adminUser = $this->drupalCreateUser($this->permissions);
Chris@0:     $this->drupalPlaceBlock('local_actions_block');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Creates a custom block.
Chris@0:    *
Chris@0:    * @param bool|string $title
Chris@0:    *   (optional) Title of block. When no value is given uses a random name.
Chris@0:    *   Defaults to FALSE.
Chris@0:    * @param string $bundle
Chris@0:    *   (optional) Bundle name. Defaults to 'basic'.
Chris@0:    * @param bool $save
Chris@0:    *   (optional) Whether to save the block. Defaults to TRUE.
Chris@0:    *
Chris@0:    * @return \Drupal\block_content\Entity\BlockContent
Chris@0:    *   Created custom block.
Chris@0:    */
Chris@0:   protected function createBlockContent($title = FALSE, $bundle = 'basic', $save = TRUE) {
Chris@0:     $title = $title ?: $this->randomMachineName();
Chris@0:     $block_content = BlockContent::create([
Chris@0:       'info' => $title,
Chris@0:       'type' => $bundle,
Chris@17:       'langcode' => 'en',
Chris@0:     ]);
Chris@0:     if ($block_content && $save === TRUE) {
Chris@0:       $block_content->save();
Chris@0:     }
Chris@0:     return $block_content;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Creates a custom block type (bundle).
Chris@0:    *
Chris@0:    * @param string $label
Chris@0:    *   The block type label.
Chris@0:    * @param bool $create_body
Chris@0:    *   Whether or not to create the body field
Chris@0:    *
Chris@0:    * @return \Drupal\block_content\Entity\BlockContentType
Chris@0:    *   Created custom block type.
Chris@0:    */
Chris@0:   protected function createBlockContentType($label, $create_body = FALSE) {
Chris@0:     $bundle = BlockContentType::create([
Chris@0:       'id' => $label,
Chris@0:       'label' => $label,
Chris@0:       'revision' => FALSE,
Chris@0:     ]);
Chris@0:     $bundle->save();
Chris@0:     if ($create_body) {
Chris@0:       block_content_add_body_field($bundle->id());
Chris@0:     }
Chris@0:     return $bundle;
Chris@0:   }
Chris@0: 
Chris@0: }