classes/php5_classes/Cron.class.php

Properties

Description

This is the cron backend, for running cron routines in.

This file works with {@link cron.php} to run cron tasks. See that file for more information on cron tasks.

Classes

geoCron

Properties

 
 
System  
No 
No 

Description

This is the cron job backend, it handles all the communication and security and all that.

Methods

__construct, getInstance, getTaskInfo, heartbeat, load, lockTask, log, logSystem, rem, resetKey, run, set, time, touch,

__construct( ) : \geoCron

Description

Constructor, initializes all the class vars and loads the tasks.

Return value

Type Description
\geoCron

getInstance( ) : \geoCron

Description

Get an instance of the cron task.

Return value

Type Description
\geoCron

getTaskInfo( string   $task, ) : array|bool

Description

Gets information about a specific task, mainly used for getting info in the admin.

Arguments

Name Type Description Default
$task string

task name to get info for

Return value

Type Description
array|bool an associative array of info about the task, or false if task not found.

Tags

Name Description
since 4.0.0 RC11

heartbeat( ) : n/a

Description

Runs tasks on a given interval for each task, as set using {@link geoCron::set()}

Return value

Type Description
n/a n/a

load( ) : n/a

Description

Loads the info for any tasks that can be run.

Return value

Type Description
n/a n/a

lockTask( string   $task, boolean   $lock = true, ) : boolean

Description

Marks a task as currently being executed, so that the task is not run multiple times at once. This does not run the task, it only "locks" the task.

Arguments

Name Type Description Default
$task string
$lock boolean

If true, will lock the task, if false, will unlock the task. Defaults to true to lock the task.

true

Return value

Type Description
boolean If $lock is true, but the task is already locked, then this returns false to indicate that the task is already being run. Otherwise returns true.

log( string   $message, int   $line = 0, ) : n/a

Description

For use in cron jobs, to display a message. This automatically checks if verbose is turned on or not, and if so, it echos the message and the line number.

Arguments

Name Type Description Default
$message string
$line int 0

Return value

Type Description
n/a n/a

Tags

Name Description
since 4.0.0

logSystem( string   $message, int   $line, ) : n/a

Description

For use in geoCron class directly, DO NOT use in cron jobs. Use normal log() function from inside actual cron jobs. This works just like the log() function, except that this will add some extra decoration to the log message to make it stand out from the normal log messages.

Arguments

Name Type Description Default
$message string
$line int

Return value

Type Description
n/a n/a

Tags

Name Description
since 4.0.0

rem( string   $task, ) : boolean

Description

Removes a task from the task system.

Arguments

Name Type Description Default
$task string

must be same as what was used for {@link geoCron::set()}

Return value

Type Description
boolean result of removal of task from system.

resetKey( \(optional)string   $newKey = '', ) : n/a

Description

Resets the cron security key

Arguments

Name Type Description Default
$newKey \(optional)string

if blank, a random key is generated.

''

Return value

Type Description
n/a n/a

run( array   $tasks, ) : n/a

Description

Runs the specified tasks. Special case task is heartbeat, which will run tasks that need to be run if they havn't been run in a while.

Arguments

Name Type Description Default
$tasks array

Return value

Type Description
n/a n/a

set( string   $task, string   $type, int   $interval, ) : boolean

Description

Adds or edits the given task and sets the repeat interval. A task will not be visible to the cron system until it has been added using this method.

Arguments

Name Type Description Default
$task string

task name, following specific format: if type is main, the task is the filename without the .php, if type is addon the task is ADDON_NAME:TASK where TASK is the filename without the .php, and ADDON_NAME is the addon name (same as addon folder name)

$type string

addon or main, if addon the file is located at addons/ADDON_NAME/cron/ and if main, the task is located in classes/cron/

$interval int

in seconds

Return value

Type Description
boolean True if successful, false otherwise.

time( ) : int

Description

Utility function that returns the current time, adjusted for the time shift as set in the admin. This is an alias for geoUtil::time()

Return value

Type Description
int

touch( string   $task, ) : boolean

Description

Sets the last time the task was run to the current time.

Arguments

Name Type Description Default
$task string

Return value

Type Description
boolean true if succeeds, false otherwise.

Properties

$addon, $db, $product_configuration, $session, $tasks, $verbose,

\Addon  public  $addon =

Addon object, can be used by cron tasks by using $this->addon


\DataAccess  public  $db =

Database object, can be used by cron tasks by using $this->db


\geoPC  public  $product_configuration =

geoPC object, can be used by cron tasks by using $this->product_configuration


\Session  public  $session =

Session object, can be used by cron tasks by using $this->session


  public  $tasks =

Used to store the task info about each task


boolean  public  $verbose = 0

If tasks should be talkative or not, if false they should be quiet. If true they should echo out info.


Constants

  TYPE_ADDON = 'addon'

To be used for 2nd parameter in call to method {@link geoCron::set()}, in order to indicate that the cron type is a "main" cron task.


  TYPE_MAIN = 'main'

To be used for 2nd parameter in call to method {@link geoCron::set()}, in order to indicate that the cron type is a "main" cron task.


Documentation was generated by phpDocumentor 2.2.0 .

Namespaces

  • global

    Packages

    • Default
      • ExampleAddon
        • addon_example_admin
          In charge of doing stuff on the admin side, this is optional.
        • addon_example_info
          Required class for addons, this is the Addon information class, used by the addon system to determine what the addon can do. Also contains info about the addon that can be viewed in the addon management page in the admin.
        • addon_example_pages
          Addon page class, used by the addon system to display pages on the client side.
        • addon_example_setup
          This class is not required. If it, and the function for a particular routine exist, then that function will be called IN ADDITION TO the automated routines of the addon framework.
        • addon_example_tags
          Expects one function for each tag. Function name should be the same as the tag name. Can also have a constructor if anything needs to be constructed.
        • addon_example_util
          This is where to put functions that the main part of the addon will use.
        • eWidgetOrderItem
          This order item is designed to allow users on your site to purchase an eWidget.
      • System
        • DataAccess
          This is the main Database access object.
        • Singleton
          Singleton method class
        • _templateOrderItem
          Developers: use this file as a template to create a new order item.
        • _templatePaymentGateway
          This is the "developer template" payment gateway handler, a developer could use this file as a starting point for creating a new payment gateway in the system.
        • geoAPI
          The main system class for receiving and handling remote API calls, this acts as a translation layer between the communication with the "outside" and each API call.
        • geoAddon
          This is the class that handles anything and everything to do with addons.
        • geoArrayTools
          Utility functions for manipulating arrays
        • geoBrowse
          Contains functions common to browsing listings
        • geoBrowsingFilter
          System for activating, storing, and deactivating browsing filters.
        • geoCJAX
          Class that wraps the CJAX_FRAMEWORK, used to get the CJAX class.
        • geoCache
          This is the main part of the Geo cache system, it does all the "low level" stuff like writing files and escaping cache data.
        • geoCacheModule
          Part of Geo Cache system, specifically tuned to work best with cacheing module data (which will be an array).
        • geoCachePage
          Cache system specifically tuned to work best with cacheing output of pages and modules
        • geoCacheSetting
          Part of Geo Cache system, specifically tuned to work best with cacheing site-wide key=value type settings.
        • geoCacheText
          Part of Geo Cache system, this part specifically tuned to work best with cacheing language specific messages.
        • geoCalendar
          Holds utility method(s) for manipulating stuff dealing with calendar selector.
        • geoCart
          This class is behind the cart, loading all the order items and such and displaying, and processing all the different pages.
        • geoCategory
          Utility class that holds various methods to do stuff with categories in the system.
        • geoCombineResources
          This class helps to combine CSS and JS files, minify them, and optionally compress them.
        • geoCron
          This is the cron job backend, it handles all the communication and security and all that.
        • geoCrypt
          Class to use for encrypting information that needs to be able to be retrieved later.
        • geoDate
          Holds utility method(s) for manipulating stuff dealing with dates.
        • geoEmail
          Class that sends out e-mails.
        • geoFields
          Class that holds settings information for fields to use.
        • geoFieldsField
          A mini object to hold data about a specific field.
        • geoFile
          As the name implies, this is used for file-based utility methods.
        • geoFilter
          A few utility methods, good for filtering stuff.
        • geoFormatString
          Used to display a message nice and pretty, we'll probably be getting rid of this class though so don't go crazy using it.
        • geoHTML
          Class to generate chunks of HTML that are very common, used the most in the admin panel.
        • geoImage
          This class is responsible for a lot of the image processing, along with other aspects like generating the image tag for thumbnails.
        • geoInvoice
          This is the invoice object representing an invoice in the system.
        • geoLeveledField
          Class for doing common things with leveled fields.
        • geoListing
          A listing object, basically a container object for particular listing.
        • geoListingDisplay
          This is basically a container that is responsible for helping to display {listing .
        • geoListingFeed
          Class that helps to render RSS or other types of feeds based on list of listings.
        • geoMaster
          This is dedicated class for getting the value of, and setting, the various "master switches" within the software. Since this is meant as an easy way to get the values of master switches, most of the methods are static.
        • geoNumber
          Utility functions relating to number conversion/manipulation/validation ect.
        • geoOrder
          The geoOrder object, an object representation of an order in the system.
        • geoOrderItem
          The class that all order items must extend.
        • geoPC
          Used for login credential validation, password hashing, etc. along with software licensing.
        • geoPagination
          Utility functions useful for generating pagination of a results page such as when browing ads or searching
        • geoPaymentGateway
          This class should be extended by each different payment gateway, this will have some default functions that each gateway will inherit, and also has a few final static methods used by the system to affect all order items.
        • geoPlanItem
          A container to hold settings for a particular order item type, according to price plan ID, and optionally category ID for category specific settings.
        • geoRecurringBilling
          The geoRecurringBilling object, an object representation of a recurring billing in the system.
        • geoRegion
          Stuff for regions and sub-regions.
        • geoRegistry
          Handy little object, can be used to set registry type settings.
        • geoSearchUtils
          Class for search utilities.
        • geoSellerBuyer
          Handles back-end for the seller/buyer payment gateways, to allow the buyer to more easily pay the seller for a won auction. This handles the underlying system, but the actual work is done by individual seller/buyer gateways, for instance the Paypal buy-now functionality.
        • geoSession
          Manages session storage and session cookies for user sessions.
        • geoString
          Utility functions relating to languages and string manipulation.
        • geoStringData
          This class is to store accented chars, to be used by {@link geoString::removeAccents()}, mainly to keep the String.class.php file un-cluttered.
        • geoTable
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRow
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRowset
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableSelect
          Class used to generate a select query, useful when multiple areas want to affect a single query, for instance when generating a search query and there are addons involved.
        • geoTables
          Used to hold database table names, used throughout the code.
        • geoTemplate
          Template object that extends the Smarty class (a 3rd party library) to enable using templates to display things.
        • geoTransaction
          This is the object used for a transaction in the order and invoice system.
        • geoUser
          An object representative of a certain user in the system.
        • geoUserRating
          Store, retrieve, and display inter-user ratings
        • geoUtil
          Misc utility functions
        • geoView
          As the name implies, this is used for creating the page view. It does take a little setup (like any class), the setup is normally done in the display_page method in geoSite, or display_page in geoAdmin if displaying a page in the admin.
        • iApiTransport
          Interface for API Transports, a transport must implement this interface for the system to use it.
        • iOrderItem
          You cannot have abstract static functions, so instead need to have an interface to force the given static functions to be defined.
        • metaDbTables
          Used so that old locations that use the old name geoTables will still work.