Download the PHP package nyco/anyc-field-screener without Composer

On this page you can find all versions of the php package nyco/anyc-field-screener. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of nyco/anyc-field-screener

Informations about the package anyc-field-screener

ACCESS NYC Field Screener

The ACCESS NYC Field Screener is a tablet optimized version of the ACCESS NYC benefits eligibility screener created for outreach caseworkers. It is designed to be filled out for clients in-person or remotely during outreach sessions. The original source code can be found in v3.12.0 of the ACCESS NYC code repository. It has been extracted, modified, and packaged into this plugin.

This code, similar to the original eligibility screener, relies on the program content and benefits screening API proxy inside the ACCESS NYC website in order to provide screening results to the client and caseworker.

More about the Field Screener case study can be read about here.

Installation using Composer

$1 This package uses Composer Installers to install the package in the Must Use plugins directory (/wp-content/mu-plugins):

Autoload Backend

Copy the autoloader sample from the plugin directory into the must use plugin directory.

Or, manually create a page template in the theme directory with the following snippet.

Contents.

Create Routes

Copy the template sample from the plugin directory into the theme directory.

Or, manually create a page template in the theme directory with the following snippet.

Contents.

Optional. A single template will suffice but there are two view routes for the application. The first is a root view and the second is a nested result view. It is possible to use WordPress's page template slug system to create two templates

Add Pages

Add a new page and title it "Field Screener". Then, select the "Field Screener" as a page template and add a shortcode to the post content.

This will render the application's root view at the route /field-screener. Publish the page, then create another page for the results route. It can be titled "Results - Field Screener" but the page slug needs to be results. Select the "Field Screener" as a page template and add a shortcode to the post content.

The page="results" attribute designates the view as the results page. This will render the application's results view at the route /field-screener/results.

Publish the results page. The application will be viewable at /field-screener.

Shortcode Attributes

In addition to page. There are other shortcode attributes that can be set to customize the location and environment of the application.

Attribute Default Value Description
env See below The human readable environment string used in the environment alert to inform users which environment they are viewing.
productionUrl https://access.nyc.gov/eligibility/ This is the application link the environment alert will link users to when the environment's WP_ENV is not set to the production value, accessnyc.
assets /wp-content/mu-plugins/field-screener/assets The path to the application's static assets.
root /field-screener/ The root slug of the application. This should match the WordPress page slug.
results /field-screener/results/ The root slug and results slug for the application. This determines the redirect path from the main screening application to the results page. If the root is changed, this will need to be changed as well. This should match the WordPress page slug.
resultsShare /eligibility/results/ The root slug and results slug for the results page that is shared with users when they text or email results to themselves. This path replaces the results path defined above.
translationID field-screener The string translation template location ID. This is used to scope translations for the application.
page screener Can be set to results to designate the results route.

Environment string defaults

The env string is determined by the WP_ENV constant value. This constant is set in the various environments of the ACCESS NYC site. If the constant isn't defined the string will default to "Unknown."

WP_ENV Value String
accessnyc "Production"
accessnycs "Staging"
accessnycdemo "Demo"
accessnyctest "Testing"
development "Development"

Debugging

Add the ?debug=1 query parameter to the URL to see application logs. This will display data values set to the household model, form validation warnings, and the screening API request object and responses. Set "Preserve Log" to true to retain the response from the application to the results page.

The network panel will also reveal the API request and response information.

The Mayor's Office for Economic Opportunity (NYC Opportunity) is committed to sharing open source software that we use in our products. Feel free to ask questions and share feedback. Interested in contributing? See our open positions on buildwithnyc.github.io. Follow our team on Github (if you are part of the @cityofnewyork organization) or browse our work on Github.

All versions of anyc-field-screener with dependencies

PHP Build Version
Package Version
Requires composer/installers Version ~1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nyco/anyc-field-screener contains the following files

Loading the files please wait ....