Skip to content

Update examples.rst #455

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

Merged
josegonzalez merged 2 commits into from
Jun 22, 2017
Merged

Update examples.rst #455

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b277181
Update examples.rst
jorisvaesen Jun 21, 2017
1c9878a
add windows systems workaround
jorisvaesen Jun 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Examples
--------
========

Basic example
-------------
Expand Down Expand Up @@ -164,4 +164,28 @@ This example uses the `default behaviour configuration <configuration.html>`__ u
echo $this->Html->link('../files/example/image/' . $entity->photo_dir . '/' . $entity->photo);
?>

For Windows systems you'll have to build a workaround as Windows systems use backslashes as directory separator which isn't useable in URLs.

.. code:: php

<?php
/*
In the present example, variations on these changes would be made in:
src/Template/Users/view.ctp
src/Template/Users/index.ctp
*/

// assuming an entity that has the following
// data that was set from your controller to your view
$entity = new Entity([
'photo' => 'imageFile.jpg',
'photo_dir' => '7'
]);
$this->set('entity', $entity);

// You could use the following to create a link to
// the image (with default settings in place of course)
echo $this->Html->link('../files/example/image/' . str_replace('\', '/', $entity->photo_dir) . '/' . $entity->photo);
?>

You can optionally create a custom helper to handle url generation, or contain that within your entity. As it is impossible to detect what the actual url for a file should be, such functionality will *never* be made available via this plugin.