Hello there, this is the official explanation documentation for project cristeena. In here we will discuss all the aspects for cristeena and how it can be used at her best for the development of the web application.<h2>Installation</h2>Installing cristeena is straight forward, there are two approaches to do that. Mentioned as follows.<ul><li>Cloning the Repository</li><li>Composer Based ( Recommended )</li></ul>you can go for the way you suite most comfortable with but I personally recommend the “composer based approach”.<h3>Cloning</h3>you can simply clone the repository by the following command followed by the composer command for the dependencies installation.Execute the following commands one by one.<pre class="ql-syntax" spellcheck="false">git clone https://github.com/samgan-khan/cristeena.git
cd cristeena
composer install
</pre><h3>Composer</h3>Through compose everything can be done in one go<pre class="ql-syntax" spellcheck="false">composer create-project --prefer-dist samgan-khan/cristeena
</pre>In case you want to use a custom app directory name (e.g. /myapp/):<pre class="ql-syntax" spellcheck="false">composer create-project --prefer-dist samgan-khan/cristeena myapp
</pre>Once you are done with either, for starting the server you can execute the following command. You can also run the set up like any other site on apache but its my personal choice to run on the&nbsp;inbuild&nbsp;server of cakePHP<pre class="ql-syntax" spellcheck="false">bin/cake server -p 8765
</pre>Then visit&nbsp;http://localhost:8765&nbsp;to see the welcome page.<h2>Configuration</h2>configurations in cristeena&nbsp;is&nbsp;next to null, all you have to do in&nbsp;change&nbsp;the .default files to there original form.Rename the following files<ul><li>.env.default to .env (environment file)</li><li>app.default.php to app.php ( if not done already )</li></ul>Once you are done renaming fill the asked requirements in the .env&nbsp;file and you are done with the configurations.Congratulations….

Cristeena Documentation

As you may know according to the default configuration of CakePHP the debug and error log is generated in the same file. But this can be changed in a few simple steps. All you have to do is following.<ol><li>Got to config/app.php</li><li>Find the ‘Log’ configuration array</li><li>In both debug and error replace the ‘file’ with “’debug-‘ .&nbsp;date(‘Y-m-d’),” and “’error-‘ . date(‘Y-m-d’),” respectively</li><li>Save the file and you are good to go.</li></ol>Now, the log will be generated on a daily basis.

As you may know according to the default configuration of CakePHP the debug and error log is generated in the same file. But this can be changed in a few simple steps

How to make log daily in CakePHP 3.x

Although the authentication component of CakePHP 3 has made the life of a developer much easier but still there are some functionalities that are still needed to be done manually. One of them is login automatically if the users have checked for ‘remember me’.To be frank auto login also known as cookie-based login is not that big deal. The real idea behind that is to make browser remember that user from a particular site has visited and if he comes back please don't ask him/her to log in again.By so far you must have understood that we are going to use cookies to implement the logic. So, without wasting any time lets get started<h2>Step 1.</h2>Add cookie component to the system. You may have noticed the best place to add a component is in the&nbsp;appController.php&nbsp;initialize action as the request handler and flash are also included there.You can add the following line to add the cookie component.<pre class="ql-syntax" spellcheck="false">$this-&gt;loadComponent('Cookie');
</pre><h2>Step 2.</h2>Now since we have cookies support with us, we can proceed further.Now we have to make a remember me checkbox on the login page so that we can check if the user is willing to be remembered by the browser.You can do it easily by just adding an input with type=”checkbox”. For this article name of the checkbox is “remember”<pre class="ql-syntax" spellcheck="false">&lt;input class="form-control" type="checkbox" name="remember"&gt; Remember Me
</pre><h2>Step 3.</h2>Now we are all set for the main functionality.Now if the user’s checks “remember me” we are going to add a secret hash in the cookies and the same hash will be assigned to the login user for future identification. To do that we only need 1 thing a “secret hash”. This can be done with the help “Security” utility.Add the following line to&nbsp;appController.php<pre class="ql-syntax" spellcheck="false">use Cake\Utility\Security;
</pre>Now create a function in app controller which will return a secret and unique hash.<pre class="ql-syntax" spellcheck="false">function _hashGenerator()
{
 return Security::hash(rand());
}
</pre>Congratulations! We have hash now.<h2>Step 4.</h2>Things from here are simple from here. Below is the pseudo code for the same.<ul><li>Check if the remember is checked</li><li>if checked then set a variable remember and unset the check form the request as it will create a problem in the auth identify.</li><li>Once the user is identified and remember is set then set the auto login. (function is mentioned below).</li><li>In setting autoLogin</li><li class="ql-indent-1">generate a hash</li><li class="ql-indent-1">assign&nbsp;same&nbsp;hash to login user</li><li class="ql-indent-1">set the same hash in cookies.</li></ul>The function to implement the above pseudo code is mentioned below (to be written in&nbsp;usersController.php)<pre class="ql-syntax" spellcheck="false">if ($user = $this-&gt;Auth-&gt;identify()) {
 if ($remember) {
 $this-&gt;_setAutoLogin($user['id']);
 }
...
function _setAutoLogin($id=null)
{
 $hash = $this-&gt;_hashGenerator();
 $this-&gt;Cookie-&gt;config([
 'expires' =&gt; '+30 days',
 'httpOnly' =&gt; true
 ]);
 $this-&gt;Cookie-&gt;write('connects', $hash);
 $user = $this-&gt;Users-&gt;get($id);
 $user-&gt;hash = $hash;
 if ($this-&gt;Users-&gt;save($user)) {
 return true;
 } else {
 return false;
 }
}
</pre><h2>Step 5.</h2>All set we are done now. All we have to do is add the below line at the start of the login function in&nbsp;usersController.php.<pre class="ql-syntax" spellcheck="false">$this-&gt;_autoLogin();
</pre>and add the below function to&nbsp;usersController.php<pre class="ql-syntax" spellcheck="false">function _autoLogin()
{
 if ($this-&gt;Cookie-&gt;read('connects')) {
 $user = $this-&gt;Users-&gt;findByHash($this-&gt;Cookie-&gt;read('connects'))-&gt;first()-&gt;toArray();
 $this-&gt;_setAutoLogin($user['id']);
 $this-&gt;Auth-&gt;setUser($user);
 
 return $this-&gt;redirect(['controller' =&gt; 'pages', 'action' =&gt; 'home']);
 } else {
 return false;
 }
}
</pre>See, it was that simple. If you any query or suggestion regarding the issue feel free to comment.

Although the authentication component of CakePHP 3 has made the life of a developer much easier but still there are some functionalities that are still needed to be done manually. One of them is login automatically if the users have checked for 'remember me'.

Cristeena Documentation

Table of Content

Installation

Configuration

Installation

Cloning

Composer

Configuration