Download the PHP package johansatge/workflowy-php without Composer

On this page you can find all versions of the php package johansatge/workflowy-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of johansatge/workflowy-php

Informations about the package workflowy-php

Version

An unofficial WorkFlowy API written in PHP.

Disclaimer

The aim of the API is to keep things simple. Please keep in mind that it is an unofficial tool, and it may stop working at any time.

So, I strongly recommend you not to manipulate sensitive data with this API, and be sure to make regular backups of your lists.

Installation

By using Composer:

If you do not use Composer, you can download the source files, install them anywhere on your project, and call the providden autoloader file:

Usage

Login API

Because of the unofficial status of the API, you have to login first, by using your regular credentials, before being able to perform requests on your data.

The $session_id variable will be used later, when performing requests.

You have to use your unencoded password in your code. So I strongly advise you to store it in a different file, or ask it once to the user, then store the session ID. (But keep in mind that the session does not last forever.) This is a huge limitation, but for now there is no workaround.

Lists API

Lists-related stuff is managed with the recursive WorkFlowySublist class.

First, you will need to get the main (root) list.

Then, you will be able to perform the following operations on the resulting $list, or its sublists.

Get the informations of a list

Function Returns Description
$list->getID(); string Get the ID of the list
$list->getName(); string Get the name of the list
$list->getDescription(); string Get the description of the list
$list->getParent(); WorkFlowySublist Get the parent of the list
$list->isComplete(); boolean Get the status of the list
$list->getCompletedTime(); int Get the completed time of the list (Unix timestamp)
$list->getLastModifiedTime(); int Get the last modified time of the list (Unix timestamp)
$list->getOPML(); string Get the list and its sublists as an OPML string
$list->getSublists(); array Get the sublists of the list
$list->searchSublist('/My sublist name/'); WorkFlowySublist Returns the first child list matching the given name
$list->searchSublist('/My sublist name/', array('get_all' => true)); array Returns all children lists matching the given name

Edit the informations of a list

Function Parameters Description
$list->setName('My sublist'); string Sets the list name
$list->setDescription('My sublist description'); string Sets the list description
$list->setParent($parent_list, 2); WorkFlowySublist,int Sets the list parent and its position
$list->setComplete(true); boolean Sets the list status
$list->createSublist('My sublist name', 'My sublist description', 9); string,string,int Creates a sublist

The methods below are used to edit data.

Keep in mind that they will send requests to the server, but not update the existing variables.

For instance, if you change the parent of a list and call the getSublists() method on its old parent, the list will still be present in the resulting array.

Account API

Function Returns Description
$account_request = new WorkFlowyAccount($session_id); WorkFlowyAccount Gets an account object
$account_request->getUsername(); string Gets his username
$account_request->getEmail(); string Gets his email address
$account_request->getTheme(); string Gets his selected theme
$account_request->getItemsCreatedInMonth(); int Gets the number of items created during the month
$account_request->getMonthlyQuota(); int Gets his monthly quota
$account_request->getRegistrationDate('d-m-Y'); string Gets his registration date
Leave the format empty to use the default value ('Y-m-d H:i:s')
$account_request->getRegistrationDate('timestamp'); string Gets his registration time

Changelog

Version Date Notes
0.2.3 2019-05-17 Fix authentication process (#10)
0.2.2 2019-02-13 Fix authentication process (#8)
0.2.1 2018-11-11 Fix getLastModifiedTime() and getCompletedTime() methods
Internal WorkFlowy API started returning timestamps in seconds
0.2.0 2018-07-21 Fix getItemsCreatedInMmonth() method naming (renamed to getItemsCreatedInMonth())
Update documentation
Update sample code
0.1.3 2017-02-28 Add $list->getCompletedTime() & $list->getLastModifiedTime() methods (#5)
Fix OPML encoding (#4)
0.1.2 2016-06-26 Fix searchSublistwith get_all option (@hirechrismeyers)
0.1.1 2015-08-25 Fix case of filenames (@citywill)
0.1 2015-01-01 Initial version

License

This project is released under the MIT License.

Credits

All versions of workflowy-php with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package johansatge/workflowy-php contains the following files

Loading the files please wait ....