forked from mariuswilms/media
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
127 lines (95 loc) · 4.43 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
xx xx xxxx xxx x xxx
x x x x x x x x x x x
x x xxxx xxx x x x
Plugin for CakePHP
---- A CakePHP plugin enabling transfer/manipulation/embedding
of files in 23 ways.
Synopsis
--------
This plugin was conceived as a thorough solution to all the needs coming from
dealing with media files in a web application. Moreover the idea is to show
how much a well maintained plugin can be worth it and inspire others to do the
same. The plugin slowly evolved (and in fact still does) from a very distinct
set of tightly coupled components into something much more flexible. This
allows you to use only the functionality you really need.
Status
------
Originally written for CakePHP 1.2 and 1.3 and maintained since as early as
2007 this project keeps on moving slowly but steady.
Versions compatible with CakePHP 1.3 are actively maintained and developed.
There will be no a port of it lead by myself - yet - to make it compatible
with CakePHP 2.x or any future version thereafter.
Installation
------------
Add the plugin as a submodule to an exisiting app repository.
$ cd /path/to/project
$ git submodule add \
https://github.com/davidpersson/media.git \
app/plugins/media
$ git submodule update --init --recursive
In order to bootstrap, load the plugin's configuration file; preferably from
within your app's main configuration file (config/core.php) like this:
// ...
require APP . 'plugins/media/config/media.php';
// ...
Documentation
-------------
A FAQ, migration instructions and a tutorial are available in the `docs/`
subdirectory. For more information consult the API documentation in the
source code.
Getting Help
------------
You can post questions regarding the usage of the plugin to the very active
Official CakePHP Mailinglist (http://groups.google.com/group/cake-php). When
question are answered there it helps everybody reading the list.
Commercial support is available. You may book me for paid professional
support. Contact me for more details: [email protected]
For bugs please do not mail me directly, but use the project's issue tracker
instead: https://github.com/davidpersson/media/issues
Authors
-------
See the AUTHORS file.
Copyright & License
-------------------
Media Plugin for CakePHP is Copyright (c) 2007-2013 David Persson
if not otherwise stated. The code is distributed under the terms
of the MIT License. For the full license text see the LICENSE file.
Versions & Requirements
-----------------------
1.4.0, CakePHP 1.3.x, PHP >=5.4.0 (in progress)
1.3.0, CakePHP 1.3.x, PHP >=5.2.1
0.6.x, CakePHP 1.2.x, PHP >=5.1.0
0.5.x, CakePHP 1.2.x, PHP >=5.1.0
Please see the corresponding docs/CHANGES-*.x file for
migration and update instructions.
The plugin is known to run fine under linux and darwin. There exist some
issues on windows (http://github.com/davidpersson/media/issues#issue/8), though.
History
-------
This plugin has originally written for CakePHP 1.2 and 1.3 and maintained since
as early as 2007. It forms my very first successful open source project. It's
originally been written to scratch my own itch, namely http://npiece.com.
With version 1.3.0, the plugin comes bundled with the mm library replacing
classes related to media processing, metadata and MIME-types. Please see
the documentation of the mm library (https://github.com/davidpersson/mm)
for additonal requirements and information.
Versions prior to 1.3.0 used to follow a different naming scheme. This has
been changed in retrospect (i.e. 0.6x is now known as 0.6.x) in order to make
a clean and comprehensible chronology.
In 2012 I've stopped maintaining this plugin as I saw myself overwhelmed with
the task of both moving the project forward, making it compatible to future
CakePHP versions.
In 2013 I've restarted maintaining this plugin with a narrowed down roadmap. I
figured out if I'd just support 1.3 for now and all in all move a bit more
slow - I could still keep on maintaining.
I'm seeing how this plugin is adding missing functionality to the CakePHP
universe and indeed useful to a lot of CakePHP users.
Thanks for all the discussion surrounding this plugin,
the support, watching, following and contributions!
Future
------
To keep maintainance cost low this plugin will try to reduce framework specific
code and re-use external libraries. Sometimes what appears to be framework
specific can be made generic and extracted into such an external library.
Parts of this plugin have already been extracted and live under:
https://github.com/davidpersson/mm