Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Migrate to ZendFramework to Symfony #66

Draft
wants to merge 53 commits into
base: master
Choose a base branch
from
Draft

Migrate to ZendFramework to Symfony #66

wants to merge 53 commits into from

Conversation

adamfranco
Copy link
Member

Fixes #47.

@adamfranco
#47: Add symfony framework structure and remove phpcas.
34206ce 
Generated with
    composer create-project symfony/skeleton:"6.4.*" catalog-symfony
then manually merged into the application directory.
@adamfranco
Add default .htaccess with composer require symfony/apache-pack.
baa8acc
@adamfranco
#47: Move the Catalogs controller into the Symfony structure.
80958b0
@adamfranco
#47: Remove +SymLinksIfOwnerMatch directive that is breaking on tobog…
c9c5d4c 
…gan.
@adamfranco
#47: Wire up a new osid.runtime service to access the OSID API.
1021e45
@adamfranco
#47: Use PSR-0 autoloading for osid-phpkit.
c3ef1d0
@adamfranco
#47: Use PSR-0 autoloading for existing code in application/library/
7dc2c46 
For now we can skip any reorganization, addition of namespaces, and other
refactoring of the main data model while getting controllers and views
ported over to Symfony.
@adamfranco
#47: Add symfony/twig-bundle for rendering suppport.
397f6ec
@adamfranco
#47: Build out catalog listing template and action.
2f817fd
@adamfranco adamfranco self-assigned this Sep 26, 2024
@adamfranco
Add Lando config to set up local dev environment.
7d015db
@adamfranco
#47: Add PHPUnit as a dev dependency.
3a90230
@adamfranco
#47: Change the database to mariadb to mirror prod.
3357430
@adamfranco
#47: Convert id-subcomponent separator from '/' to '.'.
8336afc 
The use of '/' as a separator in subcomponents turned out to be a bad idea
because these slashes need to be escaped as %2F, but these escaped slashes
can interfere with some webserver configuration.

For example Apache redirects require the NE "No Escape" option to preserve
%2F slashes without double-escaping:

    # Redirect all traffic to https
    #
    # We're using mod_rewrite here rather than mod_alias's `Redirect`
    # because mod_alias doesn't allow the "NE" == "noescape" parameter
    # that allows URLs includinging encoded slashes (%2F) to be returned
    # without double-escaping.
    RewriteRule .* https://<%= node["app_domain"] %>$0 [L,R=301,NE]

Similarly, Symfony refuses to allow slashes in parameters passed as tokens
in routes.

To address this problematic choice, use '.' as a separator of
sub-components in identifiers. Periods don't require special escaping in
URLs or database queries, though they do in regular expressions.
@adamfranco
Add phpmyadmin to local development environment.
4086f33
@adamfranco
#47: Use pre-existing 'test' database available in local dev environm…
2fc1b25 
…ent.
@adamfranco
#47: Fix Deprecated array access of boolean value error.
ec5c0fa
@adamfranco
Provide access to the database for test fixture setup/cleanup.
93a1767
@adamfranco
#47: Update id-subcomponent separators missed in 8336afc
ed320b8
@adamfranco
#47: Get the Catalog list working with a redirect to offering search.
1980c91 
Other actions are still a work in progress.
@adamfranco
#47: Port the offering view action.
7fdc42e
@adamfranco
#47: Add twig extensions to allow building of URLs from osid_Id objects.
024361b
@adamfranco
#47: Ensure that the FSMParser and Harmoni Primitives classes are ava…
77e1356 
…ilable
@adamfranco
#47: Use subdirectories for template files to aid organization.
df1de2c
@adamfranco
#47: Add single-section XML view.
4cb5999
@adamfranco
#47: Reorganize offering XML template code into a self-contained part…
f2c7e69 
…ial.
@adamfranco
#47: Reorganize internal methods to the end of the class.
2885b60
@adamfranco
#47: Add single course view.
6a202bd
@adamfranco
#47: Add single-course XML view.
d1c7415
@adamfranco
#47: Add course list action.
c4da8cf
@adamfranco
#47: Migrate courses by id XML action.
bfc3eb2
@adamfranco
#47: Update courses by id XML action to match values currently in out…
7d03296 
…put.
@adamfranco
#47: Port courses by topic xml action.
f987c56
@adamfranco
#47: Ensure that unknown topics don't fully crash the courses-by-topi…
3b53795 
…c feed
@adamfranco
#47: Port the courses/instructorxml endpoint.
9ac780c
@adamfranco
#47: Improve method documentation.
72146b2
@adamfranco
#47: Port the course/searchxml endpoint.
4d1e7b9
@adamfranco
#47: Ensure classes in the global namespace are referenced properly.
1a2c390
@adamfranco
#47: Reorganize methods to put routes together. Remove old XML printer.
fe5769a
@adamfranco
#47: Complete method documentation.
376a1f8
@adamfranco
#47: Initialize all of the types used by offering search in the const…
b86f16a 
…ructor
@adamfranco
#47: Improve helper method documentation for Offerings controller.
b9e1adf
@adamfranco
#47: Port offering searchxml endpoint.
d759801
@adamfranco
#47: Port course offering search form. Result printing still to do.
7866336
@adamfranco
#47: Port the CourseOffering search page.
05149d3
@adamfranco
#47: HTML pages now extend the base.html.twig template.
df327e5
@adamfranco
#47: Add the symfony debug pack with profile tools.
ea239af 
As recommended in
	https://symfonycasts.com/screencast/symfony/profiler
@adamfranco
#47: Make the symfony console executable.
d3cc113
@adamfranco
#47: Add the symfony/asset-mapper component to reference images/CSS/JS.
fe964e3 
Recommended in https://symfonycasts.com/screencast/symfony/asset-mapper
@adamfranco
#47: Add jquery & jquery-expander to search results for long descript…
2b44014 
…ions.

As described in
    https://symfony.com/doc/current/frontend/asset_mapper.html#importing-3rd-party-javascript-packages
the library was added to `assets/vendor/` with:
    bin/console importmap:require jquery-expander
@adamfranco
#47: Add SAML authentication via nbgrp/onelogin-saml-bundle.
1694994
@adamfranco
#47: Fix undefined parameters when search form is loaded without args.
41b8231
@adamfranco
#47: Migrate bookmarks control, add Doctrine/DBAL for database access.
3d55d0a
@adamfranco
#47: Pass a returnTo parameter through the login flow.
18101b0 
This isn't ideal as a session gets created before authentication is
successful, preventing some anonymous requests from getting anonymous
responses from cache. There may be better ways to do this, but this is a
starting point.

See discussion at nbgrp/onelogin-saml-bundle#26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@adamfranco adamfranco

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Upgrade from ZendFramework 1
1 participant
@adamfranco