Main Bundle to provide YUI based editorial/admin UI for eZ Platform v1 on top of REST API (In v2 replaced by ezplatform-admin-ui, a pure symfony based admin ui)
JavaScript HTML CSS PHP Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
ApplicationConfig Merge branch '1.13' into 2.0 Feb 1, 2018
Controller Merge branch '1.13' into 2.0 Mar 19, 2018
DependencyInjection Merge branch '1.13' into '2.1' May 18, 2018
EventListener EZP-26600: Added a PjaxRequestMatcher Nov 28, 2016
Features [TRAVIS] Exclude tests from EZP-29193 from running on Varnish May 17, 2018
Helper Fix Bower install on travis and php_cs_fixer (#910) Oct 12, 2017
Http EZP-26600: Added a PjaxRequestMatcher Nov 28, 2016
Loader EZEE-1850: Supplement for #945 (#948) Feb 7, 2018
Matcher EZP-26719 : Implement pjax view matcher Dec 7, 2016
Notification EZP-28425: Removes unused FormProcessors, Controllers and fixes Notif… Dec 7, 2017
Resources Merge remote-tracking branch 'origin/1.13' Jul 6, 2018
Rest EZP-29106: Show author name in version list / draft conflict dialog (#… May 8, 2018
Tests Merge branch '1.7' into 1.13 Jul 2, 2018
Translation EZP-26835 : HandleBarsFileVisitor fix translation with variable as tr… Jan 16, 2017
Twig Ran php-cs-fixer after ezrobot update Mar 21, 2017
bin [TRAVIS] Exclude tests from EZP-29193 from running on Varnish May 17, 2018
docs EZP-23022: Added the Content Type icons Jun 8, 2016
.bowerrc Fix EZP-21810: Setup bower to install dependencies of the Editorial I… Oct 24, 2013
.ez.yml [dependencies] bumped to 1.3.x-dev Mar 21, 2016
.gitignore Alphabetized gitignore and added IDE rules Nov 3, 2016
.nvmrc Fix Bower install on travis and php_cs_fixer (#910) Oct 12, 2017
.php_cs [CS] Aligned php-cs-fixer config with changes from v2.7.1 (#911) Oct 13, 2017
.travis.yml [TRAVIS] Update job matrix for v2 May 18, 2018
EzSystemsPlatformUIBundle.php EZP-29106: Show author name in version list / draft conflict dialog (#… May 8, 2018
Gruntfile.js EZP-26240: Update te editing UI with server side validation Oct 10, 2016
LICENSE Update LICENSE Feb 2, 2017
README.md Updated license badge in README (#944) Jan 22, 2018
behat_suites.yml BDD: change behat.yml into behat_suites.yml Jan 18, 2016
bower.json Merge branch '1.7' into 1.13 Mar 16, 2018
composer.json Merge branch '1.13' into '2.1' May 18, 2018
jshint.json EZEE-1812: eZPlatform EE v2 improvements (#929) Dec 15, 2017
package.json travis - fix for jshint version (#916) Nov 9, 2017
phpunit.xml EZP-26128: Ensured tests are run with full error reporting Aug 16, 2016
yuidoc.json Synchronize yuidoc.json and Gruntfile.js Dec 10, 2015

README.md

Platform UI Bundle

Build Status Downloads Latest release License

PlatformUIBundle is a bundle for eZ Platform providing a web application to manage your content and administrate your eZ Platform install.

If you find a bug, please create an issue in JIRA and don't forget to add as much details as you can (steps to reproduce, OS and browser(s) versions, ...) and to put PlatformUI (Admin UI & Content IU) in the Component/s field. Before submitting an issue you can also consult the list of opened bugs or the complete list of reported bugs, improvements or stories.

If you discover a security issue, please see how to responsibly report such issues on https://doc.ez.no/Security

Installation

eZ Platform 1.0 (2015.11) or higher are required to run the PlatformUI.

PlatformUI and its dependencies are installed and setup by default in eZ Platform. To run PlatformUI, you just have to open http://[uri_of_ez]/ez in your favorite browser.

If for whatever reason, PlatformUIBundle is not installed, here is what you need to do:

  • From your eZ Platform installation, run composer:

    $ composer require ezsystems/platform-ui-bundle:dev-master
    
  • In app/AppKernel.php add an instance of the following classes to the list of registered bundles:

    public function registerBundles()
    {
        $bundles = array(
            // enabled bundles
            // ...
    
            new EzSystems\PlatformUIBundle\EzSystemsPlatformUIBundle(),
            new EzSystems\PlatformUIAssetsBundle\EzSystemsPlatformUIAssetsBundle(),
            new EzSystems\RepositoryFormsBundle\EzSystemsRepositoryFormsBundle(),
        );
    }
  • In app/config/routing.yml include the eZPlatformUIBundle routing configuration:

    _ezpublishPlatformUIRoutes:
        resource: "@eZPlatformUIBundle/Resources/config/routing.yml"
  • Make sure the REST API is configured to use the session based authentication.

  • Run the following command:

    $ php app/console assets:install --symlink
    

If you are running eZ Platform in the prod environment, you also need to dump the assets for Assetic with:

php app/console assetic:dump --env=prod

Once this is done, you can go to http://[uri_of_ez]/ez to run the eZ Platform UI application.

Developers tasks

Most developer related tasks can be run with Grunt and have several additional dependencies:

  • Install grunt, yuidoc, bower and grover globally (usually you need to be root):

    # npm install -g grunt-cli yuidocjs grover bower gulp
    
  • Install phantomjs version 1.9.x

  • Install local npm and bower dependencies, from the bundle root, run:

    $ npm install
    $ bower install
    

Once this is done, you can use any tasks registered in Grunt, the most interesting are:

  • Running the JavaScript unit tests

    $ grunt test
    
  • Running a single JavaScript unit test

    $ grover --server --console Tests/js/foo/bar/somefile.html
    
  • Generate a code coverage from those tests:

    $ grunt coverage
    

    The HTML coverage report is then available in Tests/report/lcov-report/index.html.

  • Generate the JavaScript API doc:

    $ grunt doc
    
  • Alternatively, you can run a live documentation server that will be available at http://127.0.0.1:3000 :

    $ grunt livedoc
    
  • Update the custom AlloyEditor skin:

    $ composer install # or composer update
    $ cd vendor/ezsystems/platform-ui-assets-bundle/Resources/public/vendors/alloy-editor/
    $ npm install
    $ cd -
    $ grunt alloy-css
  • To test updating custom AlloyEditor skin against custom platform-ui-assets-bundle builds:

    $ composer install --prefer-source
    $ cd vendor/ezsystems/platform-ui-assets-bundle/
    $ git checkout <your_branch>
    $ ./bin/prepare_release.sh -v X.Y.X
    $ git checkout vX.Y.X
    $ echo -e `cd Resources/public/vendors/alloy-editor/ && npm install`
    $ cd -
    $ grunt alloy-css

To run the PHP unit tests, you first need to install the dev dependencies of the bundle. To do that, from the bundle root, run:

$ composer install --prefer-dist

Then, you can run the unit tests with:

$ php vendor/bin/phpunit