Subversion Repositories regexpline_backup

[/] [stable/] [3.0/] [docs/] [readme.txt] - Blame information for rev 3

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 3 xrow
Datatype extension for eZ publish 4.x (License: GPL)
2
----------------------------------------------------
3
 
4
Provides a regular expression datatype for eZ publish.
5
 
6
 
7
What is it?
8
-----------
9
For end users it will look like the standard "Text line" datatype that ships with eZ publish.
10
 
11
The biggest difference is that the input will be validated against a regular expression. This enables you to make sure the input meets certain criteria.
12
 
13
It can act like a regular "Text line" datatype by allowing all input (regexp: /.*/).
14
 
15
 
16
Features
17
--------
18
A number between square brackets denotes the version number where said feature has been introduced.
19
If no indication is present, version 1.0 contains the feature.
20
 
21
- Check user input against a regular expression (Perl-compatible)
22
- Ability to specify multiple regular expression [2.0]
23
- Use regular expression subpatterns to be able to use parts of the input in the object name pattern
24
- Ability to customise the text that will be used in the object name pattern [1.1]
25
- Ability to supply a help text for users
26
- Required checks compatible with newer eZ publish versions (drafts ignore required fields)
27
- Information collection support
28
- Attribute filtering support
29
- Ability to define preset regular expressions in an ini file
30
- Ability to select multiple presets [2.0]
31
- Ability to specify an error message per regular expression / preset [2.0]
32
- Ability to display the datatype as a single text line or as a textarea (object edit) [2.0]
33
- Ability to negate regular expressions and presets [2.1]
34
- Support for has_content in templates [2.1]
35
- Stripping of tags with possibility to disable the stripping via the ini file [2.2]
36
- Control the size of both a text line and a text area in content/edit [2.2]
37
- Error messages in case class validation fails [2.3]
38
- Contentclass import & export
39
- i18n support
40
- PHP5 support for eZ Publish 4.x [3.0]
41
 
42
 
43
Information
44
-----------
45
While editing a contentclass, you will be able to define how the content of a regexpline attribute will be validated.
46
 
47
You can choose two paths:
48
  1. Enter regular expressions directly in the class.
49
  2. Select one or more presets which have been defined in an INI file.
50
 
51
Path 1 is pretty straightforward. The interface will tell you what you can do. Each regular expression you enter can
52
have an error message that describes what should be done to meet the criteria. If you specify multiple regular expressions,
53
the input must match all three expressions.
54
 
55
Path 2 reads the settings from an INI file. You can define as many regular expressions provided you give each of them a
56
unique identifier. With that very same identifier, you can build and array of error messages too. This way, you can accomplish
57
the same thing as in Path 1 (custom messages per regular expression).
58
 
59
Something specific for Path 2 is if the regular expression is negated afterwards (input must NOT match the expression). The datatype
60
will then look for the error message identifier by the regular expression's unique identifier concatenated with '_negate'. This is of
61
course not needed if you take Path 1 (the regular expression will always be negated for that attribute and the error message can be
62
constructed to reflect that).
63
 
64
Any subpatterns in the regular expressions chosen for an attribute will be available for use in the object name pattern. The datatype
65
allows you to construct a custom string of these subpatterns. The custom string will then be used in real object name pattern if you
66
construct the contentclass to do so.
67
 
68
 
69
Planned Features
70
----------------
71
These features are NOT available yet, but they're coming.
72
 
73
No planned features at the time of writing
74
 
75
 
76
Requirements
77
------------
78
- A suitable eZ publish version: 4.0.
79
- Knowledge of Perl Compatible Regular Expression syntax (http://www.php.net/manual/en/ref.pcre.php)
80
 
81
 
82
Installation
83
------------
84
You can always find the latest version of this extension @
85
http://pubsvn.ez.no/community/trunk/extension/regexpline
86
 
87
If you can't use SVN, you can also download the most recently released version from the Contributions section @
88
http://ez.no/community/contribs
89
 
90
- Extract or checkout the regexpline extension into the eZ publish 'extension' folder
91
- Activate the extension by means of the admin interface or by adding
92
 
93
  ActiveExtensions[]=regexpline
94
 
95
  to [ExtensionSettings] in site.ini.append(.php)
96
- Clear the template override cache to make sure eZ publish picks up the templates in the extension.
97
 
98
 
99
Bugs? Comments? Wishes?
100
-----------------------
101
- Bugs: If you report a bug, please make sure you have a minimal testcase so I can reproduce the problem.
102
  If I can't reproduce it, I can't fix it.
103
 
104
- Comments: Nothing special here :)
105
 
106
- Wishes: Please provide a clear description.
107
 
108
Direct all (fan|bug|wish)mail at: hans <dotty> melis <atty> gmail <dotty> com
109
 
110
Please note that this datatype has been developed in my spare time, and is supplied as is. I'm not responsible for any data loss or failures. YMMV!
111
 
112
 
113
Tips & Tricks
114
-------------
115
1. If you want to refer to the complete text that matched the regular expression in the object name pattern, you can use <0> as tag.
116
 
117
 
118
Copyright
119
---------
120
 
121
Regular Expression datatype for eZ publish 4.x
122
Copyright (C) 2005-2008  Hans Melis
123
 
124
This program is free software; you can redistribute it and/or modify
125
it under the terms of the GNU General Public License version 2 as
126
published by the Free Software Foundation.
127
 
128
This program is distributed in the hope that it will be useful,
129
but WITHOUT ANY WARRANTY; without even the implied warranty of
130
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
131
GNU General Public License for more details.
132
 
133
You should have received a copy of the GNU General Public License
134
along with this program; if not, write to the Free Software
135
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA