ckornell / php7-cascade-ws-ns

The reusable code library for Cascade web services written in PHP 7.

php7-cascade-ws-ns

My Cascade web service library, using namespaces, written in PHP 7 for Cascade 8.4.1, Cascade 8.5, and Cascade 8.6. Since the current working version is 8.6, I will not update 8.4.1 and 8.5 anymore.

Note that since I do not work with cloud transport at Upstate and there is no way for me to test such a transport, I do not provide the CloudTransport class, though it is not hard to implement.

Last modified: 9/18/2017, 11:30 AM

Note that new code related to editor configurations does not work, due to a bug in Cascade.

This version of the library makes use of features in PHP 7.

Purpose of the Upgrade

The library has been upgraded to PHP 7 for two main reasons:

• When using parameter types and return types, I can have tighter control over client code
• I can use the type information, together with the ReflectionUtility class, to generate documentation pages; for an example of a generated page, see http://www.upstate.edu/cascade-admin/web-services/api/asset-classes/asset.php

When a class is upgraded with required information, the following type of code is made possible:

echo u\ReflectionUtility::getClassDocumentation( "cascade_ws_asset\Asset", true );
u\ReflectionUtility::showMethodSignatures( "cascade_ws_asset\Asset" );
u\ReflectionUtility::showMethodSignature( "cascade_ws_asset\Asset", "edit" );
u\ReflectionUtility::showMethodDescription( "cascade_ws_asset\Asset", "edit" );
u\ReflectionUtility::showMethodExample( "cascade_ws_asset\Asset", "edit" );

The ReflectionUtility class can also be used to reveal information of any class and any function:

echo u\ReflectionUtility::getMethodSignatures( "SimpleXMLElement", true ), BR;
u\ReflectionUtility::showFunctionSignature( "str_replace", true );

Resources

1. For more information, visit http://www.upstate.edu/web-services/index.php
2. Online tutorials: http://www.upstate.edu/web-services/courses/ws-online-tutorials.php
3. Online tutorial recordings:
   • The first series: https://www.youtube.com/playlist?list=PLiPcpR6GRx5cGyfQESK6ZAj4My8rJidt4
   • The second series: https://www.youtube.com/watch?v=oYndzPxZ7yg&index=1&list=PLXb2nCJdzD9B26kI9vEds-0bQoPSWj5--
4. Examples and recipes: https://github.com/wingmingchan/php-cascade-ws-ns-examples
5. Asset classes API: http://www.upstate.edu/web-services/api/asset-classes/index.php
6. Cascade Web Services courses: http://www.upstate.edu/web-services/courses/index.php
7. Cascade Web Services Library Support: https://groups.google.com/forum/#!forum/cascade-web-services-library-support
8. Erik España: https://github.com/espanae/cascade-server-web-services
9. Mark Nokes: https://github.com/marknokes
10. Christopher John Walsh: https://gist.github.com/quantegy