1. class
  2. App
  3. \
  4. G6K
  5. \
  6. Command
  7. \
  8. ImportViewCommand

ImportViewCommand

class ImportViewCommand extends ViewCommandBase

Creates and optionally imports a view from a previously exported view with G6K.

This command allows to create a view and optionally import the templates and assets from a previously exported view in a .zip files with G6K.

Properties

protected string $name from CommandBase
protected string $version from CommandBase
protected array|false $parameters from CommandBase
protected string $projectDir from CommandBase
protected string $publicDir from CommandBase
protected Translator $translator from CommandBase
protected bool $initialized from CommandBase
protected bool $html from CommandBase

Methods

__construct(string $projectDir)

No description

void
doInitialization()

Realizes the initialization this command

from CommandBase
array|false
getParameters()

This function parses the '.env' file and returns an array of parameters

from CommandBase
string
getParameterValue(string $parameter)

Returns the value of a parameter

from CommandBase
string
getConfigParameter(string $parameter)

Gets a parameter with its name.

from CommandBase
void
configure()

Configures the current command.

from CommandBase
void
initialize(InputInterface $input, OutputInterface $output)

initializes the current command.

from CommandBase
void
askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)

Asks an argument if it's not supplied in the command line.

from CommandBase
int|null
execute(InputInterface $input, OutputInterface $output)

No description

bool
runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)

Run an embedded console command.

from CommandBase
DOMElement|null
castDOMElement(DOMNode $node)

Casts a DOMNode to DOMElement

from CommandBase
DOMElement|null
getDOMElementItem(DOMNodeList $nodes, int $index)

Retuns the DOMElement at position $index of the DOMNodeList

from CommandBase
string
resolvePath(string $path, string $base)

Converts a relative path of a file to an absolute path

from CommandBase
array
findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])

Finds files in the subdirectories of a giving directory

from CommandBase
string|int
findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the assets directory

from CommandBase
string|int
findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the templates directory

from CommandBase
string|int
findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the pdf forms directory

from CommandBase
string|int
findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the simulators directory

from CommandBase
bool
isHtml()

Returns true, if the message are displayed in HTML, false if not.

from CommandBase
void
message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)

Displays an message

from CommandBase
void
info(OutputInterface $output, string $message, array $parameters = [])

Displays an info message

from CommandBase
void
warning(OutputInterface $output, string $message, array $parameters = [])

Displays a warning message

from CommandBase
void
success(OutputInterface $output, string $message, array $parameters = [])

Displays a success message

from CommandBase
void
failure(OutputInterface $output, string $message, array $parameters = [])

Displays a failure message

from CommandBase
void
fatal(OutputInterface $output, string $message, array $parameters = [])

Displays an fatal error message

from CommandBase
void
error(OutputInterface $output, string $message, array $parameters = [])

Displays an error message

from CommandBase
void
debug(OutputInterface $output, string $message, array $parameters = [])

Displays a debug message

from CommandBase
void
comment(OutputInterface $output, string $message, array $parameters = [])

Displays a comment

from CommandBase
string
getCommandName()

No description

string
getCommandDescription()

No description

string
getCommandHelp()

No description

array
getCommandArguments()

No description

array
getCommandOptions()

No description

void
refreshAssetsManifest(OutputInterface $output)

Updates (or Creates) the manifest.json file for the assets versioning.

from ViewCommandBase
void
migrate3To4(string $view, OutputInterface $output)

Migrates the templates written for Symfony 2 or 3.

from ViewCommandBase
bool
updateViewParameters(string $view, string $viewurl, OutputInterface $output)

Updates the parameters (domainview and viewpath) for a view

from ViewCommandBase
void
interact(InputInterface $input, OutputInterface $output)

Checks the argument of the current command (g6k:view:import).

Details

at line 46
__construct(string $projectDir)

Parameters

string $projectDir The project directory

in CommandBase at line 111
private void doInitialization()

Realizes the initialization this command

Return Value

void

in CommandBase at line 136
private array|false getParameters()

This function parses the '.env' file and returns an array of parameters

Return Value

array|false parameters array or false in case of error

in CommandBase at line 169
private string getParameterValue(string $parameter)

Returns the value of a parameter

Parameters

string $parameter The given parameter

Return Value

string The value of the parameter

in CommandBase at line 184
protected string getConfigParameter(string $parameter)

Gets a parameter with its name.

Parameters

string $parameter The parameter name

Return Value

string The parameter value

in CommandBase at line 194
protected void configure()

Configures the current command.

Return Value

void

in CommandBase at line 228
protected void initialize(InputInterface $input, OutputInterface $output)

initializes the current command.

Parameters

InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

void

Exceptions

LogicException

in CommandBase at line 259
protected void askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)

Asks an argument if it's not supplied in the command line.

Parameters

InputInterface $input The input interface
OutputInterface $output The output interface
string $argumentName The argument name
string $questionText The question text

Return Value

void

at line 129
protected int|null execute(InputInterface $input, OutputInterface $output)

Parameters

InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

int|null null or 0 if everything went fine, or an error code

in CommandBase at line 307
protected bool runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)

Run an embedded console command.

Parameters

array $command The command
InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

bool

in CommandBase at line 325
protected DOMElement|null castDOMElement(DOMNode $node)

Casts a DOMNode to DOMElement

Parameters

DOMNode $node The DOMNodeList

Return Value

DOMElement|null The DOMElement.

in CommandBase at line 341
protected DOMElement|null getDOMElementItem(DOMNodeList $nodes, int $index)

Retuns the DOMElement at position $index of the DOMNodeList

Parameters

DOMNodeList $nodes The DOMNodeList
int $index The position in the DOMNodeList

Return Value

DOMElement|null The DOMElement.

in CommandBase at line 357
protected string resolvePath(string $path, string $base)

Converts a relative path of a file to an absolute path

Parameters

string $path The relative path name of the file
string $base The base path

Return Value

string

in CommandBase at line 385
protected array findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])

Finds files in the subdirectories of a giving directory

Parameters

string $in The start directory of the search
string $name The base name of the searched file
InputInterface $input The input interface
OutputInterface $output The output interface
array $filters Optional, filters to apply to the search

Return Value

array The full path of the files or an empty array if none has been found

in CommandBase at line 438
protected string|int findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the assets directory

Parameters

string $in The start directory of the search
InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

string|int The full path of the directory or an error code (1: not found, 2: multiple found)

in CommandBase at line 482
protected string|int findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the templates directory

Parameters

string $in The start directory of the search
InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

string|int The full path of the directory or an error code (1: not found, 2: multiple found)

in CommandBase at line 526
protected string|int findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the pdf forms directory

Parameters

string $in The start directory of the search
InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

string|int The full path of the directory or an error code (1: not found, 2: multiple found)

in CommandBase at line 570
protected string|int findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the simulators directory

Parameters

string $in The start directory of the search
InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

string|int The full path of the directory or an error code (1: not found, 2: multiple found)

in CommandBase at line 611
protected bool isHtml()

Returns true, if the message are displayed in HTML, false if not.

Return Value

bool

in CommandBase at line 627
private void message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)

Displays an message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters for translation
string $start The start tag
string $end The end tag
int $verbosity The verbosity option (default: OutputInterface::VERBOSITY_NORMAL), values : VERBOSITY_QUIET, VERBOSITY_NORMAL, VERBOSITY_VERBOSE, VERBOSITY_VERY_VERBOSE, VERBOSITY_DEBUG

Return Value

void

in CommandBase at line 647
protected void info(OutputInterface $output, string $message, array $parameters = [])

Displays an info message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 664
protected void warning(OutputInterface $output, string $message, array $parameters = [])

Displays a warning message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 681
protected void success(OutputInterface $output, string $message, array $parameters = [])

Displays a success message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 698
protected void failure(OutputInterface $output, string $message, array $parameters = [])

Displays a failure message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 715
protected void fatal(OutputInterface $output, string $message, array $parameters = [])

Displays an fatal error message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 732
protected void error(OutputInterface $output, string $message, array $parameters = [])

Displays an error message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 749
protected void debug(OutputInterface $output, string $message, array $parameters = [])

Displays a debug message

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

in CommandBase at line 762
protected void comment(OutputInterface $output, string $message, array $parameters = [])

Displays a comment

Parameters

OutputInterface $output The output interface
string $message The message to display
array $parameters Optional, message parameters

Return Value

void

at line 53
protected string getCommandName()

Return Value

string The name

at line 60
protected string getCommandDescription()

Return Value

string The description

at line 67
protected string getCommandHelp()

Return Value

string The help text

at line 85
protected array getCommandArguments()

Return Value

array The help text

at line 108
protected array getCommandOptions()

Return Value

array The help text

in ViewCommandBase at line 89
protected void refreshAssetsManifest(OutputInterface $output)

Updates (or Creates) the manifest.json file for the assets versioning.

Parameters

OutputInterface $output The output interface

Return Value

void

in ViewCommandBase at line 114
protected void migrate3To4(string $view, OutputInterface $output)

Migrates the templates written for Symfony 2 or 3.

Parameters

string $view The view name
OutputInterface $output The output interface

Return Value

void

in ViewCommandBase at line 141
protected bool updateViewParameters(string $view, string $viewurl, OutputInterface $output)

Updates the parameters (domainview and viewpath) for a view

Parameters

string $view The view name
string $viewurl The website url using this view
OutputInterface $output The output interface

Return Value

bool if the parameters are successfully updated, false if not

at line 120
protected void interact(InputInterface $input, OutputInterface $output)

Checks the argument of the current command (g6k:view:import).

Parameters

InputInterface $input The input interface
OutputInterface $output The output interface

Return Value

void