Heim  >  Artikel  >  Backend-Entwicklung  >  CakePHP-Projektkonfiguration

CakePHP-Projektkonfiguration

WBOY
WBOYOriginal
2024-09-10 17:25:03432Durchsuche

In diesem Kapitel werden wir die Umgebungsvariablen, allgemeine Konfiguration, Datenbankkonfiguration und E-Mail-Konfiguration in CakePHP verstehen.

Konfiguration CakePHP wird standardmäßig mit einer Konfigurationsdatei geliefert, die wir je nach Bedarf ändern können. Zu diesem Zweck gibt es einen eigenen Ordner „config“. CakePHP bietet verschiedene Konfigurationsoptionen.

Beginnen wir damit, die Umgebungsvariablen in CakePHP zu verstehen.

Umgebungsvariablen

Umgebungsvariablen erleichtern die Arbeit Ihrer Anwendung in verschiedenen Umgebungen. Zum Beispiel auf Entwicklungsservern, Testservern, Staging-Servern und Produktionsserverumgebungen. Für alle diese Umgebungen können Sie die env()-Funktion verwenden, um die Konfiguration für die von Ihnen benötigte Umgebung zu lesen und Ihre Anwendung zu erstellen.

In Ihrem Konfigurationsordner finden Sie config/.env.example. Diese Datei enthält alle Variablen, die je nach Ihrer Umgebung geändert werden. Zunächst können Sie eine Datei im Konfigurationsordner erstellen, z. B. config/.env, diese Variablen definieren und verwenden. Falls Sie zusätzliche Variablen benötigen, können diese in dieser Datei abgelegt werden.

Sie können Ihre Umgebungsvariable mit der Funktion env() lesen, wie unten gezeigt −

Beispiel

$debug = env('APP_DEBUG', false);

Der erste Wert ist der Name der gewünschten Umgebungsvariablen und der zweite Wert ist der Standardwert. Der Standardwert wird verwendet, wenn für die Umgebungsvariable kein Wert gefunden wird.

Allgemeine Konfiguration

Die folgende Tabelle beschreibt die Rolle verschiedener Variablen und wie sie sich auf Ihre CakePHP-Anwendung auswirken.

Sr.Nr Variablenname und Beschreibung
1
Sr.No Variable Name & Description
1

debug

Changes CakePHP debugging output.

false = Production mode. No error messages, errors, or warnings shown.

true = Errors and warnings shown.

2

App.namespace

The namespace to find app classes under.

3

App.baseUrl

Un-comment this definition, if you don’t plan to use Apache’s mod_rewrite with CakePHP. Don’t forget to remove your .htaccess files too.

4

App.base

The base directory the app resides in. If false, this will be auto detected.

5

App.encoding

Define what encoding your application uses. This encoding is used to generate the charset in the layout, and encode entities. It should match the encoding values specified for your database.

6

App.webroot

The webroot directory.

7

App.wwwRoot

The file path to webroot.

8

App.fullBaseUrl

The fully qualified domain name (including protocol) to your application’s root.

9

App.imageBaseUrl

Web path to the public images directory under webroot.

10

App.cssBaseUrl

Web path to the public css directory under webroot.

11

App.jsBaseUrl

Web path to the public js directory under webroot.

12

App.paths

Configure paths for non-class based resources. Supports the plugins, templates, locales, subkeys, which allow the definition of paths for plugins, view templates and locale files respectively.

13

Security.salt

A random string used in hashing. This value is also used as the HMAC salt when doing symmetric encryption.

14

Asset.timestamp

Appends a timestamp, which is last modified time of the particular file at the end of asset files URLs (CSS, JavaScript, Image) when using proper helpers. The valid values are −

  • (bool) false - Doesn’t do anything (default).

  • (bool) true - Appends the timestamp, when debug is true.

  • (string) ‘force’ - Always appends the timestamp.

Debuggen Ändert die CakePHP-Debugging-Ausgabe. false = Produktionsmodus. Es werden keine Fehlermeldungen, Fehler oder Warnungen angezeigt. true = Fehler und Warnungen werden angezeigt.
2 App.namespace Der Namespace, unter dem App-Klassen gefunden werden sollen.
3 App.baseUrl Kommentieren Sie diese Definition aus, wenn Sie nicht vorhaben, Apaches mod_rewrite mit CakePHP zu verwenden. Vergessen Sie nicht, auch Ihre .htaccess-Dateien zu entfernen.
4 App.base Das Basisverzeichnis, in dem sich die App befindet. Bei „false“ wird dies automatisch erkannt.
5 App.encoding Definieren Sie, welche Codierung Ihre Anwendung verwendet. Diese Kodierung wird verwendet, um den Zeichensatz im Layout zu generieren und Entitäten zu kodieren. Es sollte mit den für Ihre Datenbank angegebenen Kodierungswerten übereinstimmen.
6 App.webroot Das Webroot-Verzeichnis.
7 App.wwwRoot Der Dateipfad zum Webroot.
8 App.fullBaseUrl Der vollständig qualifizierte Domänenname (einschließlich Protokoll) zum Stammverzeichnis Ihrer Anwendung.
9 App.imageBaseUrl Webpfad zum öffentlichen Bilderverzeichnis unter Webroot.
10 App.cssBaseUrl Webpfad zum öffentlichen CSS-Verzeichnis unter Webroot.
11 App.jsBaseUrl Webpfad zum öffentlichen js-Verzeichnis unter webroot.
12 App.paths Konfigurieren Sie Pfade für nicht klassenbasierte Ressourcen. Unterstützt die Plugins, Vorlagen, Gebietsschemas, Unterschlüssel, die die Definition von Pfaden für Plugins, Ansichtsvorlagen bzw. Gebietsschemadateien ermöglichen.
13 Security.salt Eine zufällige Zeichenfolge, die beim Hashing verwendet wird. Dieser Wert wird auch als HMAC-Salt bei der symmetrischen Verschlüsselung verwendet.
14 Asset.timestamp Hängt einen Zeitstempel, der den Zeitpunkt der letzten Änderung der jeweiligen Datei angibt, am Ende der Asset-Datei-URLs (CSS, JavaScript, Bild) an, wenn geeignete Hilfsprogramme verwendet werden. Die gültigen Werte sind −
  • (bool) false – Tut nichts (Standard).
  • (bool) true – Hängt den Zeitstempel an, wenn Debug wahr ist.
  • (string) „force“ – Hängt immer den Zeitstempel an.

Databases Configuration

Database can be configured in config/app.php and config/app_local.php file. This file contains a default connection with provided parameters, which can be modified as per our choice.

The below snippet shows the default parameters and values, which should be modified as per the requirement.

Config/app_local.php

*/
   'Datasources' => [
      'default' => [
         'host' => 'localhost',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'my_app',
         'url' => env('DATABASE_URL', null),
      ],
      /*
         * The test connection is used during the test suite.
      */
      'test' => [
         'host' => 'localhost',
         //'port' => 'non_standard_port_number',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'test_myapp',
         //'schema' => 'myapp',
      ],
   ],

Let us understand each parameter in detail in config/app_local.php.

Host

The database server’s hostname (or IP address).

username

Database username

password

Database password.

database

Name of Database.

Port

The TCP port or Unix socket used to connect to the server.

config/app.php

'Datasources' => [
   'default' => [
      'className' => Connection::class,
      'driver' => Mysql::class,
      'persistent' => false,
      'timezone' => 'UTC',
      //'encoding' => 'utf8mb4',
      'flags' => [],
      'cacheMetadata' => true,
      'log' => false,
      'quoteIdentifiers' => false,
      //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
   ],
]   

Let us understand each parameter in detail in config/app.php.

log
Sr.No Key & Description
1

className

The fully namespaced class name of the class that represents the connection to a database server. This class is responsible for loading the database driver, providing SQL transaction mechanisms and preparing SQL statements among other things.

2

driver

The class name of the driver used to implement all specificities for a database engine. This can either be a short classname using plugin syntax, a fully namespaced name, or a constructed driver instance. Examples of short classnames are Mysql, Sqlite, Postgres, and Sqlserver.

3

persistent

Whether or not to use a persistent connection to the database.

4

encoding

Indicates the character set to use, when sending SQL statements to the server like ‘utf8’ etc.

5

timezone

Server timezone to set.

6

init

A list of queries that should be sent to the database server as and when the connection is created.

7

log

Set to true to enable query logging. When enabled queries will be logged at a debug level with the queriesLog scope.

8

quoteIdentifiers

Set to true, if you are using reserved words or special characters in your table or column names. Enabling this setting will result in queries built using the Query Builder having identifiers quoted when creating SQL. It decreases performance.

9

flags

An associative array of PDO constants that should be passed to the underlying PDO instance.

10

cacheMetadata

Either boolean true, or a string containing the cache configuration to store meta data in. Having metadata caching disable is not advised and can result in very poor performance.

Email Configuration

Email can be configured in file config/app.php. It is not required to define email configuration in config/app.php. Email can be used without it. Just use the respective methods to set all configurations separately or load an array of configs. Configuration for Email defaults is created using config() and configTransport().

Email Configuration Transport

By defining transports separately from delivery profiles, you can easily re-use transport configuration across multiple profiles. You can specify multiple configurations for production, development and testing. Each transport needs a className. Valid options are as follows −

  • Mail − Send using PHP mail function

  • Smtp − Send using SMTP

  • Debug − Do not send the email, just return the result

You can add custom transports (or override existing transports) by adding the appropriate file to src/Mailer/Transport. Transports should be named YourTransport.php, where 'Your' is the name of the transport.

Following is the example of Email configuration transport.

'EmailTransport' => [
   'default' => [
      'className' => 'Mail',
      // The following keys are used in SMTP transports
      'host' => 'localhost',
      'port' => 25,
      'timeout' => 30,
      'username' => 'user',
      'password' => 'secret',
      'client' => null,
      'tls' => null,
      'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null),
   ],
],

Email Delivery Profiles

Delivery profiles allow you to predefine various properties about email messages from your application, and give the settings a name. This saves duplication across your application and makes maintenance and development easier. Each profile accepts a number of keys.

Following is an example of Email delivery profiles.

'Email' => [
   'default' => [
   
      'transport' => 'default',
      'from' => 'you@localhost',
   ],
],

Das obige ist der detaillierte Inhalt vonCakePHP-Projektkonfiguration. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Vorheriger Artikel:CakePHP-OrdnerstrukturNächster Artikel:CakePHP-Ordnerstruktur