1. class
  2. EUREKA
  3. \
  4. G6KBundle
  5. \
  6. Controller
  7. \
  8. DocumentationController

DocumentationController

class DocumentationController extends BaseAdminController

The DocumentationController class is the controller that manages the display of documentation pages.

Properties

ControllersHelper $helper from BaseAdminController
string $databasesDir from BaseAdminController
string $simulatorsDir from BaseAdminController
string $publicDir from BaseAdminController
string $viewsDir from BaseAdminController

Methods

Response
errorResponse(array $form, string $error)

Returns a JSON response formed with the data of a form and an error message.

from BaseAdminController
zip(array $contents)

Zip file creation function.

from BaseAdminController
int
unix2DosTime(int $unixtime)

Converts unix time to MS DOS time

from BaseAdminController
Response;
indexAction(Request $request, string $document = null)

Entry point for the route path /admin/doc/{document}

Response;
runIndex(Request $request, string $document)

Processes the index action

Details

in BaseAdminController at line 93
protected Response errorResponse(array $form, string $error)

Returns a JSON response formed with the data of a form and an error message.

Parameters

array $form The form fields
string $error The error message

Return Value

Response

in BaseAdminController at line 113
protected zip(array $contents)

Zip file creation function.

Makes zip files. Derivated from PhpMyAdmin package The $contents parameter is an array of associative array where keys are : - name: name of the zip - modtime: modification time - data: data to compress

Parameters

array $contents The array of contents to be compressed

See also

Official ZIP file format: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

in BaseAdminController at line 188
protected int unix2DosTime(int $unixtime)

Converts unix time to MS DOS time

Parameters

int $unixtime (default: 0) The unix time

Return Value

int The MS DOS time

at line 57
Response; indexAction(Request $request, string $document = null)

Entry point for the route path /admin/doc/{document}

Parameters

Request $request The request
string $document (default: null) The document name

Return Value

Response; The rendered document

at line 72
protected Response; runIndex(Request $request, string $document)

Processes the index action

Parameters

Request $request The request
string $document (default: null) The document name

Return Value

Response; The rendered document