Skip to content

Latest commit

 

History

History
370 lines (339 loc) · 17.7 KB

zf-level-1-feb-2018.md

File metadata and controls

370 lines (339 loc) · 17.7 KB

ZEND FRAMEWORK FUNDAMENTALS I -- Course Notes

Left Off With: http://localhost:9999/#/9/18

NOTE TO SELF: rephrase http: refs to PDF page #

GENERAL NOTES

  • To view PHP errors:
tail /var/log/apache2/error.log

HOMEWORK

  • Tue 20 Feb 2018
    • Lab: Forms
      • form layout == form view template
      • for PostController: if "$form->isValid()" returns false, DO NOT redirect!!! Let it "drop through" and re-display the form.
      • Good to know the database structure:
 CREATE TABLE `listings` (
  `listings_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `category` char(16) NOT NULL,
  `title` varchar(128) NOT NULL,
  `date_created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `date_expires` timestamp NULL DEFAULT NULL,
  `description` varchar(4096) DEFAULT NULL,
  `photo_filename` varchar(1024) DEFAULT NULL,
  `contact_name` varchar(255) DEFAULT NULL,
  `contact_email` varchar(255) DEFAULT NULL,
  `contact_phone` varchar(32) DEFAULT NULL,
  `city` varchar(128) DEFAULT NULL,
  `country` char(2) NOT NULL,
  `price` decimal(12,2) NOT NULL,
  `delete_code` char(16) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT NULL,
  PRIMARY KEY (`listings_id`),
  KEY `title` (`title`),
  KEY `category` (`category`),
  KEY `delete_code` (`delete_code`)
) ENGINE=InnoDB AUTO_INCREMENT=53 DEFAULT CHARSET=utf8
  • Fri 16 Feb 2018
    • Lab: Manipulating Views and Layouts
  • Wed 14 Feb 2018
    • Lab: Creating and Accessing a Service
      • Step 3: consider creating a trait w/ property and method for categories
      • Array of categories for your use:
'barter',
'beauty',
'clothing',
'computer',
'entertainment',
'free',
'garden',
'general',
'health',
'household',
'phones',
'property',
'sporting',
'tools',
'transportation',
'wanted'

  • Mon 12 Feb 2018

    • Lab: Using a Built-in Controller Plugin
      • Modify Step 2 as follows:
      • Within the indexAction() method, write an if statement that tests on a user being logged in based on the value of a $_GET param isLoggedIn
    • Lab: Using a Custom Controller Plugin
      • Directory s/be "Plugin" (note: uppercase "P")
    • Lab: New Controllers and Factories
      • Only need to define template_path_stack once per module!

  • Fri 9 Feb 2018

    • Lab: MVC Basics Lab == New Module

  • Web 7 Feb 2018

    • Lab: New Project

Q & A

    Controller\PostController::class => InvokableFactory::class,
    PostController::class => Controller\Factory\PostControllerFactory::class,
    Controller\PostController::class => Controller\Factory\PostController::class,

use Market\Controller;
echo PostController::class; // produces: 'Market\Controller\PostController
  • So, if in the module.config.php file you have this:
use Market;
  • then this command:
echo Controller\PostController::class;
  • will produce: Market\Controller\PostController
  • Likewise, if you have this statement:
use Market\Controller;
  • then this command:
echo PostController::class;

  • will produce the same thing: Market\Controller\PostController

  • Now ... to address the difference between the factories:

  • InvokableFactory::class is included with ZF and simply produces an instance of the class. This works OK if the instance you wish to produce has no dependencies. For example, a Controller class which does not use any other services, can be built using InvokableFactory::class.

  • On the other hand, if there are any external classes needed by the controller (e.g. the controller needs to do a database lookup, and thus needs a model class which gives it access to the database), then you'll need to define a custom factory class which creates the controller and either provides the dependencies as constructor arguments, or uses a "setXXX()" method to inject the needed object.

  • There is no requirement for a custom factory class to either have the word "Factory" in its classname, nor is there a need to have this class reside in a "Factory" namespace. On the other hand, it is considered a best practice to identify the class as a factory class by doing either of these two things.

  • Q: Is there a quick way to generate basic factories?

  • A: You can use the command line tool vendor/bin/generate-factory-for-class.

    • So, to create the IndexControllerFactory for example:
cd ~/Zend/workspaces/DefaultWorkspace/onlinemarket.work
vendor/bin/generate-factory-for-class "Market\\Controller\\IndexController"
  • You can then use > to redirect output to the appropriate factory class.

NOTES ON SLIDES

http://onlinemarket.work/

AUTOLOADING FOR ZF 2

LAB NOTES

  • Creating the Project:
    • From Bryant: When installing ZF, Composer gives me a list of "Do not inject", "config/modules.config.php", and "config/development.config.php.dist". Which answer is the correct one? I would have thought "both", but that isn't a choice.
    • The best answer, IMHO, is #1. What happens in that case is that Composer automatically updates the list of modules to be loaded. In the case of ZF3, some modules are not automatically initialized if they're outside the "standard" ones included in the skeleton application. Because in the lab you were instructed to add other modules to composer.json, which are not part of the defaults for the skeleton app, Composer wants to make sure these modules are properly initialized.
    • Ref for the skeleton app: https://framework.zend.com/downloads/skeleton-app
  • Lab: Create a New Module
    • In the Module.php you'll need to add a method getConfig() which returns the value from Market/config/module.config.php file
    • In Market/config/module.config.php file
      • Make sure the module namespace is at the top:
namespace Market;

* Activate the new controller as follows:

use Zend\ServiceManager\Factory\InvokableFactory;
return [
    // NOTE there is other config you need to do: i.e. adding a route
    //      look into `Application/config/module.config.php` for clues
    'controllers' => [
       'factories' => [
          Controller\IndexController::class => InvokableFactory::class,
        ],
    ],
];
  • Lab: Creating and Accessing a Service:
    • The suggestion for IndexController::indexAction() should include the following:
return new ViewModel(['categories' => $this->categories]);
  • Note the array syntax, where the array key categories becomes a variable in the view template

Updated New Module Lab:

Lab: Create a New Module

In this lab, we're going to create a new module Market:

  • Create a bare minimum module Market following the guidelines discussed.
  • Enable the module.
  • Configure the module for autoloading. Don't forget to run either composer update or composer dump-autoload after changes are made.

IMPORTANT: do not forget to update the filesystem permissions if needed! HINT: Reference the onlinemarket.complete or guestbook projects if you get stuck.

Lab: Create a New Controller

In this lab, we're going to create a new controller Market\Controller\IndexController:

  • Create a PHP file which defines a controller class Market\Controller\IndexController
  • Define a public method indexAction() which returns an instance of Zend\View\Model\ViewModel containing an array of sample data.
  • In the Market module's configuration file Market/config/module.config.php do the following:
    • Register the controller using InvokableFactory
    • Add a route to the new controller and action

Lab: Create a View Template

In this lab, we're going to create a view template which matches the IndexController::indexAction()

  • Create a directory structure /path/to/onlinemarket.work/module/Market/view/market/index
  • Create a template file index.phtml in the newly created folder
  • Echo the values of the variables passed by the view model
  • Modify index.phtml and escape the output variables using the escapeHtml() view helper, i.e. $this->escapeHtml()
  • Allow the view manager to locate your new templates by updating the module.config.php::view_manager::template_path_stack

You can now test your changes from the browser included in the VM by entering this URL: http://onlinemarket.work/market

If everything looks good, great!, you're ready to move forward, otherwise check everything again and test.

VM NOTES

guestbook project

  • Need to update the database structure:
    • From the browser go to http://localhost/
    • Select phpMyAdmin
    • Select guestbook
    • Select SQL
    • Paste in the following:
CREATE TABLE `entry` (
  `id` int(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `email` varchar(255) NOT NULL,
  `website` varchar(255) NOT NULL,
  `message` text NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  • To test:
    • From the browser: http://guestbook/guestbook
    • Enter the requested info and post
    • Check to make sure your entry has been posted

DAY ZERO

  • Sample out for vagrant up
$ vagrant up
Bringing machine 'default' up with 'virtualbox' provider...
==> default: Box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP' could not be found. Attem                                                                     pting to find and install...
    default: Box Provider: virtualbox
    default: Box Version: 1.0.2
==> default: Loading metadata for box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP'
    default: URL: https://vagrantcloud.com/datashuttle/RWZ-Ubuntu-16.04LTS-DTP
==> default: Adding box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP' (v1.0.2) for provi                                                                     der: virtualbox
    default: Downloading: https://vagrantcloud.com/datashuttle/boxes/RWZ-Ubuntu-                                                                     16.04LTS-DTP/versions/1.0.2/providers/virtualbox.box
==> default: Box download is resuming from prior download progress
    default:
==> default: Successfully added box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP' (v1.0.                                                                     2) for 'virtualbox'!
==> default: Importing base box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP'...
==> default: Matching MAC address for NAT networking...
==> default: Checking if box 'datashuttle/RWZ-Ubuntu-16.04LTS-DTP' is up to date                                                                     ...
==> default: Setting the name of the VM: ZFF1 - Provisioning
==> default: Clearing any previously set network interfaces...
==> default: Preparing network interfaces based on configuration...
    default: Adapter 1: nat
==> default: Forwarding ports...
    default: 80 (guest) => 8084 (host) (adapter 1)
    default: 22 (guest) => 2222 (host) (adapter 1)
==> default: Running 'pre-boot' VM customizations...
==> default: Booting VM...
==> default: Waiting for machine to boot. This may take a few minutes...
    default: SSH address: 127.0.0.1:2222
    default: SSH username: vagrant
    default: SSH auth method: private key
    default:
    default: Vagrant insecure key detected. Vagrant will automatically replace
    default: this with a newly generated keypair for better security.
    default:
    default: Inserting generated public key within guest...
    default: Removing insecure key from the guest if it's present...
    default: Key inserted! Disconnecting and reconnecting using new SSH key...
==> default: Machine booted and ready!
==> default: Checking for guest additions in VM...
    default: The guest additions on this VM do not match the installed version o                                                                     f
    default: VirtualBox! In most cases this is fine, but in rare cases it can
    default: prevent things such as shared folders from working properly. If you                                                                      see
    default: shared folder errors, please make sure the guest additions within t                                                                     he
    default: virtual machine match the version of VirtualBox you have installed                                                                      on
    default: your host and reload your VM.
    default:
    default: Guest Additions Version: 5.1.30
    default: VirtualBox Version: 5.2
==> default: Setting hostname...
==> default: Mounting shared folders...
    default: /home/vagrant/Shared => D:/VM/ZF-Level-1
==> default: Running provisioner: shell...
    default: Running: C:/Users/george/AppData/Local/Temp/vagrant-shell20180202-2                                                                     760-1mlennp.sh
    default: Provisioning course projects...
    default: [DONE: Provisioning course project(s)]
==> default: Running provisioner: shell...
    default: Running: C:/Users/george/AppData/Local/Temp/vagrant-shell20180202-2                                                                     760-1vxbs0m.sh
    default: Provisioning virtual hosts for the project...
    default: [DONE: Provisioning virtual hosts]
==> default: Running provisioner: shell...
    default: Running: inline script
==> default: Running provisioner: shell...
    default: Running: C:/Users/george/AppData/Local/Temp/vagrant-shell20180202-2                                                                     760-13c1p1k.sh
    default: Bootstrap the course MySql database...
    default: Creating database for guestbook and populating
    default: Creating database for onlinemarket and populating
    default: [DONE: Provisioning course MySQL DB]
==> default: Running provisioner: shell...
    default: Running: C:/Users/george/AppData/Local/Temp/vagrant-shell20180202-2                                                                     760-s5oyuq.sh
    default: Provisioning environment...
    default: [DONE: Provisioning environment]
==> default: Running provisioner: shell...
    default: Running: C:/Users/george/AppData/Local/Temp/vagrant-shell20180202-2                                                                     760-1tlezmr.sh
    default: Provisioning general cleanup detail...
    default: [DONE: Provisioning cleanup]