package.xml 0000664 0001750 0001750 00000141467 12653734733 011331 0 ustar jan jan
Horde_Kolab_Formatpear.horde.orgKolab_FormatA package for reading/writing Kolab data formats.This package allows converting Kolab data objects from XML to data arrays.Gunnar Wrobelwrobelp@rdus.deyes2016-02-012.0.82.0.0stablestableLGPL-2.1
* [jan] Mark PHP 7 as supported.
5.3.08.0.0alpha18.0.0alpha11.7.0Horde_Exceptionpear.horde.org2.0.03.0.0alpha13.0.0alpha1Horde_Utilpear.horde.org2.0.03.0.0alpha13.0.0alpha1domHorde_Supportpear.horde.org2.0.03.0.0alpha13.0.0alpha1Horde_Testpear.horde.org2.1.03.0.0alpha13.0.0alpha1mbstring1.0.0alpha11.0.0alphaalpha2011-03-10LGPL-2.1
* First alpha release for Horde 4.
1.0.0beta11.0.0betabeta2011-03-16LGPL-2.1
* First beta release for Horde 4.
1.0.0RC11.0.0betabeta2011-03-22LGPL-2.1
* First release candidate for Horde 4.
* [gwr] Moved Horde specific functionality out of the tasks parser.
* [gwr] Moved Horde specific functionality out of the note parser.
1.0.0RC21.0.0betabeta2011-03-29LGPL-2.1
* Second release candidate for Horde 4.
1.0.01.0.0stablestable2011-04-06LGPL-2.1
* First stable release for Horde 4.
1.0.11.0.0stablestable2011-08-11LGPL-2.1
* [gwr] Removed stray kolab-format script which was moved to Horde_Kolab_Cli.
* [gwr] Fixed detecting parse errors in subsequent parse attempts.
1.1.01.1.0stablestable2011-11-12LGPL-2.1
* [gwr] Move Horde specific functionality out of the events parser.
* [gwr] Move Horde specific functionality out of the contacts parser.
* [gwr] Improve data validation.
* [gwr] KEP2 support.
* [gwr] Allow adding XML attributes on the fly.
* [gwr] Avoid overwriting data from other Kolab clients.
* [gwr] Add improved root node handler (version checking, avoids overwriting other data).
1.1.11.1.0stablestable2011-12-16LGPL-2.1
* [gwr] Fixed datatype for birthday and anniversary contact attributes.
* [gwr] Completed missing data API v1 support.
1.1.21.1.0stablestable2012-04-10LGPL-2.1
* [jan] Fix parsing composite phone fields (alexander.haensch@ipc.uni-tuebingen.de, Bug #11047).
2.0.0alpha11.1.0alphastable2012-07-05LGPL-2.1
* First alpha release for Horde 5.
2.0.0beta11.1.0betastable2012-07-19LGPL-2.1
* First beta release for Horde 5.
2.0.0beta21.1.0betastable2012-10-12LGPL-2.1
* [jan] Categories attributes are returned and passed as an array now.
2.0.0RC11.1.0betastable2012-10-26LGPL-2.1
* [jan] Write custom Horde attributes to task objects.
2.0.02.0.0stablestable2012-10-30LGPL-2.1
* First stable release for Horde 5.
2.0.12.0.0stablestable2012-11-19LGPL-2.1
* [jan] Deprecate timezone parameters, always write UTC datetime values (Bug #11695).
2.0.22.0.0stablestable2013-01-09LGPL-2.1
* [jan] Return date-only values as floating dates (Bug #11767).
* [jan] Correctly format all-day events (Bug #11767).
2.0.32.0.0stablestable2013-03-05LGPL-2.1
* [jan] Fix unit tests.
2.0.42.0.0stablestable2013-09-02LGPL-2.1
* [jan] Fix saving all day events when the end date is on the next day (Thomas Jarosch <thomas.jarosch@intra2net.com>, Bug #12627).
2.0.52.0.0stablestable2013-11-19LGPL-2.1
* [jan] Correctly translate display-name attribute of distribution lists.
2.0.62.0.0stablestable2015-01-09LGPL-2.1
* [jan] Improve PSR-2 compatibility.
2.0.72.0.0stablestable2015-04-28LGPL-2.1
* [jan] Fix issues with certain locales like Turkish.
2.0.82.0.0stablestable2016-02-01LGPL-2.1
* [jan] Mark PHP 7 as supported.
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/examples/event.php 0000664 0001750 0001750 00000001710 12653734732 023057 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* The Autoloader allows us to omit "require/include" statements.
*/
require_once 'Horde/Autoloader/Default.php';
/** Create the factory */
$factory = new Horde_Kolab_Format_Factory();
/** Generate the format handler */
$format = $factory->create('Xml', 'Event', array('version' => 1));
/** Prepare a test object */
$object = array(
'uid' => 1,
'summary' => 'test event',
'start-date' => time(),
'end-date' => time() + 24 * 60 * 60,
);
/** Save this test data array in Kolab XML format */
$xml = $format->save($object);
var_dump($xml);
/** Reload the object from the XML format */
$read_object = $format->load($xml);
var_dump($read_object);
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/examples/event_v2.php 0000664 0001750 0001750 00000002021 12653734732 023462 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* The Autoloader allows us to omit "require/include" statements.
*/
require_once 'Horde/Autoloader/Default.php';
/** Create the factory */
$factory = new Horde_Kolab_Format_Factory();
/** Generate the format handler */
$format = $factory->create('Xml', 'Event');
$now = new DateTime();
/** Prepare a test object */
$object = array(
'uid' => 1,
'summary' => 'test event',
'start-date' => array(
'date' => $now,
),
'end-date' => array(
'date' => $now,
)
);
/** Save this test data array in Kolab XML format */
$xml = $format->save($object);
var_dump($xml);
/** Reload the object from the XML format */
$read_object = $format->load($xml);
var_dump($read_object);
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/examples/new_type.php 0000664 0001750 0001750 00000003752 12653734732 023600 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* The Autoloader allows us to omit "require/include" statements.
*/
require_once 'Horde/Autoloader/Default.php';
/**
* Kolab XML handler for a string value
*
* Copyright 2008-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_String extends Horde_Kolab_Format_Xml
{
/**
* Specific data fields for the prefs object
*
* @var Kolab
*/
protected $_fields_specific;
/**
* Constructor
*/
public function __construct($parser, $params = array())
{
$this->_root_name = 'string';
/** Specific preferences fields, in kolab format specification order
*/
$this->_fields_specific = array(
'string' => array(
'type' => self::TYPE_STRING,
'value' => self::VALUE_MAYBE_MISSING,
),
);
parent::__construct($parser, $params);
}
}
/** Create the factory */
$factory = new Horde_Kolab_Format_Factory();
/** Generate the format handler */
$format = $factory->create('Xml', 'String');
/** Prepare a test object */
$object = array(
'uid' => 1,
'string' => 'test string',
);
/** Save this test data array in Kolab XML format */
$xml = $format->save($object);
var_dump($xml);
/** Reload the object from the XML format */
$read_object = $format->load($xml);
var_dump($read_object);
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/examples/speed_check.php 0000664 0001750 0001750 00000002554 12653734732 024202 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* The Autoloader allows us to omit "require/include" statements.
*/
require_once 'Horde/Autoloader/Default.php';
/** Create the factory */
$factory = new Horde_Kolab_Format_Factory();
/** Generate the format handler */
$format = $factory->create('Xml', 'Event');
/** Prepare a test object */
if (!method_exists($format, 'getVersion')) {
$object = array(
'uid' => 1,
'summary' => 'test event',
'start-date' => time(),
'end-date' => time() + 24 * 60 * 60,
);
} else {
$now = new DateTime();
$object = array(
'uid' => 1,
'summary' => 'test event',
'start-date' => array(
'date' => $now,
),
'end-date' => array(
'date' => $now,
)
);
}
$timer = new Horde_Support_Timer();
$timer->push();
for ($i = 0;$i < 1000;$i++) {
/** Save this test data array in Kolab XML format */
$xml = $format->save($object);
/** Reload the object from the XML format */
$read_object = $format->load($xml);
}
var_dump($timer->pop());
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/COPYING 0000664 0001750 0001750 00000057502 12653734732 020454 0 ustar jan jan GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/DOCS_ORIGIN 0000664 0001750 0001750 00000000604 12653734732 021132 0 ustar jan jan ======================
Documentation origin
======================
Some of the Horde component documentation is maintained in the Horde
wiki. The following list indicates the source locations for some of
the files in this directory.
:`doc/Horde/Kolab/Format/README`_: README
.. _doc/Horde/Kolab/Format/README: http://wiki.horde.org/Doc/Dev/HordeKolabFormat?actionID=export&format=rst
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/README 0000664 0001750 0001750 00000000217 12653734732 020270 0 ustar jan jan Fatal error: Call to a member function token() on a non-object in /usr/share/php/Text/Wiki.php on line 1069
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/TODO 0000664 0001750 0001750 00000001035 12653734732 020077 0 ustar jan jan ====================================
Kolab_Format Development TODO List
====================================
- Check kolab/issue4672 (Kolab_Format has encoding problems)
- Check kolab/issue4700 (Kolab_Format problems in e-mails fetching process)
- Developer documentation
- Test coverage
- PHPdoc check
- Additional KEPs
- ...
- Do not overwrite multiple entries
- Extract Xml_* subtypes to Xml_Type_Composite_* types?
- Improved error handling? Logging strict errors?
- Think about storing the data in iCal format.
Horde_Kolab_Format-2.0.8/doc/Horde/Kolab/Format/usage.txt 0000664 0001750 0001750 00000024515 12653734732 021264 0 ustar jan jan The "Horde_Kolab_Format" package allows you to easily read and write
the Kolab format within PHP.
Installation of the package
===========================
The package is being distributed as a standard PEAR package by the
Horde project. As long as you have PEAR installed, installation should
be straigt forward.
pear channel-discover pear.horde.org
pear install --force channel://pear.horde.org/Horde_Kolab_Format
"pear" will probably complain about the library (and its dependencies)
not being marked stable yet, but the "--force" option allows to ignore
these warnings.
Using the package
=================
This section will present the construction of a short example script
to demonstrate reading/writing an event in the Kolab XML format. The
first required statement is the inclusion of the package:
require_once 'Horde/Kolab/Format.php';
The API provided by the package is very simple. It only provides a
"load()" and a "save()" function.
In order to have access to these methods it is necessary to create the
"Horde_Kolab_Format" object. The call looks like this:
$format = Horde_Kolab_Format::factory('Xml', 'Event');
The function takes three arguments:
# "Format type": Currently only "Xml" is supported here.
# "Object type": The type of object you want to read/write. The
package currently implements "Contact", "Distributionslist",
"Event", "Note", "Task" and "Hprefs"
The $format variable created above now provides the means to
save and load events in Kolab XML format. In order to save an event we
need to prepare an array with all relevant information about this
event:
$object = array(
'uid' => 1,
'summary' => 'test event',
'start-date' => time(),
'end-date' => time() + 24 * 60 * 60,
);
This is an event that has the "UID" of "1" and carries the title "test
event". It starts right now ("time()") and ends in a day ("time() + 24
* 60 * 60").
This event can now be saved using the "save()" function of the format
handler:
$xml = $format->save($object);
The function returns the Kolab XML format as a result. This string can
be fed back into the "load()" function:
$read_object = $format->load($xml);
If we dump the contents of the two variables $xml and
$read_object this will be the result:
var_dump($xml);
string(438) "
12008-07-10T12:51:51Z2008-07-10T12:51:51ZpublicHorde::Kolabtest event2008-07-10T12:51:51Z2008-07-11T12:51:51Z
"
var_dump($read_object);
array(11) {
["uid"]=>
string(1) "1"
["body"]=>
string(0) ""
["categories"]=>
array(0) {
}
["creation-date"]=>
class DateTime#1 (3) {
public $date =>
string(19) "2008-07-10 12:51:51"
public $timezone_type =>
int(3)
public $timezone =>
string(13) "UTC"
}
["last-modification-date"]=>
class DateTime#1 (3) {
public $date =>
string(19) "2008-07-10 12:51:51"
public $timezone_type =>
int(3)
public $timezone =>
string(13) "UTC"
}
["sensitivity"]=>
string(6) "public"
["product-id"]=>
string(12) "Horde::Kolab"
["summary"]=>
string(10) "test event"
["start-date"]=>
int(1215694311)
["attendee"]=>
array(0) {
}
["end-date"]=>
int(1215780711)
}
We see that the format stores a lot more information than we
originally provided. The resulting XML string does not only contain
the "uid", "summary", "start-date", and "end-date". Several additional
attributes have been added. These were either calculated or set to a
default value.
* "body": holds the event description. We did not specify an event
description so this value has been set to an empty string.
* "sensitivity": events may be "public" or "private" with "public"
being the default
* "sensitivity": events may be "public" or "private" with "public"
being the default
* "categories": Any Kolab object may be member of different
categories. As we didn't specify a category this value is also
empty.
* "creation-date": The time stamp of the moment the object was
created.
* "last-modification-date": The time stamp of the moment the object
was last modified.
* "product-id": The ID of the product that last touched this
object. If we use the "Horde_Kolab_Format" package it will always be
"Horde::Kolab".
If we read the XML data back into an array all these new informations
are available within that array.
Creating your own Kolab XML format
==================================
Currently the "Horde_Kolab_Format" package provides handlers for the
object types "Contact", "Distributionslist", "Event", "Note", and
"Task" as they are defined within the Kolab Format specification. In
addition the Horde specific "Hprefs" type is available. It is used for
storing Horde user preferences in the IMAP store provided by the Kolab
server.
Depending on the web application you might wish to connect with the
Kolab server these object types may not be enough. Do not hesitate to
define your own new type in that case. If you want it to be adopted by
more Kolab clients you should of course discuss it on the Kolab Format
mailing list (http://kolab.org/pipermail/kolab-format/) to get some
feedback on the new type.
The "Horde_Kolab_Format" package makes the definition of a new object
type rather straight forward. The following will explain the creation
of a very simple new object that only saves a single string value.
This time it will be necessary to load the XML format definition,
too. Any new object type will extend this XML definition:
require_once 'Horde/Kolab/Format.php';
require_once 'Horde/Kolab/Format/Xml.php';
A new object type is represented by a class that extends
"Horde_Kolab_Format_Xml":
class Horde_Kolab_Format_Xml_String extends Horde_Kolab_Format_Xml {
protected $_fields_specific;
public function __construct()
{
$this->_root_name = 'string';
/** Specific fields of this object type
*/
$this->_fields_specific = array(
'string' => array(
'type' => self::TYPE_STRING,
'value' => self::VALUE_MAYBE_MISSING,
),
);
parent::__construct();
}
}
The class needs to end with the name of the object type. Here it is
just "string".
The declaration "var $_fields_specific;" indicates that the new object
type has attributes beyond the basic set required for any Kolab
object. So this part may not be missing for a declaration of a new
type.
The function creating the class ("__construct()") needs to do three
things:
* Declaring the XML root name which will be "string" here. It should
always match the type name.
* Declaring the specific attributes of the object. This part populates
the "_fields_specific" variable with an array describing the
possible object attributes. This will be described in more detail
further below.
* Calling the parent constructor using
"parent::__construct()".
The new format can now be used as demonstrated in the initial event
example:
$format = Horde_Kolab_Format::factory('Xml', 'String');
$object = array(
'uid' => 1,
'string' => 'test string',
);
$xml = $format->save($object);
$read_object = $format->load($xml);
var_dump($xml);
var_dump($read_object);
The result looks like this:
string(347) "
12008-07-10T13:28:36Z2008-07-10T13:28:36ZpublicHorde::Kolabtest string
"
array(8) {
["uid"]=>
string(1) "1"
["body"]=>
string(0) ""
["categories"]=>
array(0) {
}
["creation-date"]=>
class DateTime#1 (3) {
public $date =>
string(19) "2008-07-10 13:28:36"
public $timezone_type =>
int(3)
public $timezone =>
string(13) "UTC"
}
["last-modification-date"]=>
class DateTime#1 (3) {
public $date =>
string(19) "2008-07-10 13:28:36"
public $timezone_type =>
int(3)
public $timezone =>
string(13) "UTC"
}
["sensitivity"]=>
string(6) "public"
["product-id"]=>
string(12) "Horde::Kolab"
["string"]=>
string(11) "test string"
}
Allowed fields
==============
There are only a number of valid entries available to specify the
attributes a new object type may contain.
Each entry in the field list will look like this
'attribute_name' => array(
'type' => self::TYPE_*,
'value' => self::VALUE_*,
),
"attribute_name" should be a short name describing the value that
should be stored. "type" must be set to one of the following
"self::TYPE_*" type values:
* "self::TYPE_STRING": A string.
* "self::TYPE_INTEGER": A number
* "self::TYPE_BOOLEAN": True or false.
* "self::TYPE_DATE": A date (e.g. 2008/08/08)
* "self::TYPE_DATETIME": A time and a date.
* "self::TYPE_DATE_OR_DATETIME": A date or a time and a
date.
* "self::TYPE_COLOR": A color (#00BBFF).
* "self::TYPE_COMPOSITE": A composite element that combines
several attributes.
* "self::TYPE_MULTIPLE": Wrapper for an element that may
occur several times.
Examples for "self::TYPE_COMPOSITE" and
"self::TYPE_MULTIPLE" can be found in the definitions
currently provided by the "Horde_Kolab_Format" package.
The following "value" settings are allowed:
* "self::VALUE_DEFAULT": An attribute with a default value.
* "self::VALUE_MAYBE_MISSING": An attribute that may be left
undefined.
* "self::VALUE_NOT_EMPTY": An attribute that will cause an
error if it is left undefined.
* "self::VALUE_CALCULATE": A complex attribute that gets its
own function for calculating the correct value.
Examples for "self::VALUE_CALCULATE" can again be found in
the current object types implemented in "Horde_Kolab_Format".
Detailed package documentation
==============================
A detailed documentation based on the code comments and extracted via
phpDocumentor can be found at
http://dev.horde.org/api/framework/. Simply select the package
"Horde_Kolab_Format" in the package selection box in the upper right
corner.
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Decorator/Base.php 0000664 0001750 0001750 00000002520 12653734732 022715 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* A base decorator definition.
*
* Copyright 2010-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
abstract class Horde_Kolab_Format_Decorator_Base
implements Horde_Kolab_Format
{
/**
* The decorated Kolab format handler.
*
* @var Horde_Kolab_Format
*/
private $_handler;
/**
* Constructor.
*
* @param Horde_Kolab_Format $handler The handler to be decorated.
*/
public function __construct(Horde_Kolab_Format $handler)
{
$this->_handler = $handler;
}
/**
* Return the decorated handler.
*
* @return Horde_Kolab_Format The handler.
*/
public function getHandler()
{
return $this->_handler;
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Decorator/Memory.php 0000664 0001750 0001750 00000007501 12653734732 023317 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Determines some memory parameters while loading/saving the Kolab objects.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Decorator_Memory
extends Horde_Kolab_Format_Decorator_Base
{
/**
* The memory tracker used for recording the memory parameters.
*
* @var Horde_Support_Memory
*/
private $_memory;
/**
* An optional logger.
*
* @var mixed
*/
private $_logger;
/**
* Constructor.
*
* @param Horde_Kolab_Format $handler The handler to be decorated.
* @param Horde_Support_Memory $memory The memory tracker.
* @param mixed $logger The logger. This must provide
* a debug() method.
*/
public function __construct(Horde_Kolab_Format $handler,
Horde_Support_Memory $memory,
$logger = null)
{
parent::__construct($handler);
$this->_memory = $memory;
$this->_logger = $logger;
}
/**
* Load an object based on the given XML stream.
*
* @param resource $xml The XML stream of the message.
* @param array $options Additional options when parsing the XML. This
* decorator provides no additional options.
*
* @return array The data array representing the object.
*
* @throws Horde_Kolab_Format_Exception
*/
public function load($xml, $options = array())
{
$this->_memory->push();
$result = $this->getHandler()->load($xml);
$this->_logger->debug(
sprintf(
'Kolab Format data parsing complete. Memory usage: %s',
$this->_formatUsage($this->_memory->pop())
)
);
return $result;
}
/**
* Convert the data to a XML stream.
*
* @param array $object The data array representing the object.
* @param array $options Additional options when writing the XML. This
* decorator provides no additional options.
*
* @return resource The data as XML stream.
*
* @throws Horde_Kolab_Format_Exception
*/
public function save($object, $options = array())
{
$this->_memory->push();
$result = $this->getHandler()->save($object);
$this->_logger->debug(
sprintf(
'Kolab Format data generation complete. Memory usage: %s',
$this->_formatUsage($this->_memory->pop())
)
);
return $result;
}
/**
* Format the memory usage information.
*
* @param array $usage The memory usage.
*
* @return string The formated memory usage.
*/
private function _formatUsage($usage)
{
return sprintf(
'%.3f MB / %.3f MB / %.3f MB / %.3f MB [change in current usage (emalloc) / change in peak usage (emalloc) / change in current usage (real) / change in peak usage (real)]',
$usage[0] / 1048576,
$usage[1] / 1048576,
$usage[2] / 1048576,
$usage[3] / 1048576
);
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Decorator/Timed.php 0000664 0001750 0001750 00000007173 12653734732 023116 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Determines how much time is spent while loading/saving the Kolab objects.
*
* Copyright 2010-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Decorator_Timed
extends Horde_Kolab_Format_Decorator_Base
{
/**
* The timer used for recording the amount of time spent.
*
* @var Horde_Support_Timer
*/
private $_timer;
/**
* An optional logger.
*
* @var mixed
*/
private $_logger;
/**
* Time spent handling objects.
*
* @var float
*/
private static $_spent = 0.0;
/**
* Constructor.
*
* @param Horde_Kolab_Format $handler The handler to be decorated.
* @param Horde_Support_Timer $timer The timer.
* @param mixed $logger The optional logger. If set this
* needs to provide a debug() method.
*/
public function __construct(Horde_Kolab_Format $handler,
Horde_Support_Timer $timer,
$logger = null)
{
parent::__construct($handler);
$this->_timer = $timer;
$this->_logger = $logger;
}
/**
* Load an object based on the given XML stream.
*
* @param resource $xml The XML stream of the message.
* @param array $options Additional options when parsing the XML. This
* decorator provides no additional options.
*
* @return array The data array representing the object.
*
* @throws Horde_Kolab_Format_Exception
*/
public function load($xml, $options = array())
{
$this->_timer->push();
$result = $this->getHandler()->load($xml);
$spent = $this->_timer->pop();
if (is_object($this->_logger)) {
$this->_logger->debug(sprintf('Kolab Format data parsing complete. Time spent: %s ms', floor($spent * 1000)));
}
self::$_spent += $spent;
return $result;
}
/**
* Convert the data to a XML stream.
*
* @param array $object The data array representing the object.
* @param array $options Additional options when writing the XML. This
* decorator provides no additional options.
*
* @return resource The data as XML stream.
*
* @throws Horde_Kolab_Format_Exception
*/
public function save($object, $options = array())
{
$this->_timer->push();
$result = $this->getHandler()->save($object);
$spent = $this->_timer->pop();
if (is_object($this->_logger)) {
$this->_logger->debug(sprintf('Kolab Format data generation complete. Time spent: %s ms', floor($spent * 1000)));
}
self::$_spent += $spent;
return $result;
}
/**
* Report the time spent for loading/saving objects.
*
* @return float The amount of time.
*/
public function timeSpent()
{
return self::$_spent;
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Exception/InvalidRoot.php 0000664 0001750 0001750 00000001602 12653734732 024311 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Indicates a problem when loading/saving the Kolab XML root node.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Exception_InvalidRoot
extends Horde_Kolab_Format_Exception
{
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Exception/MissingUid.php 0000664 0001750 0001750 00000002062 12653734732 024133 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Indicates a missing UID value when reading or writing a Kolab Format object.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Exception_MissingUid
extends Horde_Kolab_Format_Exception
{
/**
* Constructor.
*/
public function __construct()
{
parent::__construct('No UID in the Kolab XML object!');
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Exception/MissingValue.php 0000664 0001750 0001750 00000003032 12653734732 024464 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Indicates a missing value when reading or writing a Kolab Format object.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Exception_MissingValue
extends Horde_Kolab_Format_Exception
{
/**
* The name of the value that was missing.
*
* @var string
*/
private $_value;
/**
* Constructor.
*
* @param string $value The value that was missing.
*/
public function __construct($value)
{
$this->_value = $value;
parent::__construct(
sprintf(
"Data value for \"%s\" is empty in the Kolab XML object!",
$value
)
);
}
/**
* Return the name of the missing value.
*
* @return string The name
*/
public function getValue()
{
return $this->_value;
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Exception/ParseError.php 0000664 0001750 0001750 00000003374 12653734733 024154 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Indicates a parse error when reading a Kolab Format object.
*
* Copyright 2009-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Exception_ParseError
extends Horde_Kolab_Format_Exception
{
/**
* The input that failed to parse.
*
* @var resource
*/
private $_input;
/**
* Constructor.
*
* @param string $input The input that failed to parse.
*/
public function __construct($input)
{
if (strlen((string)$input) > 50) {
$output = substr((string)$input, 0, 50)
. '... [shortened to 50 characters]';
} else {
$output = (string)$input;
}
$this->_input = $input;
parent::__construct(
sprintf(
"Failed parsing Kolab object input data of type %s! Input was:\n%s",
gettype($input), $output
)
);
}
/**
* Return the complete input.
*
* @return resource The input that failed to parse.
*/
public function getInput()
{
return $this->_input;
}
} Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/AutomaticDate/V1.php 0000664 0001750 0001750 00000006327 12653734733 024626 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api-version 1 of auto-generated date attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_AutomaticDate_V1
extends Horde_Kolab_Format_Xml_Type_Base
{
/**
* Load the node value from the Kolab object.
*
* @param string $name The name of the the
* attribute to be fetched.
* @param array &$attributes The data array that
* holds all attribute
* values.
* @param DOMNode $parent_node The parent node of the
* node to be loaded.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return DOMNode|boolean The named DOMNode or false if no node value was
* found.
*/
public function load(
$name,
&$attributes,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = parent::load($name, $attributes, $parent_node, $helper, $params);
if ($result !== false) {
return $result;
} else {
$attributes[$name] = time();
}
}
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = $helper->fetchNodeValue($node);
if ($result !== null) {
$date = Horde_Kolab_Format_Date::readUtcDateTime($result);
if ($date === false && !$this->isRelaxed($params)) {
throw new Horde_Kolab_Format_Exception(
sprintf('Invalid date input "%s"!', $result)
);
}
return $date;
} else {
return $result;
}
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Boolean/True.php 0000664 0001750 0001750 00000002161 12653734733 024102 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles a boolean attribute that defaults to true.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Boolean_True
extends Horde_Kolab_Format_Xml_Type_Boolean
{
/**
* Indicate which value type is expected.
*
* @var int
*/
protected $value = Horde_Kolab_Format_Xml::VALUE_DEFAULT;
/**
* A default value if required.
*
* @var string
*/
protected $default = true;
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Color/Background.php 0000664 0001750 0001750 00000002220 12653734733 024735 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the background color attribute that defaults to black.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Color_Background
extends Horde_Kolab_Format_Xml_Type_Color
{
/**
* Indicate which value type is expected.
*
* @var int
*/
protected $value = Horde_Kolab_Format_Xml::VALUE_DEFAULT;
/**
* A default value if required.
*
* @var string
*/
protected $default = '#000000';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Color/Foreground.php 0000664 0001750 0001750 00000002216 12653734733 024775 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the background color attribute that defaults to blue.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Color_Foreground
extends Horde_Kolab_Format_Xml_Type_Color
{
/**
* Indicate which value type is expected.
*
* @var int
*/
protected $value = Horde_Kolab_Format_Xml::VALUE_DEFAULT;
/**
* A default value if required.
*
* @var string
*/
protected $default = '#ffff00';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Recurrence/V1.php 0000664 0001750 0001750 00000002605 12653734733 026134 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api version 1 of recurrence data.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Recurrence_V1
extends Horde_Kolab_Format_Xml_Type_Composite_Recurrence
{
protected $elements = array(
'interval' => 'Horde_Kolab_Format_Xml_Type_RecurrenceInterval',
'day' => 'Horde_Kolab_Format_Xml_Type_Multiple_String',
'daynumber' => 'Horde_Kolab_Format_Xml_Type_Integer',
'month' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'range' => 'Horde_Kolab_Format_Xml_Type_RecurrenceRange',
'exclusion' => 'Horde_Kolab_Format_Xml_Type_Multiple_Date',
'complete' => 'Horde_Kolab_Format_Xml_Type_Multiple_Date',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Address.php 0000664 0001750 0001750 00000002477 12653734733 025145 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles attributes of an address.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Address
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'type' => 'Horde_Kolab_Format_Xml_Type_AddressType',
'street' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'locality' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'region' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'postal-code' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'country' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Attendee.php 0000664 0001750 0001750 00000002364 12653734733 025304 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles attributes of an attendee.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Attendee
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'display-name' => 'Horde_Kolab_Format_Xml_Type_String_Empty',
'smtp-address' => 'Horde_Kolab_Format_Xml_Type_String_Empty',
'status' => 'Horde_Kolab_Format_Xml_Type_AttendeeStatus',
'request-response' => 'Horde_Kolab_Format_Xml_Type_Boolean_True',
'role' => 'Horde_Kolab_Format_Xml_Type_AttendeeRole',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Name.php 0000664 0001750 0001750 00000002603 12653734733 024427 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles name attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Name
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'given-name' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'middle-names' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'last-name' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'full-name' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'initials' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'prefix' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'suffix' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Phone.php 0000664 0001750 0001750 00000001757 12653734733 024631 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles phone attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Phone
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'type' => 'Horde_Kolab_Format_Xml_Type_PhoneType',
'number' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/Recurrence.php 0000664 0001750 0001750 00000022762 12653734733 025654 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles recurrence data.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_Recurrence
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'interval' => 'Horde_Kolab_Format_Xml_Type_RecurrenceInterval',
'day' => 'Horde_Kolab_Format_Xml_Type_Multiple_String',
'daynumber' => 'Horde_Kolab_Format_Xml_Type_Integer',
'month' => 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing',
'range' => 'Horde_Kolab_Format_Xml_Type_RecurrenceRange',
'exclusion' => 'Horde_Kolab_Format_Xml_Type_Multiple_Date',
'complete' => 'Horde_Kolab_Format_Xml_Type_Multiple_Date',
);
/**
* Load the node value from the Kolab object.
*
* @param string $name The name of the the
* attribute to be fetched.
* @param array &$attributes The data array that
* holds all attribute
* values.
* @param DOMNode $parent_node The parent node of the
* node to be loaded.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return DOMNode|boolean The named DOMNode or false if no node value was
* found.
*/
public function load(
$name,
&$attributes,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = parent::load($name, $attributes, $parent_node, $helper, $params);
if ($node = $helper->findNodeRelativeTo('./' . $name, $parent_node)) {
// Get the cycle type (must be present)
$attributes['recurrence']['cycle'] = $node->getAttribute('cycle');
// Get the sub type (may be present)
$attributes['recurrence']['type'] = $node->getAttribute('type');
}
if (empty($attributes['recurrence'])) {
return $result;
}
$recurrence = $attributes['recurrence'];
if ($recurrence['interval'] < 0) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: interval cannot be below zero [Value: %s]!',
$recurrence['interval']
)
);
}
if (empty($recurrence['cycle'])) {
throw new Horde_Kolab_Format_Exception_ParseError('Recurrence: "cycle" attribute missing!');
}
if ($recurrence['cycle'] == 'weekly') {
// Check for
if (!isset($recurrence['day']) || count($recurrence['day']) == 0) {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: day tag missing for weekly recurrence!'
);
}
}
// The code below is only for monthly or yearly recurrences
if ($recurrence['cycle'] == 'monthly'
|| $recurrence['cycle'] == 'yearly') {
if (!isset($recurrence['type'])) {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: type attribute missing!'
);
}
if (!isset($recurrence['daynumber'])) {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: daynumber tag missing!'
);
}
$daynumber = $recurrence['daynumber'];
if ($daynumber < 0) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be below zero ["%s"]!',
$daynumber
)
);
}
if ($recurrence['type'] == 'daynumber') {
if ($recurrence['cycle'] == 'yearly' && $daynumber > 366) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be larger than 366 for yearly recurrences ["%s"]!',
$daynumber
)
);
} else if ($recurrence['cycle'] == 'monthly' && $daynumber > 31) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be larger than 31 for monthly recurrences ["%s"]!',
$daynumber
)
);
}
} else if ($recurrence['type'] == 'weekday') {
// daynumber is the week of the month
if ($daynumber > 5) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be larger than 5 for type weekday ["%s"]!',
$daynumber
)
);
}
// Check for
if (!isset($recurrence['day']) || count($recurrence['day']) == 0) {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: day tag missing for type weekday!'
);
}
}
if (($recurrence['type'] == 'monthday' || $recurrence['type'] == 'yearday')
&& $recurrence['cycle'] == 'monthly') {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: type monthday/yearday is only allowed for yearly recurrences'
);
}
if ($recurrence['cycle'] == 'yearly') {
if ($recurrence['type'] == 'monthday') {
// daynumber and month
if (!isset($recurrence['month'])) {
throw new Horde_Kolab_Format_Exception_ParseError(
'Recurrence: month tag missing for type monthday'
);
}
if ($daynumber > 31) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be larger than 31 for type monthday ["%s"]!',
$daynumber
)
);
}
} else if ($recurrence['type'] == 'yearday') {
if ($daynumber > 366) {
throw new Horde_Kolab_Format_Exception_ParseError(
sprintf(
'Recurrence: daynumber cannot be larger than 366 for type yearday ["%s"]!',
$daynumber
)
);
}
}
}
}
return $result;
}
/**
* Update the specified attribute.
*
* @param string $name The name of the attribute
* to be updated.
* @param mixed $value The value to store.
* @param DOMNode $parent_node The parent node of the
* node that should be
* updated.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params The parameters for this
* write operation.
* @param DOMNode|NULL $old_node The previous value (or
* null if there is none).
*
* @return DOMNode|boolean The new/updated child node or false if this
* failed.
*
* @throws Horde_Kolab_Format_Exception If converting the data to XML failed.
*/
public function saveNodeValue(
$name,
$value,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array(),
$old_node = false
)
{
$node = parent::saveNodeValue($name, $value, $parent_node, $helper, $params, $old_node);
// Add attributes
$node->setAttribute('cycle', $value['cycle']);
if (isset($value['type'])) {
$node->setAttribute('type', $value['type']);
}
return $node;
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Composite/SimplePerson.php 0000664 0001750 0001750 00000002204 12653734733 026164 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles attributes to represent a person in a simple way.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Composite_SimplePerson
extends Horde_Kolab_Format_Xml_Type_Composite
{
protected $elements = array(
'display-name' => 'Horde_Kolab_Format_Xml_Type_String_Empty',
'smtp-address' => 'Horde_Kolab_Format_Xml_Type_String_Empty',
'uid' => 'Horde_Kolab_Format_Xml_Type_String_Empty',
);
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/CreationDate/V1.php 0000664 0001750 0001750 00000007753 12653734733 024450 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api version 1 of the creation date attribute.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_CreationDate_V1
extends Horde_Kolab_Format_Xml_Type_AutomaticDate_V1
{
/**
* Update the specified attribute.
*
* @param string $name The name of the the
* attribute to be updated.
* @param array $attributes The data array that holds
* all attribute values.
* @param DOMNode $parent_node The parent node of the
* node that should be
* updated.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additional parameters
* for this write operation.
*
* @return DOMNode|boolean The new/updated child node or false if this
* failed.
*
* @throws Horde_Kolab_Format_Exception If converting the data to XML failed.
*/
public function save(
$name,
$attributes,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$node = $helper->findNodeRelativeTo(
'./' . $name, $parent_node
);
if ($node !== false) {
if (isset($attributes[$name]) &&
($old = $this->loadNodeValue($node, $helper, $params)) != $attributes[$name]) {
if (!$this->isRelaxed($params)) {
throw new Horde_Kolab_Format_Exception(
sprintf(
'Not attempting to overwrite old %s %s with new value %s!',
$name,
Horde_Kolab_Format_Date::writeDateTime($old),
Horde_Kolab_Format_Date::writeDateTime($attributes[$name])
)
);
}
} else {
return $node;
}
}
$result = $this->saveNodeValue(
$name,
$this->generateWriteValue($name, $attributes, $params),
$parent_node,
$helper,
$params,
$node
);
return ($node !== false) ? $node : $result;
}
/**
* Generate the value that should be written to the node. Override in the
* extending classes.
*
* @param string $name The name of the the attribute
* to be updated.
* @param array $attributes The data array that holds all
* attribute values.
* @param array $params The parameters for this write operation.
*
* @return mixed The value to be written.
*/
protected function generateWriteValue($name, $attributes, $params)
{
if (isset($attributes[$name])) {
return Horde_Kolab_Format_Date::writeUtcDateTime(
$attributes[$name]
);
} else {
return Horde_Kolab_Format_Date::writeUtcDateTime(new DateTime());
}
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Date/V1.php 0000664 0001750 0001750 00000006002 12653734733 022745 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api version 1 of date attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Date_V1
extends Horde_Kolab_Format_Xml_Type_String
{
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = $helper->fetchNodeValue($node);
return Horde_Kolab_Format_Date::readDate($result);
}
/**
* Update the specified attribute.
*
* @param string $name The name of the attribute
* to be updated.
* @param mixed $value The value to store.
* @param DOMNode $parent_node The parent node of the
* node that should be
* updated.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params The parameters for this
* write operation.
* @param DOMNode|NULL $old_node The previous value (or
* null if there is none).
*
* @return DOMNode|boolean The new/updated child node or false if this
* failed.
*
* @throws Horde_Kolab_Format_Exception If converting the data to XML failed.
*/
public function saveNodeValue(
$name,
$value,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array(),
$old_node = false
)
{
$date = Horde_Kolab_Format_Date::writeDate($value);
$node = parent::saveNodeValue(
$name, $date, $parent_node, $helper, $params, $old_node
);
return $node;
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/DateTime/V1.php 0000664 0001750 0001750 00000006036 12653734733 023573 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api version 1 of date-time attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_DateTime_V1
extends Horde_Kolab_Format_Xml_Type_String
{
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = $helper->fetchNodeValue($node);
return Horde_Kolab_Format_Date::readDateOrDateTime($result);
}
/**
* Update the specified attribute.
*
* @param string $name The name of the attribute
* to be updated.
* @param mixed $value The value to store.
* @param DOMNode $parent_node The parent node of the
* node that should be
* updated.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params The parameters for this
* write operation.
* @param DOMNode|NULL $old_node The previous value (or
* null if there is none).
*
* @return DOMNode|boolean The new/updated child node or false if this
* failed.
*
* @throws Horde_Kolab_Format_Exception If converting the data to XML failed.
*/
public function saveNodeValue(
$name,
$value,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array(),
$old_node = false
)
{
$date = Horde_Kolab_Format_Date::writeDateTime($value);
$node = parent::saveNodeValue(
$name, $date, $parent_node, $helper, $params, $old_node
);
return $node;
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/EventDate/V1.php 0000664 0001750 0001750 00000001745 12653734733 023760 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles event start and end dates.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_EventDate_V1
extends Horde_Kolab_Format_Xml_Type_Date_V1
{
/**
* Indicate which value type is expected.
*
* @var int
*/
protected $value = Horde_Kolab_Format_Xml::VALUE_NOT_EMPTY;
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/EventDateTime/V1.php 0000664 0001750 0001750 00000003655 12653734733 024601 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles event start and end dates.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_EventDateTime_V1
extends Horde_Kolab_Format_Xml_Type_DateTime_V1
{
/**
* Indicate which value type is expected.
*
* @var int
*/
protected $value = Horde_Kolab_Format_Xml::VALUE_NOT_EMPTY;
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = $helper->fetchNodeValue($node);
if (strlen($result) == 10) {
return array(
'date' => Horde_Kolab_Format_Date::readDate($result),
'date-only' => true
);
}
return array(
'date' => Horde_Kolab_Format_Date::readDateTime($result),
'date-only' => false
);
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/Address.php 0000664 0001750 0001750 00000002043 12653734733 024763 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple address attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_Address
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Composite_Address';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/Attendee.php 0000664 0001750 0001750 00000002047 12653734733 025133 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple attendee attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_Attendee
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Composite_Attendee';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/Boolean.php 0000664 0001750 0001750 00000002031 12653734733 024752 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple boolean attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_Boolean
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Boolean';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/Date.php 0000664 0001750 0001750 00000002015 12653734733 024252 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple date attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_Date
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Date';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/Phone.php 0000664 0001750 0001750 00000002033 12653734733 024446 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple phone attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_Phone
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Composite_Phone';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/SimplePerson.php 0000664 0001750 0001750 00000002071 12653734733 026017 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple simple person attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_SimplePerson
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_Composite_SimplePerson';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/Multiple/String.php 0000664 0001750 0001750 00000002042 12653734733 024643 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles the multiple string attributes.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_Multiple_String
extends Horde_Kolab_Format_Xml_Type_Multiple
{
/**
* The class name representing the element that can occur multiple times.
*
* @var string
*/
protected $element = 'Horde_Kolab_Format_Xml_Type_String_MaybeMissing';
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/RecurrenceRange/V1.php 0000664 0001750 0001750 00000011563 12653734733 025152 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles api version 1 of the recurrence range attribute.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_RecurrenceRange_V1
extends Horde_Kolab_Format_Xml_Type_String
{
/**
* Load the node value from the Kolab object.
*
* @param string $name The name of the the
* attribute to be fetched.
* @param array &$attributes The data array that
* holds all attribute
* values.
* @param DOMNode $parent_node The parent node of the
* node to be loaded.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return DOMNode|boolean The named DOMNode or false if no node value was
* found.
*/
public function load(
$name,
&$attributes,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = parent::load($name, $attributes, $parent_node, $helper, $params);
if ($result !== false) {
$type = $result->getAttribute('type');
if (!empty($type) && $type != 'none') {
$attributes['range-type'] = $type;
}
}
return $result;
}
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = $helper->fetchNodeValue($node);
$type = $node->getAttribute('type');
if (empty($type) || $type == 'none') {
return null;
}
if ($type == 'date') {
return Horde_Kolab_Format_Date::readDate($result);
}
return $result;
}
/**
* Update the specified attribute.
*
* @param string $name The name of the the
* attribute to be updated.
* @param array $attributes The data array that holds
* all attribute values.
* @param DOMNode $parent_node The parent node of the
* node that should be
* updated.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additional parameters
* for this write operation.
*
* @return DOMNode|boolean The new/updated child node or false if this
* failed.
*
* @throws Horde_Kolab_Format_Exception If converting the data to XML failed.
*/
public function save(
$name,
$attributes,
$parent_node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
if (isset($attributes['range-type']) &&
$attributes['range-type'] == 'date') {
$attributes[$name] = Horde_Kolab_Format_Date::writeDate($attributes[$name]);
}
$node = parent::save(
$name, $attributes, $parent_node, $helper, $params
);
if (isset($attributes['range-type'])) {
$type = $attributes['range-type'];
} else {
$type = 'none';
}
$node->setAttribute('type', $type);
}
}
Horde_Kolab_Format-2.0.8/lib/Horde/Kolab/Format/Xml/Type/String/Empty/List.php 0000664 0001750 0001750 00000006134 12653734733 025067 0 ustar jan jan
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Handles a string attribute that defaults to an empty string.
*
* Copyright 2012-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Jan Schneider
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Type_String_Empty_List
extends Horde_Kolab_Format_Xml_Type_String_Empty
{
/**
* A default value if required.
*
* @var array
*/
protected $default = array();
/**
* Load the value of a node.
*
* @param DOMNode $node Retrieve value for this node.
* @param Horde_Kolab_Format_Xml_Helper $helper A XML helper instance.
* @param array $params Additiona parameters for
* this parse operation.
*
* @return mixed|null The value or null if no value was found.
*/
public function loadNodeValue(
$node,
Horde_Kolab_Format_Xml_Helper $helper,
$params = array()
)
{
$result = parent::loadNodeValue($node, $helper, $params);
$result = preg_split('/(?