Search

Codeception\InitTemplate

  • Uses Codeception\Command\Shared\FileSystem, Codeception\Command\Shared\Style

Codeception templates allow creating a customized setup and configuration for your project. An abstract class for installation template. Each init template should extend it and implement a setup method. Use it to build a custom setup class which can be started with codecept init command.

<?php
namespace Codeception\Template; // it is important to use this namespace so codecept init could locate this template
class CustomInstall extends \Codeception\InitTemplate
{
     public function setup()
     {
        // implement this
     }
}

This class provides various helper methods for building customized setup

__construct()

public __construct($input, $output)

See source

addStyles()

public addStyles($output)

See source

ask()

protected ask($question, $answer = null)

<?php
// propose firefox as default browser
$this->ask('select the browser of your choice', 'firefox');

// propose firefox or chrome possible options
$this->ask('select the browser of your choice', ['firefox', 'chrome']);

// ask true/false question
$this->ask('do you want to proceed (y/n)', true);
  • param $question
  • param null $answer
  • return mixed string

See source

breakParts()

protected breakParts($class)

See source

checkInstalled()

protected checkInstalled($dir = null)

See source

completeSuffix()

protected completeSuffix($filename, $suffix)

See source

createActor()

protected createActor($name, $directory, $suiteConfig)

Create an Actor class and generate actions for it. Requires a suite config as array in 3rd parameter.

  • param $name
  • param $directory
  • param $suiteConfig

See source

createDirectoryFor()

protected createDirectoryFor($basePath, $className = null)

See source

createEmptyDirectory()

protected createEmptyDirectory($dir)

Create an empty directory and add a placeholder file into it

  • param $dir

See source

createFile()

protected createFile($filename, $contents, $force = null, $flags = null)

See source

createHelper()

protected createHelper($name, $directory)

Create a helper class inside a directory

  • param $name
  • param $directory

See source

getNamespaceHeader()

protected getNamespaceHeader($class)

See source

getNamespaceString()

protected getNamespaceString($class)

See source

getNamespaces()

protected getNamespaces($class)

See source

getShortClassName()

protected getShortClassName($class)

See source

gitIgnore()

protected gitIgnore($path)

See source

initDir()

public initDir($workDir)

Change the directory where Codeception should be installed.

See source

removeSuffix()

protected removeSuffix($classname, $suffix)

See source

say()

protected say($message = null)

Print a message to console.

<?php
$this->say('Welcome to Setup');
  • param string $message

See source

sayInfo()

protected sayInfo($message)

Print info message

  • param $message

See source

saySuccess()

protected saySuccess($message)

Print a successful message

  • param $message

See source

sayWarning()

protected sayWarning($message)

Print warning message

  • param $message

See source

setup()

abstract public setup()

Override this class to create customized setup.

  • return mixed

See source

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
Don't know how to write tests on your own? We will build or improve them for you. Request a quote for official enterprise support or trainings

Not sure what to test?

Let your users tell you!

Turn user feedback into tests

with Bugira Bugtracker