package Modules\Other

 Methods

__construct()

__construct() 

createAbsence()

createAbsence($user_id, $date_stamp, $total_time, $absence_policy_id, $override = FALSE

Parameters

$user_id

$date_stamp

$total_time

$absence_policy_id

$override

createAbsencePolicy()

createAbsencePolicy($company_id, $type, $pay_code_id = 0

Parameters

$company_id

$type

$pay_code_id

createAccrualBalance()

createAccrualBalance($user_id, $accrual_policy_account_id, $type = 30

Parameters

$user_id

$accrual_policy_account_id

$type

createAccrualPolicy()

createAccrualPolicy($company_id, $type, $accrual_policy_account_id) 

Parameters

$company_id

$type

$accrual_policy_account_id

createAccrualPolicyAccount()

createAccrualPolicyAccount($company_id, $type) 

Parameters

$company_id

$type

createAreaPolicy()

createAreaPolicy($company_id, $type, $invoice_district_ids = FALSE

Parameters

$company_id

$type

$invoice_district_ids

createAuthorization()

createAuthorization($object_type_id, $object_id, $user_id, $authorize = TRUE

Parameters

$object_type_id

$object_id

$user_id

$authorize

createAuthorizationHierarchyControl()

createAuthorizationHierarchyControl($company_id, $child_user_ids) 

Parameters

$company_id

$child_user_ids

createAuthorizationHierarchyLevel()

createAuthorizationHierarchyLevel($company_id, $hierarchy_id, $root_user_id, $level) 

Parameters

$company_id

$hierarchy_id

$root_user_id

$level

createBranch()

createBranch($company_id, $type, $geo_fence_ids = NULL

Parameters

$company_id

$type

$geo_fence_ids

createClient()

createClient($company_id, $type, $user_ids = NULL, $client_group_ids = NULL

Parameters

$company_id

$type

$user_ids

$client_group_ids

createClientContact()

createClientContact($client_id, $type, $invoice_district_ids, $default_currency_id) 

Parameters

$client_id

$type

$invoice_district_ids

$default_currency_id

createClientGroup()

createClientGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createCompany()

createCompany() 

createCompanyDeduction()

createCompanyDeduction($company_id) 

Parameters

$company_id

createContributingPayCodePolicy()

createContributingPayCodePolicy($company_id, $type, $pay_code_ids = 0

Parameters

$company_id

$type

$pay_code_ids

createContributingShiftPolicy()

createContributingShiftPolicy($company_id, $type, $contributing_pay_code_policy_id, $holiday_policy_id = NULL

Parameters

$company_id

$type

$contributing_pay_code_policy_id

$holiday_policy_id

createCurrency()

createCurrency($company_id, $type) 

Parameters

$company_id

$type

createDepartment()

createDepartment($company_id, $type, $branch_ids = NULL, $geo_fence_ids = NULL

Parameters

$company_id

$type

$branch_ids

$geo_fence_ids

createDocument()

createDocument($company_id, $object_type_id, $type) 

Parameters

$company_id

$object_type_id

$type

createDocumentAttachment()

createDocumentAttachment($document_id, $object_type_id, $object_id) 

Parameters

$document_id

$object_type_id

$object_id

createDocumentFilesByObjectType()

createDocumentFilesByObjectType($company_id, $object_type_id, $type, $document_revision_id, $document_id) 

Parameters

$company_id

$object_type_id

$type

$document_revision_id

$document_id

createDocumentRevision()

createDocumentRevision($document_id, $type) 

Parameters

$document_id

$type

createEthnicGroup()

createEthnicGroup($company_id, $type) 

Parameters

$company_id

$type

createExceptionPolicy()

createExceptionPolicy($company_id) 

Parameters

$company_id

createExpensePolicy()

createExpensePolicy($company_id, $type, $taxes_policy_ids = NULL

Parameters

$company_id

$type

$taxes_policy_ids

createGEOFence()

createGEOFence($company_id, $type) 

Parameters

$company_id

$type

createInvoice()

createInvoice($company_id, $client_id, $currency_id, $products, $status_id = 10, $payments = NULL, $user_ids = NULL, $shipping_policy_ids = NULL

Parameters

$company_id

$client_id

$currency_id

$products

$status_id

$payments

$user_ids

$shipping_policy_ids

createInvoiceDistrict()

createInvoiceDistrict($company_id, $type) 

Parameters

$company_id

$type

createJob()

createJob($company_id, $type, $item_id, $job_group_id = 0, $branch_id = 0, $department_id = 0, $client_id = NULL, $geo_fence_ids = NULL

Parameters

$company_id

$type

$item_id

$job_group_id

$branch_id

$department_id

$client_id

$geo_fence_ids

createJobApplicant()

createJobApplicant($company_id) 

Parameters

$company_id

createJobApplicantEducation()

createJobApplicantEducation($job_applicant_id, $qualification_id) 

Parameters

$job_applicant_id

$qualification_id

createJobApplicantEmployment()

createJobApplicantEmployment($job_applicant_id, $type) 

Parameters

$job_applicant_id

$type

createJobApplicantLanguage()

createJobApplicantLanguage($job_applicant_id, $qualification_id) 

Parameters

$job_applicant_id

$qualification_id

createJobApplicantLicense()

createJobApplicantLicense($job_applicant_id, $qualification_id) 

Parameters

$job_applicant_id

$qualification_id

createJobApplicantLocation()

createJobApplicantLocation($job_applicant_id) 

Parameters

$job_applicant_id

createJobApplicantMembership()

createJobApplicantMembership($job_applicant_id, $qualification_id, $default_currency_id) 

Parameters

$job_applicant_id

$qualification_id

$default_currency_id

createJobApplicantReference()

createJobApplicantReference($job_applicant_id) 

Parameters

$job_applicant_id

createJobApplicantSkill()

createJobApplicantSkill($job_applicant_id, $qualification_id) 

Parameters

$job_applicant_id

$qualification_id

createJobApplication()

createJobApplication($job_applicant_id, $job_vacancy_id, $user_id) 

Parameters

$job_applicant_id

$job_vacancy_id

$user_id

createJobGroup()

createJobGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createJobVacancy()

createJobVacancy($company_id, $user_id, $user_title_id = 0, $default_branch_id = 0, $default_department_id = 0

Parameters

$company_id

$user_id

$user_title_id

$default_branch_id

$default_department_id

createKPI()

createKPI($company_id, $type, $rate_type, $kpi_group_ids = NULL

Parameters

$company_id

$type

$rate_type

$kpi_group_ids

createKPIGroup()

createKPIGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createMealPolicy()

createMealPolicy($company_id, $pay_code_id = 0

Parameters

$company_id

$pay_code_id

createOverTimePolicy()

createOverTimePolicy($company_id, $type, $contributing_shift_policy_id = 0, $pay_code_id = 0

Parameters

$company_id

$type

$contributing_shift_policy_id

$pay_code_id

createPayCode()

createPayCode($company_id, $type, $pay_formula_policy_id = 0

Parameters

$company_id

$type

$pay_formula_policy_id

createPayFormulaPolicy()

createPayFormulaPolicy($company_id, $type, $accrual_policy_account_id = 0

Parameters

$company_id

$type

$accrual_policy_account_id

createPayPeriodSchedule()

createPayPeriodSchedule($company_id, $user_ids) 

Parameters

$company_id

$user_ids

createPayStubAccount()

createPayStubAccount($company_id) 

Parameters

$company_id

createPermissionGroups()

createPermissionGroups($company_id, $filter_preset_options = NULL

Parameters

$company_id

$filter_preset_options

createPolicyGroup()

createPolicyGroup($company_id, $meal_policy_ids = NULL, $exception_policy_id = NULL, $holiday_policy_ids = NULL, $over_time_policy_ids = NULL, $premium_policy_ids = NULL, $rounding_policy_ids = NULL, $user_ids = NULL, $break_policy_ids = NULL, $accrual_policy_ids = NULL, $expense_policy_ids = NULL, $absence_policy_ids = NULL, $regular_policy_ids = NULL

Parameters

$company_id

$meal_policy_ids

$exception_policy_id

$holiday_policy_ids

$over_time_policy_ids

$premium_policy_ids

$rounding_policy_ids

$user_ids

$break_policy_ids

$accrual_policy_ids

$expense_policy_ids

$absence_policy_ids

$regular_policy_ids

createPremiumPolicy()

createPremiumPolicy($company_id, $type, $contributing_shift_policy_id = 0, $pay_code_id = 0

Parameters

$company_id

$type

$contributing_shift_policy_id

$pay_code_id

createProduct()

createProduct($company_id, $group_ids, $type, $currency_id) 

Parameters

$company_id

$group_ids

$type

$currency_id

createProductGroup()

createProductGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createPunch()

createPunch($user_id, $type_id, $status_id, $time_stamp, $data, $coordinate = NULL, $calc_total_time = TRUE

Parameters

$user_id

$type_id

$status_id

$time_stamp

$data

$coordinate

$calc_total_time

createPunchPair()

createPunchPair($user_id, $in_time_stamp, $out_time_stamp, $data = NULL, $calc_total_time = TRUE, $coordinate = NULL

Parameters

$user_id

$in_time_stamp

$out_time_stamp

$data

$calc_total_time

$coordinate

createQualification()

createQualification($company_id, $type, $qualification_group_id) 

Parameters

$company_id

$type

$qualification_group_id

createQualificationGroup()

createQualificationGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createRecurringSchedule()

createRecurringSchedule($company_id, $template_id, $start_date, $end_date, $user_ids) 

Parameters

$company_id

$template_id

$start_date

$end_date

$user_ids

createRecurringScheduleTemplate()

createRecurringScheduleTemplate($company_id, $type, $schedule_policy_id = NULL

Parameters

$company_id

$type

$schedule_policy_id

createRegularTimePolicy()

createRegularTimePolicy($company_id, $type, $contributing_shift_policy_id = 0, $pay_code_id = 0

Parameters

$company_id

$type

$contributing_shift_policy_id

$pay_code_id

createReportCustomColumn()

createReportCustomColumn($company_id, $report, $type) 

Parameters

$company_id

$report

$type

createRequest()

createRequest($type, $user_id, $date_stamp, $absence_policy_id = 0

Parameters

$type

$user_id

$date_stamp

$absence_policy_id

createRoundingPolicy()

createRoundingPolicy($company_id, $type) 

Parameters

$company_id

$type

createSchedule()

createSchedule($company_id, $user_id, $date_stamp, $data = NULL

Parameters

$company_id

$user_id

$date_stamp

$data

createSchedulePolicy()

createSchedulePolicy($company_id, $meal_policy_id) 

Parameters

$company_id

$meal_policy_id

createShippingPolicy()

createShippingPolicy($company_id, $product_id, $type, $currency_id, $include_area_policy_ids = FALSE, $exclude_area_policy_ids = FALSE

Parameters

$company_id

$product_id

$type

$currency_id

$include_area_policy_ids

$exclude_area_policy_ids

createStation()

createStation($company_id, $source = 'ANY', $station = 'ANY'

Parameters

$company_id

$source

$station

createTask()

createTask($company_id, $type, $group_id, $product_id = NULL

Parameters

$company_id

$type

$group_id

$product_id

createTaskGroup()

createTaskGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createTaxForms()

createTaxForms($company_id, $user_id) 

Parameters

$company_id

$user_id

createTaxPolicy()

createTaxPolicy($company_id, $product_id, $include_area_policy_ids = FALSE, $exclude_area_policy_ids = FALSE

Parameters

$company_id

$product_id

$include_area_policy_ids

$exclude_area_policy_ids

createTimeSheetVerification()

createTimeSheetVerification($user_id, $pay_period_id, $current_user_id) 

Parameters

$user_id

$pay_period_id

$current_user_id

createUser()

createUser($company_id, $type, $policy_group_id = 0, $default_branch_id = 0, $default_department_id = 0, $default_currency_id = 0, $user_group_id = 0, $user_title_id = 0, $ethnic_group_ids = NULL

Parameters

$company_id

$type

$policy_group_id

$default_branch_id

$default_department_id

$default_currency_id

$user_group_id

$user_title_id

$ethnic_group_ids

createUserContact()

createUserContact($user_id) 

Parameters

$user_id

createUserDateTotal()

createUserDateTotal($user_id, $date_stamp, $total_time, $branch_id = 0, $department_id = 0

Parameters

$user_id

$date_stamp

$total_time

$branch_id

$department_id

createUserDeduction()

createUserDeduction($company_id, $user_id) 

Parameters

$company_id

$user_id

createUserDefaults()

createUserDefaults($company_id) 

Parameters

$company_id

createUserEducation()

createUserEducation($user_id, $qualification_id = 0

Parameters

$user_id

$qualification_id

createUserExpense()

createUserExpense($user_id, $expense_policy_id, $default_branch_id = 0, $default_department_id = 0, $default_currency_id = 0, $job_id = 0, $job_item_id = 0, $reimburse = TRUE

Parameters

$user_id

$expense_policy_id

$default_branch_id

$default_department_id

$default_currency_id

$job_id

$job_item_id

$reimburse

createUserGroup()

createUserGroup($company_id, $type, $parent_id = 0

Parameters

$company_id

$type

$parent_id

createUserLanguage()

createUserLanguage($user_id, $type, $qualification_id = 0

Parameters

$user_id

$type

$qualification_id

createUserLicense()

createUserLicense($user_id, $qualification_id = 0

Parameters

$user_id

$qualification_id

createUserMembership()

createUserMembership($user_id, $type, $qualification_id, $default_currency_id) 

Parameters

$user_id

$type

$qualification_id

$default_currency_id

createUserPermission()

createUserPermission($user_id, $preset_id) 

Parameters

$user_id

$preset_id

createUserPreference()

createUserPreference($user_id) 

Parameters

$user_id

createUserReview()

createUserReview($user_review_control_id, $type, $kpi_id) 

Parameters

$user_review_control_id

$type

$kpi_id

createUserReviewControl()

createUserReviewControl($user_id, $reviewer_user_id) 

Parameters

$user_id

$reviewer_user_id

createUserSkill()

createUserSkill($user_id, $type, $qualification_id = 0

Parameters

$user_id

$type

$qualification_id

createUserTitle()

createUserTitle($company_id, $type) 

Parameters

$company_id

$type

createUserWage()

createUserWage($user_id, $rate, $effective_date, $wage_group_id = 0

Parameters

$user_id

$rate

$effective_date

$wage_group_id

createUserWageGroups()

createUserWageGroups($company_id) 

Parameters

$company_id

deleteAbsence()

deleteAbsence($id) 

Parameters

$id

deletePunch()

deletePunch($id) 

Parameters

$id

deleteSchedule()

deleteSchedule($id) 

Parameters

$id

editPunch()

editPunch($id, $data = NULL

Parameters

$id

$data

editSchedule()

editSchedule($id, $data = NULL

Parameters

$id

$data

generateData()

generateData() 

getAdminUserNamePrefix()

getAdminUserNamePrefix() 

getEnableQuickPunch()

getEnableQuickPunch() 

getMaxRandomUsers()

getMaxRandomUsers() 

getPassword()

getPassword() 

getRandomArrayValue()

getRandomArrayValue($arr) 

Parameters

$arr

getRandomCoordinates()

getRandomCoordinates($type = 'longitude'

Parameters

$type

getRandomFirstName()

getRandomFirstName() 

getRandomLastName()

getRandomLastName() 

getUserNamePostfix()

getUserNamePostfix() 

getUserNamePrefix()

getUserNamePrefix() 

setAdminUserNamePrefix()

setAdminUserNamePrefix($val) 

Parameters

$val

setEnableQuickPunch()

setEnableQuickPunch($val) 

Parameters

$val

setMaxRandomUsers()

setMaxRandomUsers($val) 

Parameters

$val

setPassword()

setPassword($val) 

Parameters

$val

setUserNamePostfix()

setUserNamePostfix($val) 

Parameters

$val

setUserNamePrefix()

setUserNamePrefix($val) 

Parameters

$val

 Properties

 

$admin_user_name_prefix

$admin_user_name_prefix 

Default

'demoadmin'
 

$city_names

$city_names 

Default

array('Richmond', 'Southampton', 'Stratford', 'Wellington', 'Jasper', 'Flatrock', 'Carleton', 'Belmont', 'Armstrong')
 

$coordinates

$coordinates 

Default

array(array(40.7331043902, -74.01754796505), array(40.7314133588, -73.970341086388), array(40.727014849905, -74.017800092697), array(40.704895945126, -73.981407880783), array(40.722071261881, -74.012993574142), array(40.718688595346, -73.935745954514), array(40.763478722865, -73.93007040023799), array(40.656778234208, -73.972642421722), array(40.723112047769, -74.028443098068), array(40.693963891348, -74.057968854904), array(47.773829, -122.38306), array(47.473010966814, -122.51257896423), array(47.785653130062, -122.12741374969), array(47.708086640739, -121.9173002243), array(47.759983573294, -122.75153160095), array(47.765522347356, -121.58972740173), array(47.721397737032, -122.30561971664), array(47.578552237571, -122.27298259735), array(47.503460631986, -122.25512981415), array(47.755367, -122.715569), array(47.337310405077, -122.8613948822), array(47.783635, -122.652912), array(34.256081384717, -100.73295593262), array(34.037866684604, -90.603561401367), array(31.825065081209, -92.471237182617), array(30.679258712559, -95.679244995117), array(29.634352258877, -101.50199890137), array(30.186683090608, -104.55619812012), array(30.754818309502, -107.96195983887), array(32.938386363885, -108.75297546387), array(34.019656697326, -107.30278015137), array(34.509951580711, -105.25932312012), array(33.141000944017, -104.00688171387), array(31.338389926759, -104.09477233887), array(31.30084828737, -99.436569213867), array(33.067376841084, -100.22758483887), array(33.910314751383, -103.76518249512))
 

$enable_quick_punch

$enable_quick_punch 

Default

TRUE
 

$first_names

$first_names 

Default

array('Sidney', 'Vi', 'Lena', 'Carlee', 'Mohammad', 'Pat', 'Lashell', 'Denis', 'Jeffry', 'Cleo', 'Nikia', 'Vallie', 'Shari', 'Daniel', 'Laurena', 'Elbert', 'Cortney', 'Ferne', 'Willetta', 'Mitzi', 'Stacey', 'Mireya', 'Reita', 'Rivka', 'Tu', 'Hiram', 'Giuseppina', 'Reda', 'Dion', 'Izola', 'Bobbye', 'Chanelle', 'Clemmie', 'Karri', 'Kylee', 'Gillian', 'Octavia', 'Marielle', 'Romelia', 'Stephania', 'Sherryl', 'Malka', 'Kristan', 'Jolynn', 'Star', 'Cinthia', 'Vern', 'Junko', 'Felipa', 'Alayna', 'Lorenzo', 'Agnus', 'Hyman', 'Floretta', 'Rosella', 'Sabina', 'Regan', 'Yu', 'Muoi', 'Tomiko', 'Ada', 'Lyla', 'Madelene', 'Rosaura', 'Berenice', 'Georgine', 'Vada', 'Ray', 'Martin', 'Kathryn', 'Dolly', 'Clayton', 'Arica', 'Britany', 'Rolland', 'Mellissa', 'Kymberly', 'Claude', 'Doyle', 'Hector', 'Arlen', 'Debra', 'Tami', 'Catharine', 'Su', 'Danica', 'Shandra', 'Latrina', 'Orval', 'Clifton', 'Jena', 'Oliver', 'Haydee', 'Julie', 'Xochitl', 'Adrian', 'Winfred', 'Eldora', 'Sook', 'Antonette')
 

$institute

$institute 

Default

array('Harvard University', 'Princeton University', 'Yale University', 'University of Pennsylvania', 'Duke University', 'Stanford University', 'California Institute of Technology', 'Massachusetts Inst. of Technology', 'Columbia University', 'Dartmouth College')
 

$last_names

$last_names 

Default

array('Lecompte', 'Jepko', 'Godzik', 'Bereda', 'Lamers', 'Errett', 'Farm', 'Adamski', 'Fadri', 'Gerhart', 'Lubic', 'Jost', 'Manginelli', 'Farris', 'Otiz', 'Huso', 'Hutchens', 'Mani', 'Galland', 'Laforest', 'Labatt', 'Burr', 'Clemmens', 'Gode', 'Kapsner', 'Harben', 'Aumend', 'Lauck', 'Lassere', 'Center', 'Barlow', 'Hudgens', 'Fimbres', 'Northcut', 'Newstrom', 'Floerchinger', 'Goetting', 'Binienda', 'Dardagnac', 'Graper', 'Cadarette', 'Castaneda', 'Grosvenor', 'Mccurren', 'Feuerstein', 'Parizek', 'Haner', 'Beyer', 'Lollis', 'Osten', 'Baginski', 'Fusca', 'Hardiman', 'Rechkemmer', 'Ellerbrock', 'Macvicar', 'Golberg', 'Benassi', 'Hirons', 'Lineberry', 'Flamino', 'Pickard', 'Grohmann', 'Parkers', 'Hebrard', 'Glade', 'Haughney', 'Levering', 'Kudo', 'Hoffschneider', 'Mussa', 'Fitzloff', 'Matelic', 'Maillard', 'Carswell', 'Becera', 'Gonsior', 'Qureshi', 'Armel', 'Broadnay', 'Boulch', 'Flamio', 'Heaston', 'Kristen', 'Chambless', 'Lamarch', 'Jedan', 'Fijal', 'Jesmer', 'Capraro', 'Hemrich', 'Prudente', 'Cochren', 'Karroach', 'Guillotte', 'Musinski', 'Eflin', 'Palumbo', 'Legendre', 'Afton')
 

$major

$major 

Default

array('Biological Engineering', 'Public Management', 'Vehicle Engineering', 'Industrial Design', 'Civil Engineering', 'Communication Engineering', 'Finance', 'Financial Management')
 

$max_random_users

$max_random_users 

Default

0
 

$minor

$minor 

Default

array('Physical Education Section', 'Arts and Design Department/Section', 'Social Science Department/Section', 'Foreign language and literature department', 'Economics', 'Automation', 'Business Administration')
 

$password

$password 

Default

'demo'
 

$user_name_postfix

$user_name_postfix 

Default

'1'
 

$user_name_prefix

$user_name_prefix 

Default

'demo'